Helix SwarmHelix Swarm

Client.html

  • //
  • guest/
  • david_markley/
  • p4package/
  • docs/
  • com/
  • perforce/
  • api/
  • Client.html #8
  • View
  • Commits
  • Open Download .zip Download (30 KB) 
  1. <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Frameset//EN""http://www.w3.org/TR/REC-html40/frameset.dtd">
  2. <!--NewPage-->
  3. <HTML>
  4. <HEAD>
  5. <!-- Generated by javadoc on Mon Aug 05 13:17:01 EDT 2002 -->
  6. <TITLE>
  7. Perforce API: Class  Client
  8. </TITLE>
  9. <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../stylesheet.css" TITLE="Style">
  10. </HEAD>
  11. <BODY BGCOLOR="white">
  12.  
  13. <!-- ========== START OF NAVBAR ========== -->
  14. <A NAME="navbar_top"><!-- --></A>
  15. <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0">
  16. <TR>
  17. <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
  18. <A NAME="navbar_top_firstrow"><!-- --></A>
  19. <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3">
  20.   <TR ALIGN="center" VALIGN="top">
  21.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
  22.   <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
  23.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/Client.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
  24.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
  25.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
  26.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
  27.   </TR>
  28. </TABLE>
  29. </TD>
  30. <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
  31. <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>
  32. </TD>
  33. </TR>
  34.  
  35. <TR>
  36. <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  37. &nbsp;<A HREF="../../../com/perforce/api/Change.html"><B>PREV CLASS</B></A>&nbsp;
  38. &nbsp;<A HREF="../../../com/perforce/api/Counter.html"><B>NEXT CLASS</B></A></FONT></TD>
  39. <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  40.   <A HREF="../../../index.html" TARGET="_top"><B>FRAMES</B></A>  &nbsp;
  41. &nbsp;<A HREF="Client.html" TARGET="_top"><B>NO FRAMES</B></A></FONT></TD>
  42. </TR>
  43. <TR>
  44. <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
  45.   SUMMARY: &nbsp;INNER&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
  46. <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
  47. DETAIL: &nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
  48. </TR>
  49. </TABLE>
  50. <!-- =========== END OF NAVBAR =========== -->
  51.  
  52. <HR>
  53. <!-- ======== START OF CLASS DATA ======== -->
  54. <H2>
  55. <FONT SIZE="-1">
  56. com.perforce.api</FONT>
  57. <BR>
  58. Class  Client</H2>
  59. <PRE>
  60. <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/Object.html">java.lang.Object</A>
  61.   |
  62.   +--<A HREF="../../../com/perforce/api/SourceControlObject.html">com.perforce.api.SourceControlObject</A>
  63.         |
  64.         +--<A HREF="../../../com/perforce/api/Mapping.html">com.perforce.api.Mapping</A>
  65.               |
  66.               +--<B>com.perforce.api.Client</B>
  67. </PRE>
  68. <DL>
  69. <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>
  70. </DL>
  71. <HR>
  72. <DL>
  73. <DT>public final class <B>Client</B><DT>extends <A HREF="../../../com/perforce/api/Mapping.html">Mapping</A></DL>
  74.  
  75. <P>
  76. Representation of a source control client. This class can be used to retrieve
  77.  and hold p4 client information. It's class methods can be used to list
  78.  <a href="#getClients()">all loaded clients</a> or list those
  79.  <a href="#lookupClient(java.lang.String)">beginning with a particular 
  80.  prefix</a>. Before these class methods are called, the class method 
  81.  <a href="#loadClients()">loadClients()</a>
  82.  must be called to ensure the client list is up to date.
  83. <P>
  84. <DL>
  85. <DT><B>Version: </B><DD>$Date: 2002/08/05 $ $Revision: #8 $</DD>
  86. <DT><B>Author: </B><DD><a href="mailto:david@markley.cc">David Markley</a></DD>
  87. </DL>
  88. <HR>
  89.  
  90. <P>
  91. <!-- ======== INNER CLASS SUMMARY ======== -->
  92.  
  93.  
  94. <!-- =========== FIELD SUMMARY =========== -->
  95.  
  96.  
  97. <!-- ======== CONSTRUCTOR SUMMARY ======== -->
  98.  
  99. <A NAME="constructor_summary"><!-- --></A>
  100. <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
  101. <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
  102. <TD COLSPAN=2><FONT SIZE="+2">
  103. <B>Constructor Summary</B></FONT></TD>
  104. </TR>
  105. <TR BGCOLOR="white" CLASS="TableRowColor">
  106. <TD><CODE><B><A HREF="../../../com/perforce/api/Client.html#Client()">Client</A></B>()</CODE>
  107.  
  108. <BR>
  109. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Default no-argument constructor.</TD>
  110. </TR>
  111. <TR BGCOLOR="white" CLASS="TableRowColor">
  112. <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>&nbsp;env,
  113.        <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A>&nbsp;name)</CODE>
  114.  
  115. <BR>
  116. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Constructor that is passed the client name.</TD>
  117. </TR>
  118. <TR BGCOLOR="white" CLASS="TableRowColor">
  119. <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>&nbsp;name)</CODE>
  120.  
  121. <BR>
  122. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Constructor that is passed the client name.</TD>
  123. </TR>
  124. </TABLE>
  125. &nbsp;
  126. <!-- ========== METHOD SUMMARY =========== -->
  127.  
  128. <A NAME="method_summary"><!-- --></A>
  129. <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
  130. <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
  131. <TD COLSPAN=2><FONT SIZE="+2">
  132. <B>Method Summary</B></FONT></TD>
  133. </TR>
  134. <TR BGCOLOR="white" CLASS="TableRowColor">
  135. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  136. <CODE>&nbsp;void</CODE></FONT></TD>
  137. <TD><CODE><B><A HREF="../../../com/perforce/api/Client.html#commit()">commit</A></B>()</CODE>
  138.  
  139. <BR>
  140. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Stores this object back into Perforce, creating it if it
  141.  didn't already exist.</TD>
  142. </TR>
  143. <TR BGCOLOR="white" CLASS="TableRowColor">
  144. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  145. <CODE>&nbsp;<A HREF="../../../com/perforce/api/HashDecay.html">HashDecay</A></CODE></FONT></TD>
  146. <TD><CODE><B><A HREF="../../../com/perforce/api/Client.html#getCache()">getCache</A></B>()</CODE>
  147.  
  148. <BR>
  149. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the HashDecay instance for this class</TD>
  150. </TR>
  151. <TR BGCOLOR="white" CLASS="TableRowColor">
  152. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  153. <CODE>static&nbsp;<A HREF="../../../com/perforce/api/Client.html">Client</A></CODE></FONT></TD>
  154. <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>&nbsp;env,
  155.           <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A>&nbsp;name)</CODE>
  156.  
  157. <BR>
  158. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns a Client with the specified name, or null if not found.</TD>
  159. </TR>
  160. <TR BGCOLOR="white" CLASS="TableRowColor">
  161. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  162. <CODE>static&nbsp;<A HREF="../../../com/perforce/api/Client.html">Client</A></CODE></FONT></TD>
  163. <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>&nbsp;name)</CODE>
  164.  
  165. <BR>
  166. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns a Client with the specified name, or null if not found.</TD>
  167. </TR>
  168. <TR BGCOLOR="white" CLASS="TableRowColor">
  169. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  170. <CODE>static&nbsp;<A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/util/Iterator.html">Iterator</A></CODE></FONT></TD>
  171. <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>&nbsp;env)</CODE>
  172.  
  173. <BR>
  174. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
  175. </TR>
  176. <TR BGCOLOR="white" CLASS="TableRowColor">
  177. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  178. <CODE>static&nbsp;<A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/util/Enumeration.html">Enumeration</A></CODE></FONT></TD>
  179. <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>&nbsp;env)</CODE>
  180.  
  181. <BR>
  182. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
  183. </TR>
  184. <TR BGCOLOR="white" CLASS="TableRowColor">
  185. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  186. <CODE>&nbsp;<A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A></CODE></FONT></TD>
  187. <TD><CODE><B><A HREF="../../../com/perforce/api/Client.html#getOptions()">getOptions</A></B>()</CODE>
  188.  
  189. <BR>
  190. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the Client options.</TD>
  191. </TR>
  192. <TR BGCOLOR="white" CLASS="TableRowColor">
  193. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  194. <CODE>&nbsp;<A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A></CODE></FONT></TD>
  195. <TD><CODE><B><A HREF="../../../com/perforce/api/Client.html#getRoot()">getRoot</A></B>()</CODE>
  196.  
  197. <BR>
  198. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the Client root.</TD>
  199. </TR>
  200. <TR BGCOLOR="white" CLASS="TableRowColor">
  201. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  202. <CODE>static&nbsp;void</CODE></FONT></TD>
  203. <TD><CODE><B><A HREF="../../../com/perforce/api/Client.html#loadClients()">loadClients</A></B>()</CODE>
  204.  
  205. <BR>
  206. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Loads a list of all the clients into an internal class Hashtable.</TD>
  207. </TR>
  208. <TR BGCOLOR="white" CLASS="TableRowColor">
  209. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  210. <CODE>static&nbsp;void</CODE></FONT></TD>
  211. <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>&nbsp;env)</CODE>
  212.  
  213. <BR>
  214. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Loads a list of all the clients into an internal class Hashtable.</TD>
  215. </TR>
  216. <TR BGCOLOR="white" CLASS="TableRowColor">
  217. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  218. <CODE>static&nbsp;<A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/util/Enumeration.html">Enumeration</A></CODE></FONT></TD>
  219. <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>&nbsp;env,
  220.              <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A>&nbsp;prefix)</CODE>
  221.  
  222. <BR>
  223. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns a list of clients that begin with the specified prefix.</TD>
  224. </TR>
  225. <TR BGCOLOR="white" CLASS="TableRowColor">
  226. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  227. <CODE>static&nbsp;<A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/util/Enumeration.html">Enumeration</A></CODE></FONT></TD>
  228. <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>&nbsp;prefix)</CODE>
  229.  
  230. <BR>
  231. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns a list of clients that begin with the specified prefix.</TD>
  232. </TR>
  233. <TR BGCOLOR="white" CLASS="TableRowColor">
  234. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  235. <CODE>&nbsp;void</CODE></FONT></TD>
  236. <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>&nbsp;options)</CODE>
  237.  
  238. <BR>
  239. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Sets the options for the Client.</TD>
  240. </TR>
  241. <TR BGCOLOR="white" CLASS="TableRowColor">
  242. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  243. <CODE>&nbsp;void</CODE></FONT></TD>
  244. <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>&nbsp;root)</CODE>
  245.  
  246. <BR>
  247. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Sets the root for the Client.</TD>
  248. </TR>
  249. <TR BGCOLOR="white" CLASS="TableRowColor">
  250. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  251. <CODE>&nbsp;void</CODE></FONT></TD>
  252. <TD><CODE><B><A HREF="../../../com/perforce/api/Client.html#sync()">sync</A></B>()</CODE>
  253.  
  254. <BR>
  255. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Brings this object back into sync with Perforce.</TD>
  256. </TR>
  257. <TR BGCOLOR="white" CLASS="TableRowColor">
  258. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  259. <CODE>&nbsp;void</CODE></FONT></TD>
  260. <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>&nbsp;name)</CODE>
  261.  
  262. <BR>
  263. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Synchronizes the Client with the latest information from P4.</TD>
  264. </TR>
  265. <TR BGCOLOR="white" CLASS="TableRowColor">
  266. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  267. <CODE>&nbsp;<A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A></CODE></FONT></TD>
  268. <TD><CODE><B><A HREF="../../../com/perforce/api/Client.html#toXML()">toXML</A></B>()</CODE>
  269.  
  270. <BR>
  271. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns a string containing the object in XML form.</TD>
  272. </TR>
  273. </TABLE>
  274. &nbsp;<A NAME="methods_inherited_from_class_com.perforce.api.Mapping"><!-- --></A>
  275. <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
  276. <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
  277. <TD><B>Methods inherited from class com.perforce.api.<A HREF="../../../com/perforce/api/Mapping.html">Mapping</A></B></TD>
  278. </TR>
  279. <TR BGCOLOR="white" CLASS="TableRowColor">
  280. <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>
  281. </TR>
  282. </TABLE>
  283. &nbsp;<A NAME="methods_inherited_from_class_com.perforce.api.SourceControlObject"><!-- --></A>
  284. <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
  285. <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
  286. <TD><B>Methods inherited from class com.perforce.api.<A HREF="../../../com/perforce/api/SourceControlObject.html">SourceControlObject</A></B></TD>
  287. </TR>
  288. <TR BGCOLOR="white" CLASS="TableRowColor">
  289. <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>
  290. </TR>
  291. </TABLE>
  292. &nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
  293. <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
  294. <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
  295. <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>
  296. </TR>
  297. <TR BGCOLOR="white" CLASS="TableRowColor">
  298. <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>
  299. </TR>
  300. </TABLE>
  301. &nbsp;
  302. <P>
  303.  
  304. <!-- ============ FIELD DETAIL =========== -->
  305.  
  306.  
  307. <!-- ========= CONSTRUCTOR DETAIL ======== -->
  308.  
  309. <A NAME="constructor_detail"><!-- --></A>
  310. <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
  311. <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
  312. <TD COLSPAN=1><FONT SIZE="+2">
  313. <B>Constructor Detail</B></FONT></TD>
  314. </TR>
  315. </TABLE>
  316.  
  317. <A NAME="Client()"><!-- --></A><H3>
  318. Client</H3>
  319. <PRE>
  320. public <B>Client</B>()</PRE>
  321. <DL>
  322. <DD>Default no-argument constructor.</DL>
  323. <HR>
  324.  
  325. <A NAME="Client(com.perforce.api.Env, java.lang.String)"><!-- --></A><H3>
  326. Client</H3>
  327. <PRE>
  328. public <B>Client</B>(<A HREF="../../../com/perforce/api/Env.html">Env</A>&nbsp;env,
  329.               <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A>&nbsp;name)</PRE>
  330. <DL>
  331. <DD>Constructor that is passed the client name.</DL>
  332. <HR>
  333.  
  334. <A NAME="Client(java.lang.String)"><!-- --></A><H3>
  335. Client</H3>
  336. <PRE>
  337. public <B>Client</B>(<A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A>&nbsp;name)</PRE>
  338. <DL>
  339. <DD>Constructor that is passed the client name.</DL>
  340.  
  341. <!-- ============ METHOD DETAIL ========== -->
  342.  
  343. <A NAME="method_detail"><!-- --></A>
  344. <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
  345. <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
  346. <TD COLSPAN=1><FONT SIZE="+2">
  347. <B>Method Detail</B></FONT></TD>
  348. </TR>
  349. </TABLE>
  350.  
  351. <A NAME="commit()"><!-- --></A><H3>
  352. commit</H3>
  353. <PRE>
  354. public void <B>commit</B>()
  355.             throws <A HREF="../../../com/perforce/api/CommitException.html">CommitException</A></PRE>
  356. <DL>
  357. <DD><B>Description copied from class: <CODE><A HREF="../../../com/perforce/api/SourceControlObject.html">SourceControlObject</A></CODE></B></DD>
  358. <DD>Stores this object back into Perforce, creating it if it
  359.  didn't already exist.<DD><DL>
  360. <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>
  361. </DD>
  362. </DL>
  363. <HR>
  364.  
  365. <A NAME="getCache()"><!-- --></A><H3>
  366. getCache</H3>
  367. <PRE>
  368. public <A HREF="../../../com/perforce/api/HashDecay.html">HashDecay</A> <B>getCache</B>()</PRE>
  369. <DL>
  370. <DD><B>Description copied from class: <CODE><A HREF="../../../com/perforce/api/SourceControlObject.html">SourceControlObject</A></CODE></B></DD>
  371. <DD>Returns the HashDecay instance for this class<DD><DL>
  372. <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>
  373. </DD>
  374. </DL>
  375. <HR>
  376.  
  377. <A NAME="getClient(com.perforce.api.Env, java.lang.String)"><!-- --></A><H3>
  378. getClient</H3>
  379. <PRE>
  380. public static <A HREF="../../../com/perforce/api/Client.html">Client</A> <B>getClient</B>(<A HREF="../../../com/perforce/api/Env.html">Env</A>&nbsp;env,
  381.                                <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A>&nbsp;name)</PRE>
  382. <DL>
  383. <DD>Returns a Client with the specified name, or null if not found. It is
  384.  important to keep in mind that the Client returned may not hold valid
  385.  information, other than its name. To ensure the Client has valid
  386.  information, the sync() method must be called.<DD><DL>
  387. <DT><B>Parameters:</B><DD><CODE>name</CODE> - Name of the client to find.</DL>
  388. </DD>
  389. </DL>
  390. <HR>
  391.  
  392. <A NAME="getClient(java.lang.String)"><!-- --></A><H3>
  393. getClient</H3>
  394. <PRE>
  395. 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>&nbsp;name)</PRE>
  396. <DL>
  397. <DD>Returns a Client with the specified name, or null if not found.<DD><DL>
  398. <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>
  399. </DD>
  400. </DL>
  401. <HR>
  402.  
  403. <A NAME="getClientIterator(com.perforce.api.Env)"><!-- --></A><H3>
  404. getClientIterator</H3>
  405. <PRE>
  406. 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>&nbsp;env)</PRE>
  407. <DL>
  408. <DD><DL>
  409. <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>
  410. </DD>
  411. </DL>
  412. <HR>
  413.  
  414. <A NAME="getClients(com.perforce.api.Env)"><!-- --></A><H3>
  415. getClients</H3>
  416. <PRE>
  417. 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>&nbsp;env)</PRE>
  418. <DL>
  419. <DD><DL>
  420. <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>
  421. </DD>
  422. </DL>
  423. <HR>
  424.  
  425. <A NAME="getOptions()"><!-- --></A><H3>
  426. getOptions</H3>
  427. <PRE>
  428. public <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A> <B>getOptions</B>()</PRE>
  429. <DL>
  430. <DD>Returns the Client options.</DL>
  431. <HR>
  432.  
  433. <A NAME="getRoot()"><!-- --></A><H3>
  434. getRoot</H3>
  435. <PRE>
  436. public <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A> <B>getRoot</B>()</PRE>
  437. <DL>
  438. <DD>Returns the Client root.</DL>
  439. <HR>
  440.  
  441. <A NAME="loadClients()"><!-- --></A><H3>
  442. loadClients</H3>
  443. <PRE>
  444. public static void <B>loadClients</B>()</PRE>
  445. <DL>
  446. <DD>Loads a list of all the clients into an internal class Hashtable. This
  447.  method will only be called by the class itself if the Hashtable is
  448.  empty. Users should call this method if they believe the p4 client
  449.  information needs to be brought up to date.<DD><DL>
  450. <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>
  451. </DD>
  452. </DL>
  453. <HR>
  454.  
  455. <A NAME="loadClients(com.perforce.api.Env)"><!-- --></A><H3>
  456. loadClients</H3>
  457. <PRE>
  458. public static void <B>loadClients</B>(<A HREF="../../../com/perforce/api/Env.html">Env</A>&nbsp;env)</PRE>
  459. <DL>
  460. <DD>Loads a list of all the clients into an internal class Hashtable.<DD><DL>
  461. <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>
  462. </DD>
  463. </DL>
  464. <HR>
  465.  
  466. <A NAME="lookupClient(com.perforce.api.Env, java.lang.String)"><!-- --></A><H3>
  467. lookupClient</H3>
  468. <PRE>
  469. 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>&nbsp;env,
  470.                                        <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A>&nbsp;prefix)</PRE>
  471. <DL>
  472. <DD>Returns a list of clients that begin with the specified prefix.<DD><DL>
  473. <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>
  474. </DD>
  475. </DL>
  476. <HR>
  477.  
  478. <A NAME="lookupClient(java.lang.String)"><!-- --></A><H3>
  479. lookupClient</H3>
  480. <PRE>
  481. 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>&nbsp;prefix)</PRE>
  482. <DL>
  483. <DD>Returns a list of clients that begin with the specified prefix.<DD><DL>
  484. <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>
  485. </DD>
  486. </DL>
  487. <HR>
  488.  
  489. <A NAME="setOptions(java.lang.String)"><!-- --></A><H3>
  490. setOptions</H3>
  491. <PRE>
  492. public void <B>setOptions</B>(<A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A>&nbsp;options)</PRE>
  493. <DL>
  494. <DD>Sets the options for the Client.<DD><DL>
  495. <DT><B>Parameters:</B><DD><CODE>options</CODE> - Options of the client.</DL>
  496. </DD>
  497. </DL>
  498. <HR>
  499.  
  500. <A NAME="setRoot(java.lang.String)"><!-- --></A><H3>
  501. setRoot</H3>
  502. <PRE>
  503. public void <B>setRoot</B>(<A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A>&nbsp;root)</PRE>
  504. <DL>
  505. <DD>Sets the root for the Client.<DD><DL>
  506. <DT><B>Parameters:</B><DD><CODE>root</CODE> - Root of the client.</DL>
  507. </DD>
  508. </DL>
  509. <HR>
  510.  
  511. <A NAME="sync()"><!-- --></A><H3>
  512. sync</H3>
  513. <PRE>
  514. public void <B>sync</B>()</PRE>
  515. <DL>
  516. <DD><B>Description copied from class: <CODE><A HREF="../../../com/perforce/api/SourceControlObject.html">SourceControlObject</A></CODE></B></DD>
  517. <DD>Brings this object back into sync with Perforce. This also sets the
  518.  sets the update and sync time for this object.<DD><DL>
  519. <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>
  520. </DD>
  521. </DL>
  522. <HR>
  523.  
  524. <A NAME="sync(java.lang.String)"><!-- --></A><H3>
  525. sync</H3>
  526. <PRE>
  527. public void <B>sync</B>(<A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A>&nbsp;name)</PRE>
  528. <DL>
  529. <DD>Synchronizes the Client with the latest information from P4. This method
  530.  forces the Client to contain the latest, correct information if it didn't
  531.  already.<DD><DL>
  532. <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>
  533. </DD>
  534. <DD><DL>
  535. <DT><B>Parameters:</B><DD><CODE>name</CODE> - Name of the Client to synchronize.</DL>
  536. </DD>
  537. </DL>
  538. <HR>
  539.  
  540. <A NAME="toXML()"><!-- --></A><H3>
  541. toXML</H3>
  542. <PRE>
  543. public <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A> <B>toXML</B>()</PRE>
  544. <DL>
  545. <DD><B>Description copied from class: <CODE><A HREF="../../../com/perforce/api/SourceControlObject.html">SourceControlObject</A></CODE></B></DD>
  546. <DD>Returns a string containing the object in XML form.<DD><DL>
  547. <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>
  548. </DD>
  549. </DL>
  550. <!-- ========= END OF CLASS DATA ========= -->
  551. <HR>
  552.  
  553. <!-- ========== START OF NAVBAR ========== -->
  554. <A NAME="navbar_bottom"><!-- --></A>
  555. <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0">
  556. <TR>
  557. <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
  558. <A NAME="navbar_bottom_firstrow"><!-- --></A>
  559. <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3">
  560.   <TR ALIGN="center" VALIGN="top">
  561.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
  562.   <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
  563.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/Client.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
  564.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
  565.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
  566.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
  567.   </TR>
  568. </TABLE>
  569. </TD>
  570. <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
  571. <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>
  572. </TD>
  573. </TR>
  574.  
  575. <TR>
  576. <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  577. &nbsp;<A HREF="../../../com/perforce/api/Change.html"><B>PREV CLASS</B></A>&nbsp;
  578. &nbsp;<A HREF="../../../com/perforce/api/Counter.html"><B>NEXT CLASS</B></A></FONT></TD>
  579. <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  580.   <A HREF="../../../index.html" TARGET="_top"><B>FRAMES</B></A>  &nbsp;
  581. &nbsp;<A HREF="Client.html" TARGET="_top"><B>NO FRAMES</B></A></FONT></TD>
  582. </TR>
  583. <TR>
  584. <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
  585.   SUMMARY: &nbsp;INNER&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
  586. <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
  587. DETAIL: &nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
  588. </TR>
  589. </TABLE>
  590. <!-- =========== END OF NAVBAR =========== -->
  591.  
  592. <HR>
  593. <i><a href="doc-files/LICENSE.TXT">Copyright</a> &#169; 2001, Perforce Software, All rights reserved.</i>
  594. </BODY>
  595. </HTML>
# Change User Description Committed
#8 2001 David Markley Updated package documentation. 23 years ago
#7 1387 David Markley Added the ability to reopen files, add them to changelists, and updated the
documentation... to reflect these changes. «		 23 years ago
#6 1360 David Markley Updated Env class. 23 years ago
#5 1332 David Markley Added more example code.
Added the Counter class.
Corrected the filelog methods for the... FileEntry class. «		 23 years ago
#4 1148 David Markley Added a few examples and a server connection timeout threshold. 23 years ago
#3 1037 David Markley Updated the documentation. 23 years ago
#2 1021 David Markley Corrected spelling of deprecated in the source.
Added <pre> tag around license info...rmation. «		 23 years ago
#1 1020 David Markley Added Perforce Java API documentation.
This is generated using JavaDoc. 		23 years ago