Helix SwarmHelix Swarm
Loading...

User.html

  • //
  • guest/
  • david_markley/
  • p4package/
  • docs/
  • com/
  • perforce/
  • api/
  • User.html #6
  • View
  • Commits
  • Open Download .zip Download (25 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  User
  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/User.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/SourceControlObject.html"><B>PREV CLASS</B></A>&nbsp;
  38. &nbsp;<A HREF="../../../com/perforce/api/Utils.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="User.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  User</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.         +--<B>com.perforce.api.User</B>
  65. </PRE>
  66. <DL>
  67. <DT><B>All Implemented Interfaces:</B> <DD><A HREF="../../../com/perforce/api/Cacheable.html">Cacheable</A></DD>
  68. </DL>
  69. <HR>
  70. <DL>
  71. <DT>public final class <B>User</B><DT>extends <A HREF="../../../com/perforce/api/SourceControlObject.html">SourceControlObject</A></DL>
  72.  
  73. <P>
  74. Representation of a source control user. Each instance can store one p4
  75.  user's information. The class methods can be used to
  76.  <a href="#getUser(java.lang.String)">get a particular user</a>.
  77.  If that user has been gotten before, their user information will not
  78.  be reloaded from P4. It is instead loaded from an internal HashDecay.
  79.  <p>
  80.  If the user information must be up to date, then the
  81.  <a href="#sync()">sync()</a> method must be called.
  82.  <p>
  83.  TBD: The current implementation does NOT handle the "reviews" information
  84.  for each user. Should User extend Mapping?
  85. <P>
  86. <DL>
  87. <DT><B>Version: </B><DD>$Date: 2002/08/05 $ $Revision: #6 $</DD>
  88. <DT><B>Author: </B><DD><a href="mailto:david@markley.cc">David Markley</a></DD>
  89. <DT><B>See Also: </B><DD><A HREF="../../../com/perforce/api/HashDecay.html"><CODE>HashDecay</CODE></A></DL>
  90. <HR>
  91.  
  92. <P>
  93. <!-- ======== INNER CLASS SUMMARY ======== -->
  94.  
  95.  
  96. <!-- =========== FIELD SUMMARY =========== -->
  97.  
  98.  
  99. <!-- ======== CONSTRUCTOR SUMMARY ======== -->
  100.  
  101. <A NAME="constructor_summary"><!-- --></A>
  102. <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
  103. <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
  104. <TD COLSPAN=2><FONT SIZE="+2">
  105. <B>Constructor Summary</B></FONT></TD>
  106. </TR>
  107. <TR BGCOLOR="white" CLASS="TableRowColor">
  108. <TD><CODE><B><A HREF="../../../com/perforce/api/User.html#User()">User</A></B>()</CODE>
  109.  
  110. <BR>
  111. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Default no-argument constructor.</TD>
  112. </TR>
  113. <TR BGCOLOR="white" CLASS="TableRowColor">
  114. <TD><CODE><B><A HREF="../../../com/perforce/api/User.html#User(java.lang.String)">User</A></B>(<A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A>&nbsp;id)</CODE>
  115.  
  116. <BR>
  117. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Constructor that accepts the id of the user.</TD>
  118. </TR>
  119. </TABLE>
  120. &nbsp;
  121. <!-- ========== METHOD SUMMARY =========== -->
  122.  
  123. <A NAME="method_summary"><!-- --></A>
  124. <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
  125. <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
  126. <TD COLSPAN=2><FONT SIZE="+2">
  127. <B>Method Summary</B></FONT></TD>
  128. </TR>
  129. <TR BGCOLOR="white" CLASS="TableRowColor">
  130. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  131. <CODE>&nbsp;void</CODE></FONT></TD>
  132. <TD><CODE><B><A HREF="../../../com/perforce/api/User.html#commit()">commit</A></B>()</CODE>
  133.  
  134. <BR>
  135. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;TBD: The <code>commit</code> method is not working yet.</TD>
  136. </TR>
  137. <TR BGCOLOR="white" CLASS="TableRowColor">
  138. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  139. <CODE>&nbsp;<A HREF="../../../com/perforce/api/HashDecay.html">HashDecay</A></CODE></FONT></TD>
  140. <TD><CODE><B><A HREF="../../../com/perforce/api/User.html#getCache()">getCache</A></B>()</CODE>
  141.  
  142. <BR>
  143. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the HashDecay instance for this class</TD>
  144. </TR>
  145. <TR BGCOLOR="white" CLASS="TableRowColor">
  146. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  147. <CODE>&nbsp;<A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A></CODE></FONT></TD>
  148. <TD><CODE><B><A HREF="../../../com/perforce/api/User.html#getEmail()">getEmail</A></B>()</CODE>
  149.  
  150. <BR>
  151. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the e-mail address for this user.</TD>
  152. </TR>
  153. <TR BGCOLOR="white" CLASS="TableRowColor">
  154. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  155. <CODE>&nbsp;<A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A></CODE></FONT></TD>
  156. <TD><CODE><B><A HREF="../../../com/perforce/api/User.html#getFullName()">getFullName</A></B>()</CODE>
  157.  
  158. <BR>
  159. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the full name of this user.</TD>
  160. </TR>
  161. <TR BGCOLOR="white" CLASS="TableRowColor">
  162. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  163. <CODE>&nbsp;<A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A></CODE></FONT></TD>
  164. <TD><CODE><B><A HREF="../../../com/perforce/api/User.html#getId()">getId</A></B>()</CODE>
  165.  
  166. <BR>
  167. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the id for this user.</TD>
  168. </TR>
  169. <TR BGCOLOR="white" CLASS="TableRowColor">
  170. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  171. <CODE>static&nbsp;<A HREF="../../../com/perforce/api/User.html">User</A></CODE></FONT></TD>
  172. <TD><CODE><B><A HREF="../../../com/perforce/api/User.html#getUser(com.perforce.api.Env, java.lang.String)">getUser</A></B>(<A HREF="../../../com/perforce/api/Env.html">Env</A>&nbsp;env,
  173.         <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A>&nbsp;uid)</CODE>
  174.  
  175. <BR>
  176. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Gets the user information for the specified user.</TD>
  177. </TR>
  178. <TR BGCOLOR="white" CLASS="TableRowColor">
  179. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  180. <CODE>static&nbsp;<A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/util/Enumeration.html">Enumeration</A></CODE></FONT></TD>
  181. <TD><CODE><B><A HREF="../../../com/perforce/api/User.html#getUsers()">getUsers</A></B>()</CODE>
  182.  
  183. <BR>
  184. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns an <code>Enumeration</code> of all <code>User</code> objects.</TD>
  185. </TR>
  186. <TR BGCOLOR="white" CLASS="TableRowColor">
  187. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  188. <CODE>static&nbsp;<A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/util/Enumeration.html">Enumeration</A></CODE></FONT></TD>
  189. <TD><CODE><B><A HREF="../../../com/perforce/api/User.html#getUsers(com.perforce.api.Env)">getUsers</A></B>(<A HREF="../../../com/perforce/api/Env.html">Env</A>&nbsp;env)</CODE>
  190.  
  191. <BR>
  192. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns an <code>Enumeration</code> of all <code>User</code> objects.</TD>
  193. </TR>
  194. <TR BGCOLOR="white" CLASS="TableRowColor">
  195. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  196. <CODE>&nbsp;void</CODE></FONT></TD>
  197. <TD><CODE><B><A HREF="../../../com/perforce/api/User.html#setEmail(java.lang.String)">setEmail</A></B>(<A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A>&nbsp;email)</CODE>
  198.  
  199. <BR>
  200. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Sets the e-mail address for this user.</TD>
  201. </TR>
  202. <TR BGCOLOR="white" CLASS="TableRowColor">
  203. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  204. <CODE>&nbsp;void</CODE></FONT></TD>
  205. <TD><CODE><B><A HREF="../../../com/perforce/api/User.html#setFullName(java.lang.String)">setFullName</A></B>(<A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A>&nbsp;fullname)</CODE>
  206.  
  207. <BR>
  208. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Sets the full name of this user.</TD>
  209. </TR>
  210. <TR BGCOLOR="white" CLASS="TableRowColor">
  211. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  212. <CODE>&nbsp;void</CODE></FONT></TD>
  213. <TD><CODE><B><A HREF="../../../com/perforce/api/User.html#setId(java.lang.String)">setId</A></B>(<A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A>&nbsp;id)</CODE>
  214.  
  215. <BR>
  216. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Sets the id for this user.</TD>
  217. </TR>
  218. <TR BGCOLOR="white" CLASS="TableRowColor">
  219. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  220. <CODE>&nbsp;void</CODE></FONT></TD>
  221. <TD><CODE><B><A HREF="../../../com/perforce/api/User.html#sync()">sync</A></B>()</CODE>
  222.  
  223. <BR>
  224. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Synchronizes the user information with P4.</TD>
  225. </TR>
  226. <TR BGCOLOR="white" CLASS="TableRowColor">
  227. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  228. <CODE>&nbsp;void</CODE></FONT></TD>
  229. <TD><CODE><B><A HREF="../../../com/perforce/api/User.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;id)</CODE>
  230.  
  231. <BR>
  232. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Synchronizes the user information with P4.</TD>
  233. </TR>
  234. <TR BGCOLOR="white" CLASS="TableRowColor">
  235. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  236. <CODE>&nbsp;<A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A></CODE></FONT></TD>
  237. <TD><CODE><B><A HREF="../../../com/perforce/api/User.html#toString()">toString</A></B>()</CODE>
  238.  
  239. <BR>
  240. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
  241. </TR>
  242. <TR BGCOLOR="white" CLASS="TableRowColor">
  243. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  244. <CODE>&nbsp;<A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A></CODE></FONT></TD>
  245. <TD><CODE><B><A HREF="../../../com/perforce/api/User.html#toXML()">toXML</A></B>()</CODE>
  246.  
  247. <BR>
  248. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns a string containing the object in XML form.</TD>
  249. </TR>
  250. </TABLE>
  251. &nbsp;<A NAME="methods_inherited_from_class_com.perforce.api.SourceControlObject"><!-- --></A>
  252. <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
  253. <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
  254. <TD><B>Methods inherited from class com.perforce.api.<A HREF="../../../com/perforce/api/SourceControlObject.html">SourceControlObject</A></B></TD>
  255. </TR>
  256. <TR BGCOLOR="white" CLASS="TableRowColor">
  257. <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>
  258. </TR>
  259. </TABLE>
  260. &nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
  261. <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
  262. <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
  263. <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>
  264. </TR>
  265. <TR BGCOLOR="white" CLASS="TableRowColor">
  266. <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>
  267. </TR>
  268. </TABLE>
  269. &nbsp;
  270. <P>
  271.  
  272. <!-- ============ FIELD DETAIL =========== -->
  273.  
  274.  
  275. <!-- ========= CONSTRUCTOR DETAIL ======== -->
  276.  
  277. <A NAME="constructor_detail"><!-- --></A>
  278. <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
  279. <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
  280. <TD COLSPAN=1><FONT SIZE="+2">
  281. <B>Constructor Detail</B></FONT></TD>
  282. </TR>
  283. </TABLE>
  284.  
  285. <A NAME="User()"><!-- --></A><H3>
  286. User</H3>
  287. <PRE>
  288. public <B>User</B>()</PRE>
  289. <DL>
  290. <DD>Default no-argument constructor.</DL>
  291. <HR>
  292.  
  293. <A NAME="User(java.lang.String)"><!-- --></A><H3>
  294. User</H3>
  295. <PRE>
  296. public <B>User</B>(<A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A>&nbsp;id)</PRE>
  297. <DL>
  298. <DD>Constructor that accepts the id of the user. This simply creates an
  299.  instance that has the id set. No other information in the class will be
  300.  present until the <a href="#sync()">sync() method is called.<DD><DL>
  301. <DT><B>Parameters:</B><DD><CODE>id</CODE> - Id for the user.</DL>
  302. </DD>
  303. </DL>
  304.  
  305. <!-- ============ METHOD DETAIL ========== -->
  306.  
  307. <A NAME="method_detail"><!-- --></A>
  308. <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
  309. <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
  310. <TD COLSPAN=1><FONT SIZE="+2">
  311. <B>Method Detail</B></FONT></TD>
  312. </TR>
  313. </TABLE>
  314.  
  315. <A NAME="commit()"><!-- --></A><H3>
  316. commit</H3>
  317. <PRE>
  318. public void <B>commit</B>()</PRE>
  319. <DL>
  320. <DD>TBD: The <code>commit</code> method is not working yet.<DD><DL>
  321. <DT><B>Overrides:</B><DD><CODE><A HREF="../../../com/perforce/api/SourceControlObject.html#commit()">commit</A></CODE> in class <CODE><A HREF="../../../com/perforce/api/SourceControlObject.html">SourceControlObject</A></CODE></DL>
  322. </DD>
  323. </DL>
  324. <HR>
  325.  
  326. <A NAME="getCache()"><!-- --></A><H3>
  327. getCache</H3>
  328. <PRE>
  329. public <A HREF="../../../com/perforce/api/HashDecay.html">HashDecay</A> <B>getCache</B>()</PRE>
  330. <DL>
  331. <DD><B>Description copied from class: <CODE><A HREF="../../../com/perforce/api/SourceControlObject.html">SourceControlObject</A></CODE></B></DD>
  332. <DD>Returns the HashDecay instance for this class<DD><DL>
  333. <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>
  334. </DD>
  335. </DL>
  336. <HR>
  337.  
  338. <A NAME="getEmail()"><!-- --></A><H3>
  339. getEmail</H3>
  340. <PRE>
  341. public <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A> <B>getEmail</B>()</PRE>
  342. <DL>
  343. <DD>Returns the e-mail address for this user.<DD><DL>
  344. <DT><B>Returns:</B><DD>Email address for the user.</DL>
  345. </DD>
  346. </DL>
  347. <HR>
  348.  
  349. <A NAME="getFullName()"><!-- --></A><H3>
  350. getFullName</H3>
  351. <PRE>
  352. public <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A> <B>getFullName</B>()</PRE>
  353. <DL>
  354. <DD>Returns the full name of this user.<DD><DL>
  355. <DT><B>Returns:</B><DD>The full name for the user.</DL>
  356. </DD>
  357. </DL>
  358. <HR>
  359.  
  360. <A NAME="getId()"><!-- --></A><H3>
  361. getId</H3>
  362. <PRE>
  363. public <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A> <B>getId</B>()</PRE>
  364. <DL>
  365. <DD>Returns the id for this user.<DD><DL>
  366. <DT><B>Returns:</B><DD>Id for the user.</DL>
  367. </DD>
  368. </DL>
  369. <HR>
  370.  
  371. <A NAME="getUser(com.perforce.api.Env, java.lang.String)"><!-- --></A><H3>
  372. getUser</H3>
  373. <PRE>
  374. public static <A HREF="../../../com/perforce/api/User.html">User</A> <B>getUser</B>(<A HREF="../../../com/perforce/api/Env.html">Env</A>&nbsp;env,
  375.                            <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A>&nbsp;uid)</PRE>
  376. <DL>
  377. <DD>Gets the user information for the specified user.
  378.  If that user has been gotten before, their user information will not
  379.  be reloaded from P4. It is instead loaded from an internal HashDecay.
  380.  <p>
  381.  If the user information must be up to date, then the
  382.  <a href="#sync()">sync() method must be called.<DD><DL>
  383. <DT><B>Parameters:</B><DD><CODE>env</CODE> - Source control environment to use.<DD><CODE>uid</CODE> - The user id of the user information to get from p4.</DL>
  384. </DD>
  385. </DL>
  386. <HR>
  387.  
  388. <A NAME="getUsers()"><!-- --></A><H3>
  389. getUsers</H3>
  390. <PRE>
  391. public static <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/util/Enumeration.html">Enumeration</A> <B>getUsers</B>()</PRE>
  392. <DL>
  393. <DD>Returns an <code>Enumeration</code> of all <code>User</code> objects.</DL>
  394. <HR>
  395.  
  396. <A NAME="getUsers(com.perforce.api.Env)"><!-- --></A><H3>
  397. getUsers</H3>
  398. <PRE>
  399. public static <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/util/Enumeration.html">Enumeration</A> <B>getUsers</B>(<A HREF="../../../com/perforce/api/Env.html">Env</A>&nbsp;env)</PRE>
  400. <DL>
  401. <DD>Returns an <code>Enumeration</code> of all <code>User</code> objects.</DL>
  402. <HR>
  403.  
  404. <A NAME="setEmail(java.lang.String)"><!-- --></A><H3>
  405. setEmail</H3>
  406. <PRE>
  407. public void <B>setEmail</B>(<A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A>&nbsp;email)</PRE>
  408. <DL>
  409. <DD>Sets the e-mail address for this user.<DD><DL>
  410. <DT><B>Parameters:</B><DD><CODE>email</CODE> - Email address for the user.</DL>
  411. </DD>
  412. </DL>
  413. <HR>
  414.  
  415. <A NAME="setFullName(java.lang.String)"><!-- --></A><H3>
  416. setFullName</H3>
  417. <PRE>
  418. public void <B>setFullName</B>(<A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A>&nbsp;fullname)</PRE>
  419. <DL>
  420. <DD>Sets the full name of this user.<DD><DL>
  421. <DT><B>Parameters:</B><DD><CODE>fullname</CODE> - The full name for the user.</DL>
  422. </DD>
  423. </DL>
  424. <HR>
  425.  
  426. <A NAME="setId(java.lang.String)"><!-- --></A><H3>
  427. setId</H3>
  428. <PRE>
  429. public void <B>setId</B>(<A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A>&nbsp;id)</PRE>
  430. <DL>
  431. <DD>Sets the id for this user.<DD><DL>
  432. <DT><B>Parameters:</B><DD><CODE>id</CODE> - Id for the user.</DL>
  433. </DD>
  434. </DL>
  435. <HR>
  436.  
  437. <A NAME="sync()"><!-- --></A><H3>
  438. sync</H3>
  439. <PRE>
  440. public void <B>sync</B>()</PRE>
  441. <DL>
  442. <DD>Synchronizes the user information with P4. This method must be called
  443.  to ensure that this contains the latest information from p4.<DD><DL>
  444. <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>
  445. </DD>
  446. </DL>
  447. <HR>
  448.  
  449. <A NAME="sync(java.lang.String)"><!-- --></A><H3>
  450. sync</H3>
  451. <PRE>
  452. public void <B>sync</B>(<A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A>&nbsp;id)</PRE>
  453. <DL>
  454. <DD>Synchronizes the user information with P4. This method must be called
  455.  to ensure that this contains the latest information from p4. This form
  456.  of the method can be used to change the user Id in at the same time.<DD><DL>
  457. <DT><B>Parameters:</B><DD><CODE>id</CODE> - The user id for this to synchronize from p4.</DL>
  458. </DD>
  459. </DL>
  460. <HR>
  461.  
  462. <A NAME="toString()"><!-- --></A><H3>
  463. toString</H3>
  464. <PRE>
  465. public <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A> <B>toString</B>()</PRE>
  466. <DL>
  467. <DD><DL>
  468. <DT><B>Overrides:</B><DD><CODE><A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/Object.html#toString()">toString</A></CODE> in class <CODE><A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/Object.html">Object</A></CODE></DL>
  469. </DD>
  470. </DL>
  471. <HR>
  472.  
  473. <A NAME="toXML()"><!-- --></A><H3>
  474. toXML</H3>
  475. <PRE>
  476. public <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A> <B>toXML</B>()</PRE>
  477. <DL>
  478. <DD><B>Description copied from class: <CODE><A HREF="../../../com/perforce/api/SourceControlObject.html">SourceControlObject</A></CODE></B></DD>
  479. <DD>Returns a string containing the object in XML form.<DD><DL>
  480. <DT><B>Overrides:</B><DD><CODE><A HREF="../../../com/perforce/api/SourceControlObject.html#toXML()">toXML</A></CODE> in class <CODE><A HREF="../../../com/perforce/api/SourceControlObject.html">SourceControlObject</A></CODE></DL>
  481. </DD>
  482. </DL>
  483. <!-- ========= END OF CLASS DATA ========= -->
  484. <HR>
  485.  
  486. <!-- ========== START OF NAVBAR ========== -->
  487. <A NAME="navbar_bottom"><!-- --></A>
  488. <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0">
  489. <TR>
  490. <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
  491. <A NAME="navbar_bottom_firstrow"><!-- --></A>
  492. <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3">
  493.   <TR ALIGN="center" VALIGN="top">
  494.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
  495.   <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
  496.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/User.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
  497.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
  498.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
  499.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
  500.   </TR>
  501. </TABLE>
  502. </TD>
  503. <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
  504. <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>
  505. </TD>
  506. </TR>
  507.  
  508. <TR>
  509. <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  510. &nbsp;<A HREF="../../../com/perforce/api/SourceControlObject.html"><B>PREV CLASS</B></A>&nbsp;
  511. &nbsp;<A HREF="../../../com/perforce/api/Utils.html"><B>NEXT CLASS</B></A></FONT></TD>
  512. <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  513.   <A HREF="../../../index.html" TARGET="_top"><B>FRAMES</B></A>  &nbsp;
  514. &nbsp;<A HREF="User.html" TARGET="_top"><B>NO FRAMES</B></A></FONT></TD>
  515. </TR>
  516. <TR>
  517. <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
  518.   SUMMARY: &nbsp;INNER&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
  519. <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
  520. DETAIL: &nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
  521. </TR>
  522. </TABLE>
  523. <!-- =========== END OF NAVBAR =========== -->
  524.  
  525. <HR>
  526. <i><a href="doc-files/LICENSE.TXT">Copyright</a> &#169; 2001, Perforce Software, All rights reserved.</i>
  527. </BODY>
  528. </HTML>
# Change User Description Committed
#6 2001 David Markley Updated package documentation. 23 years ago
#5 1387 David Markley Added the ability to reopen files, add them to changelists, and updated the
documentation... to reflect these changes. «		 23 years ago
#4 1360 David Markley Updated Env class. 23 years ago
#3 1332 David Markley Added more example code.
Added the Counter class.
Corrected the filelog methods for the... FileEntry class. «		 23 years ago
#2 1037 David Markley Updated the documentation. 23 years ago
#1 1020 David Markley Added Perforce Java API documentation.
This is generated using JavaDoc. 		23 years ago