<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Frameset//EN""http://www.w3.org/TR/REC-html40/frameset.dtd"> <!--NewPage--> <HTML> <HEAD> <!-- Generated by javadoc on Mon Aug 05 13:17:01 EDT 2002 --> <TITLE> Perforce API: Class Client </TITLE> <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../stylesheet.css" TITLE="Style"> </HEAD> <BODY BGCOLOR="white"> <!-- ========== START OF NAVBAR ========== --> <A NAME="navbar_top"><!-- --></A> <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0"> <TR> <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A NAME="navbar_top_firstrow"><!-- --></A> <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3"> <TR ALIGN="center" VALIGN="top"> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/Client.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> </TR> </TABLE> </TD> <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> <a target="_top" href="http://www.perforce.com/"><img alt="Perforce" border="0" height="44" width="151" src="doc-files/perforce_logo.gif"></a></EM> </TD> </TR> <TR> <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> <A HREF="../../../com/perforce/api/Change.html"><B>PREV CLASS</B></A> <A HREF="../../../com/perforce/api/Counter.html"><B>NEXT CLASS</B></A></FONT></TD> <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> <A HREF="../../../index.html" TARGET="_top"><B>FRAMES</B></A> <A HREF="Client.html" TARGET="_top"><B>NO FRAMES</B></A></FONT></TD> </TR> <TR> <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> SUMMARY: INNER | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD> </TR> </TABLE> <!-- =========== END OF NAVBAR =========== --> <HR> <!-- ======== START OF CLASS DATA ======== --> <H2> <FONT SIZE="-1"> com.perforce.api</FONT> <BR> Class Client</H2> <PRE> <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/Object.html">java.lang.Object</A> | +--<A HREF="../../../com/perforce/api/SourceControlObject.html">com.perforce.api.SourceControlObject</A> | +--<A HREF="../../../com/perforce/api/Mapping.html">com.perforce.api.Mapping</A> | +--<B>com.perforce.api.Client</B> </PRE> <DL> <DT><B>All Implemented Interfaces:</B> <DD><A HREF="../../../com/perforce/api/Cacheable.html">Cacheable</A>, <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/Comparable.html">Comparable</A></DD> </DL> <HR> <DL> <DT>public final class <B>Client</B><DT>extends <A HREF="../../../com/perforce/api/Mapping.html">Mapping</A></DL> <P> Representation of a source control client. This class can be used to retrieve and hold p4 client information. It's class methods can be used to list <a href="#getClients()">all loaded clients</a> or list those <a href="#lookupClient(java.lang.String)">beginning with a particular prefix</a>. Before these class methods are called, the class method <a href="#loadClients()">loadClients()</a> must be called to ensure the client list is up to date. <P> <DL> <DT><B>Version: </B><DD>$Date: 2003/09/05 $ $Revision: #1 $</DD> <DT><B>Author: </B><DD><a href="mailto:david@markley.cc">David Markley</a></DD> </DL> <HR> <P> <!-- ======== INNER CLASS SUMMARY ======== --> <!-- =========== FIELD SUMMARY =========== --> <!-- ======== CONSTRUCTOR SUMMARY ======== --> <A NAME="constructor_summary"><!-- --></A> <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%"> <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> <TD COLSPAN=2><FONT SIZE="+2"> <B>Constructor Summary</B></FONT></TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD><CODE><B><A HREF="../../../com/perforce/api/Client.html#Client()">Client</A></B>()</CODE> <BR> Default no-argument constructor.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD><CODE><B><A HREF="../../../com/perforce/api/Client.html#Client(com.perforce.api.Env, java.lang.String)">Client</A></B>(<A HREF="../../../com/perforce/api/Env.html">Env</A> env, <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A> name)</CODE> <BR> Constructor that is passed the client name.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD><CODE><B><A HREF="../../../com/perforce/api/Client.html#Client(java.lang.String)">Client</A></B>(<A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A> name)</CODE> <BR> Constructor that is passed the client name.</TD> </TR> </TABLE> <!-- ========== METHOD SUMMARY =========== --> <A NAME="method_summary"><!-- --></A> <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%"> <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> <TD COLSPAN=2><FONT SIZE="+2"> <B>Method Summary</B></FONT></TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> void</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../com/perforce/api/Client.html#commit()">commit</A></B>()</CODE> <BR> Stores this object back into Perforce, creating it if it didn't already exist.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> <A HREF="../../../com/perforce/api/HashDecay.html">HashDecay</A></CODE></FONT></TD> <TD><CODE><B><A HREF="../../../com/perforce/api/Client.html#getCache()">getCache</A></B>()</CODE> <BR> Returns the HashDecay instance for this class</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE>static <A HREF="../../../com/perforce/api/Client.html">Client</A></CODE></FONT></TD> <TD><CODE><B><A HREF="../../../com/perforce/api/Client.html#getClient(com.perforce.api.Env, java.lang.String)">getClient</A></B>(<A HREF="../../../com/perforce/api/Env.html">Env</A> env, <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A> name)</CODE> <BR> Returns a Client with the specified name, or null if not found.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE>static <A HREF="../../../com/perforce/api/Client.html">Client</A></CODE></FONT></TD> <TD><CODE><B><A HREF="../../../com/perforce/api/Client.html#getClient(java.lang.String)">getClient</A></B>(<A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A> name)</CODE> <BR> Returns a Client with the specified name, or null if not found.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE>static <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/util/Iterator.html">Iterator</A></CODE></FONT></TD> <TD><CODE><B><A HREF="../../../com/perforce/api/Client.html#getClientIterator(com.perforce.api.Env)">getClientIterator</A></B>(<A HREF="../../../com/perforce/api/Env.html">Env</A> env)</CODE> <BR> </TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE>static <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/util/Enumeration.html">Enumeration</A></CODE></FONT></TD> <TD><CODE><B><A HREF="../../../com/perforce/api/Client.html#getClients(com.perforce.api.Env)">getClients</A></B>(<A HREF="../../../com/perforce/api/Env.html">Env</A> env)</CODE> <BR> </TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A></CODE></FONT></TD> <TD><CODE><B><A HREF="../../../com/perforce/api/Client.html#getOptions()">getOptions</A></B>()</CODE> <BR> Returns the Client options.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A></CODE></FONT></TD> <TD><CODE><B><A HREF="../../../com/perforce/api/Client.html#getRoot()">getRoot</A></B>()</CODE> <BR> Returns the Client root.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE>static void</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../com/perforce/api/Client.html#loadClients()">loadClients</A></B>()</CODE> <BR> Loads a list of all the clients into an internal class Hashtable.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE>static void</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../com/perforce/api/Client.html#loadClients(com.perforce.api.Env)">loadClients</A></B>(<A HREF="../../../com/perforce/api/Env.html">Env</A> env)</CODE> <BR> Loads a list of all the clients into an internal class Hashtable.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE>static <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/util/Enumeration.html">Enumeration</A></CODE></FONT></TD> <TD><CODE><B><A HREF="../../../com/perforce/api/Client.html#lookupClient(com.perforce.api.Env, java.lang.String)">lookupClient</A></B>(<A HREF="../../../com/perforce/api/Env.html">Env</A> env, <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A> prefix)</CODE> <BR> Returns a list of clients that begin with the specified prefix.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE>static <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/util/Enumeration.html">Enumeration</A></CODE></FONT></TD> <TD><CODE><B><A HREF="../../../com/perforce/api/Client.html#lookupClient(java.lang.String)">lookupClient</A></B>(<A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A> prefix)</CODE> <BR> Returns a list of clients that begin with the specified prefix.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> void</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../com/perforce/api/Client.html#setOptions(java.lang.String)">setOptions</A></B>(<A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A> options)</CODE> <BR> Sets the options for the Client.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> void</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../com/perforce/api/Client.html#setRoot(java.lang.String)">setRoot</A></B>(<A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A> root)</CODE> <BR> Sets the root for the Client.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> void</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../com/perforce/api/Client.html#sync()">sync</A></B>()</CODE> <BR> Brings this object back into sync with Perforce.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> void</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../com/perforce/api/Client.html#sync(java.lang.String)">sync</A></B>(<A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A> name)</CODE> <BR> Synchronizes the Client with the latest information from P4.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A></CODE></FONT></TD> <TD><CODE><B><A HREF="../../../com/perforce/api/Client.html#toXML()">toXML</A></B>()</CODE> <BR> Returns a string containing the object in XML form.</TD> </TR> </TABLE> <A NAME="methods_inherited_from_class_com.perforce.api.Mapping"><!-- --></A> <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%"> <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> <TD><B>Methods inherited from class com.perforce.api.<A HREF="../../../com/perforce/api/Mapping.html">Mapping</A></B></TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD><CODE><A HREF="../../../com/perforce/api/Mapping.html#addView(java.lang.String)">addView</A>, <A HREF="../../../com/perforce/api/Mapping.html#addView(java.lang.String, java.lang.String)">addView</A>, <A HREF="../../../com/perforce/api/Mapping.html#compareTo(java.lang.Object)">compareTo</A>, <A HREF="../../../com/perforce/api/Mapping.html#getDescription()">getDescription</A>, <A HREF="../../../com/perforce/api/Mapping.html#getName()">getName</A>, <A HREF="../../../com/perforce/api/Mapping.html#getOwner()">getOwner</A>, <A HREF="../../../com/perforce/api/Mapping.html#getView()">getView</A>, <A HREF="../../../com/perforce/api/Mapping.html#getViews()">getViews</A>, <A HREF="../../../com/perforce/api/Mapping.html#lookupMappings(com.perforce.api.HashDecay, java.lang.String)">lookupMappings</A>, <A HREF="../../../com/perforce/api/Mapping.html#setDescription(java.lang.String)">setDescription</A>, <A HREF="../../../com/perforce/api/Mapping.html#setName(java.lang.String)">setName</A>, <A HREF="../../../com/perforce/api/Mapping.html#setOwner(java.lang.String)">setOwner</A>, <A HREF="../../../com/perforce/api/Mapping.html#toString()">toString</A></CODE></TD> </TR> </TABLE> <A NAME="methods_inherited_from_class_com.perforce.api.SourceControlObject"><!-- --></A> <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%"> <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> <TD><B>Methods inherited from class com.perforce.api.<A HREF="../../../com/perforce/api/SourceControlObject.html">SourceControlObject</A></B></TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD><CODE><A HREF="../../../com/perforce/api/SourceControlObject.html#clearCache()">clearCache</A>, <A HREF="../../../com/perforce/api/SourceControlObject.html#getEnv()">getEnv</A>, <A HREF="../../../com/perforce/api/SourceControlObject.html#getSyncTime()">getSyncTime</A>, <A HREF="../../../com/perforce/api/SourceControlObject.html#getUpdateTime()">getUpdateTime</A>, <A HREF="../../../com/perforce/api/SourceControlObject.html#inSync()">inSync</A>, <A HREF="../../../com/perforce/api/SourceControlObject.html#invalidate()">invalidate</A>, <A HREF="../../../com/perforce/api/SourceControlObject.html#outOfSync(long)">outOfSync</A>, <A HREF="../../../com/perforce/api/SourceControlObject.html#refreshUpdateTime()">refreshUpdateTime</A>, <A HREF="../../../com/perforce/api/SourceControlObject.html#setEnv(com.perforce.api.Env)">setEnv</A></CODE></TD> </TR> </TABLE> <A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A> <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%"> <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> <TD><B>Methods inherited from class java.lang.<A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/Object.html">Object</A></B></TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD><CODE><A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/Object.html#clone()">clone</A>, <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/Object.html#equals(java.lang.Object)">equals</A>, <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/Object.html#finalize()">finalize</A>, <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/Object.html#getClass()">getClass</A>, <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/Object.html#hashCode()">hashCode</A>, <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/Object.html#notify()">notify</A>, <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/Object.html#notifyAll()">notifyAll</A>, <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/Object.html#wait()">wait</A>, <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/Object.html#wait(long)">wait</A>, <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/Object.html#wait(long, int)">wait</A></CODE></TD> </TR> </TABLE> <P> <!-- ============ FIELD DETAIL =========== --> <!-- ========= CONSTRUCTOR DETAIL ======== --> <A NAME="constructor_detail"><!-- --></A> <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%"> <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> <TD COLSPAN=1><FONT SIZE="+2"> <B>Constructor Detail</B></FONT></TD> </TR> </TABLE> <A NAME="Client()"><!-- --></A><H3> Client</H3> <PRE> public <B>Client</B>()</PRE> <DL> <DD>Default no-argument constructor.</DL> <HR> <A NAME="Client(com.perforce.api.Env, java.lang.String)"><!-- --></A><H3> Client</H3> <PRE> public <B>Client</B>(<A HREF="../../../com/perforce/api/Env.html">Env</A> env, <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A> name)</PRE> <DL> <DD>Constructor that is passed the client name.</DL> <HR> <A NAME="Client(java.lang.String)"><!-- --></A><H3> Client</H3> <PRE> public <B>Client</B>(<A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A> name)</PRE> <DL> <DD>Constructor that is passed the client name.</DL> <!-- ============ METHOD DETAIL ========== --> <A NAME="method_detail"><!-- --></A> <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%"> <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> <TD COLSPAN=1><FONT SIZE="+2"> <B>Method Detail</B></FONT></TD> </TR> </TABLE> <A NAME="commit()"><!-- --></A><H3> commit</H3> <PRE> public void <B>commit</B>() throws <A HREF="../../../com/perforce/api/CommitException.html">CommitException</A></PRE> <DL> <DD><B>Description copied from class: <CODE><A HREF="../../../com/perforce/api/SourceControlObject.html">SourceControlObject</A></CODE></B></DD> <DD>Stores this object back into Perforce, creating it if it didn't already exist.<DD><DL> <DT><B>Overrides:</B><DD><CODE><A HREF="../../../com/perforce/api/Mapping.html#commit()">commit</A></CODE> in class <CODE><A HREF="../../../com/perforce/api/Mapping.html">Mapping</A></CODE></DL> </DD> </DL> <HR> <A NAME="getCache()"><!-- --></A><H3> getCache</H3> <PRE> public <A HREF="../../../com/perforce/api/HashDecay.html">HashDecay</A> <B>getCache</B>()</PRE> <DL> <DD><B>Description copied from class: <CODE><A HREF="../../../com/perforce/api/SourceControlObject.html">SourceControlObject</A></CODE></B></DD> <DD>Returns the HashDecay instance for this class<DD><DL> <DT><B>Overrides:</B><DD><CODE><A HREF="../../../com/perforce/api/SourceControlObject.html#getCache()">getCache</A></CODE> in class <CODE><A HREF="../../../com/perforce/api/SourceControlObject.html">SourceControlObject</A></CODE></DL> </DD> </DL> <HR> <A NAME="getClient(com.perforce.api.Env, java.lang.String)"><!-- --></A><H3> getClient</H3> <PRE> public static <A HREF="../../../com/perforce/api/Client.html">Client</A> <B>getClient</B>(<A HREF="../../../com/perforce/api/Env.html">Env</A> env, <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A> name)</PRE> <DL> <DD>Returns a Client with the specified name, or null if not found. It is important to keep in mind that the Client returned may not hold valid information, other than its name. To ensure the Client has valid information, the sync() method must be called.<DD><DL> <DT><B>Parameters:</B><DD><CODE>name</CODE> - Name of the client to find.</DL> </DD> </DL> <HR> <A NAME="getClient(java.lang.String)"><!-- --></A><H3> getClient</H3> <PRE> public static <A HREF="../../../com/perforce/api/Client.html">Client</A> <B>getClient</B>(<A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A> name)</PRE> <DL> <DD>Returns a Client with the specified name, or null if not found.<DD><DL> <DT><B>See Also: </B><DD><A HREF="../../../com/perforce/api/Client.html#getClient(com.perforce.api.Env, java.lang.String)"><CODE>getClient(Env, String)</CODE></A></DL> </DD> </DL> <HR> <A NAME="getClientIterator(com.perforce.api.Env)"><!-- --></A><H3> getClientIterator</H3> <PRE> public static <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/util/Iterator.html">Iterator</A> <B>getClientIterator</B>(<A HREF="../../../com/perforce/api/Env.html">Env</A> env)</PRE> <DL> <DD><DL> <DT><B>Parameters:</B><DD><CODE>env</CODE> - Environment to use when working with P4<DT><B>Returns:</B><DD>Iterator for all clients currently loaded.</DL> </DD> </DL> <HR> <A NAME="getClients(com.perforce.api.Env)"><!-- --></A><H3> getClients</H3> <PRE> public static <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/util/Enumeration.html">Enumeration</A> <B>getClients</B>(<A HREF="../../../com/perforce/api/Env.html">Env</A> env)</PRE> <DL> <DD><DL> <DT><B>Parameters:</B><DD><CODE>env</CODE> - Environment to use when working with P4<DT><B>Returns:</B><DD>Enumeration of all clients currently loaded.</DL> </DD> </DL> <HR> <A NAME="getOptions()"><!-- --></A><H3> getOptions</H3> <PRE> public <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A> <B>getOptions</B>()</PRE> <DL> <DD>Returns the Client options.</DL> <HR> <A NAME="getRoot()"><!-- --></A><H3> getRoot</H3> <PRE> public <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A> <B>getRoot</B>()</PRE> <DL> <DD>Returns the Client root.</DL> <HR> <A NAME="loadClients()"><!-- --></A><H3> loadClients</H3> <PRE> public static void <B>loadClients</B>()</PRE> <DL> <DD>Loads a list of all the clients into an internal class Hashtable. This method will only be called by the class itself if the Hashtable is empty. Users should call this method if they believe the p4 client information needs to be brought up to date.<DD><DL> <DT><B>See Also: </B><DD><A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/util/Hashtable.html"><CODE>Hashtable</CODE></A></DL> </DD> </DL> <HR> <A NAME="loadClients(com.perforce.api.Env)"><!-- --></A><H3> loadClients</H3> <PRE> public static void <B>loadClients</B>(<A HREF="../../../com/perforce/api/Env.html">Env</A> env)</PRE> <DL> <DD>Loads a list of all the clients into an internal class Hashtable.<DD><DL> <DT><B>Parameters:</B><DD><CODE>env</CODE> - Source conrol environment to use.<DT><B>See Also: </B><DD><A HREF="../../../com/perforce/api/Client.html#loadClients()"><CODE>loadClients()</CODE></A></DL> </DD> </DL> <HR> <A NAME="lookupClient(com.perforce.api.Env, java.lang.String)"><!-- --></A><H3> lookupClient</H3> <PRE> public static <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/util/Enumeration.html">Enumeration</A> <B>lookupClient</B>(<A HREF="../../../com/perforce/api/Env.html">Env</A> env, <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A> prefix)</PRE> <DL> <DD>Returns a list of clients that begin with the specified prefix.<DD><DL> <DT><B>Parameters:</B><DD><CODE>env</CODE> - P4 environment to use.<DD><CODE>prefix</CODE> - Prefix for all clients to be returned.<DT><B>Returns:</B><DD>List of clients matching the prefix.</DL> </DD> </DL> <HR> <A NAME="lookupClient(java.lang.String)"><!-- --></A><H3> lookupClient</H3> <PRE> public static <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/util/Enumeration.html">Enumeration</A> <B>lookupClient</B>(<A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A> prefix)</PRE> <DL> <DD>Returns a list of clients that begin with the specified prefix.<DD><DL> <DT><B>Parameters:</B><DD><CODE>prefix</CODE> - Prefix for all clients to be returned<DT><B>Returns:</B><DD>List of clients matching the prefix.</DL> </DD> </DL> <HR> <A NAME="setOptions(java.lang.String)"><!-- --></A><H3> setOptions</H3> <PRE> public void <B>setOptions</B>(<A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A> options)</PRE> <DL> <DD>Sets the options for the Client.<DD><DL> <DT><B>Parameters:</B><DD><CODE>options</CODE> - Options of the client.</DL> </DD> </DL> <HR> <A NAME="setRoot(java.lang.String)"><!-- --></A><H3> setRoot</H3> <PRE> public void <B>setRoot</B>(<A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A> root)</PRE> <DL> <DD>Sets the root for the Client.<DD><DL> <DT><B>Parameters:</B><DD><CODE>root</CODE> - Root of the client.</DL> </DD> </DL> <HR> <A NAME="sync()"><!-- --></A><H3> sync</H3> <PRE> public void <B>sync</B>()</PRE> <DL> <DD><B>Description copied from class: <CODE><A HREF="../../../com/perforce/api/SourceControlObject.html">SourceControlObject</A></CODE></B></DD> <DD>Brings this object back into sync with Perforce. This also sets the sets the update and sync time for this object.<DD><DL> <DT><B>Overrides:</B><DD><CODE><A HREF="../../../com/perforce/api/SourceControlObject.html#sync()">sync</A></CODE> in class <CODE><A HREF="../../../com/perforce/api/SourceControlObject.html">SourceControlObject</A></CODE></DL> </DD> </DL> <HR> <A NAME="sync(java.lang.String)"><!-- --></A><H3> sync</H3> <PRE> public void <B>sync</B>(<A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A> name)</PRE> <DL> <DD>Synchronizes the Client with the latest information from P4. This method forces the Client to contain the latest, correct information if it didn't already.<DD><DL> <DT><B>Overrides:</B><DD><CODE><A HREF="../../../com/perforce/api/Mapping.html#sync(java.lang.String)">sync</A></CODE> in class <CODE><A HREF="../../../com/perforce/api/Mapping.html">Mapping</A></CODE></DL> </DD> <DD><DL> <DT><B>Parameters:</B><DD><CODE>name</CODE> - Name of the Client to synchronize.</DL> </DD> </DL> <HR> <A NAME="toXML()"><!-- --></A><H3> toXML</H3> <PRE> public <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A> <B>toXML</B>()</PRE> <DL> <DD><B>Description copied from class: <CODE><A HREF="../../../com/perforce/api/SourceControlObject.html">SourceControlObject</A></CODE></B></DD> <DD>Returns a string containing the object in XML form.<DD><DL> <DT><B>Overrides:</B><DD><CODE><A HREF="../../../com/perforce/api/Mapping.html#toXML()">toXML</A></CODE> in class <CODE><A HREF="../../../com/perforce/api/Mapping.html">Mapping</A></CODE></DL> </DD> </DL> <!-- ========= END OF CLASS DATA ========= --> <HR> <!-- ========== START OF NAVBAR ========== --> <A NAME="navbar_bottom"><!-- --></A> <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0"> <TR> <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A NAME="navbar_bottom_firstrow"><!-- --></A> <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3"> <TR ALIGN="center" VALIGN="top"> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/Client.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> </TR> </TABLE> </TD> <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> <a target="_top" href="http://www.perforce.com/"><img alt="Perforce" border="0" height="44" width="151" src="doc-files/perforce_logo.gif"></a></EM> </TD> </TR> <TR> <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> <A HREF="../../../com/perforce/api/Change.html"><B>PREV CLASS</B></A> <A HREF="../../../com/perforce/api/Counter.html"><B>NEXT CLASS</B></A></FONT></TD> <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> <A HREF="../../../index.html" TARGET="_top"><B>FRAMES</B></A> <A HREF="Client.html" TARGET="_top"><B>NO FRAMES</B></A></FONT></TD> </TR> <TR> <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> SUMMARY: INNER | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD> </TR> </TABLE> <!-- =========== END OF NAVBAR =========== --> <HR> <i><a href="doc-files/LICENSE.TXT">Copyright</a> © 2001, Perforce Software, All rights reserved.</i> </BODY> </HTML>
# | Change | User | Description | Committed | |
---|---|---|---|---|---|
#1 | 3616 | Nicholas Veeser | Branched in the p4package code because I wanted to make some additions and possibly some modifications to the object model. | ||
//public/perforce/api/java/p4package/docs/com/perforce/api/Client.html | |||||
#6 | 2002 | David Markley | Integrated the latest changes for p4package to the public depot. | ||
#5 | 1808 | David Markley |
Updated Env class and fixed fstat issues. Published new Javadocs. |
||
#4 | 1361 | David Markley | Added convenience methods to the Env class. | ||
#3 | 1334 | David Markley |
Added more example code. Added the Counter class. Corrected the filelog methods for the FileEntry class. |
||
#2 | 1149 | David Markley | Added more documentation, a few examples, a cleanUp method, and a server timeout threshold. | ||
#1 | 1043 | David Markley | Initial branch to public area. | ||
//guest/david_markley/p4package/docs/com/perforce/api/Client.html | |||||
#3 | 1037 | David Markley | Updated the documentation. | ||
#2 | 1021 | David Markley |
Corrected spelling of deprecated in the source. Added <pre> tag around license information. |
||
#1 | 1020 | David Markley |
Added Perforce Java API documentation. This is generated using JavaDoc. |