<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> <!--NewPage--> <HTML> <HEAD> <!-- Generated by javadoc (build 1.5.0_11) on Tue Aug 14 12:50:53 PDT 2007 --> <TITLE> User (Perforce API) </TITLE> <META NAME="keywords" CONTENT="com.perforce.api.User class"> <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../stylesheet.css" TITLE="Style"> <SCRIPT type="text/javascript"> function windowTitle() { parent.document.title="User (Perforce API)"; } </SCRIPT> <NOSCRIPT> </NOSCRIPT> </HEAD> <BODY BGCOLOR="white" onload="windowTitle();"> <!-- ========= START OF TOP NAVBAR ======= --> <A NAME="navbar_top"><!-- --></A> <A HREF="#skip-navbar_top" title="Skip navigation links"></A> <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> <TR> <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A NAME="navbar_top_firstrow"><!-- --></A> <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> <TR ALIGN="center" VALIGN="top"> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../com/perforce/api/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/User.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/SubmitException.html" title="class in com.perforce.api"><B>PREV CLASS</B></A> <A HREF="../../../com/perforce/api/Utils.html" title="class in com.perforce.api"><B>NEXT CLASS</B></A></FONT></TD> <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> <A HREF="../../../index.html?com/perforce/api/User.html" target="_top"><B>FRAMES</B></A> <A HREF="User.html" target="_top"><B>NO FRAMES</B></A> <SCRIPT type="text/javascript"> <!-- if(window==top) { document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>'); } //--> </SCRIPT> <NOSCRIPT> <A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A> </NOSCRIPT> </FONT></TD> </TR> <TR> <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> SUMMARY: NESTED | 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> <A NAME="skip-navbar_top"></A> <!-- ========= END OF TOP NAVBAR ========= --> <HR> <!-- ======== START OF CLASS DATA ======== --> <H2> <FONT SIZE="-1"> com.perforce.api</FONT> <BR> Class User</H2> <PRE> <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/Object.html" title="class or interface in java.lang">java.lang.Object</A> <IMG SRC="../../../resources/inherit.gif" ALT="extended by "><A HREF="../../../com/perforce/api/SourceControlObject.html" title="class in com.perforce.api">com.perforce.api.SourceControlObject</A> <IMG SRC="../../../resources/inherit.gif" ALT="extended by "><B>com.perforce.api.User</B> </PRE> <DL> <DT><B>All Implemented Interfaces:</B> <DD><A HREF="../../../com/perforce/api/Cacheable.html" title="interface in com.perforce.api">Cacheable</A></DD> </DL> <HR> <DL> <DT><PRE>public final class <B>User</B><DT>extends <A HREF="../../../com/perforce/api/SourceControlObject.html" title="class in com.perforce.api">SourceControlObject</A></DL> </PRE> <P> Representation of a source control user. Each instance can store one p4 user's information. The class methods can be used to <a href="#getUser(java.lang.String)">get a particular user</a>. If that user has been gotten before, their user information will not be reloaded from P4. It is instead loaded from an internal HashDecay. <p> If the user information must be up to date, then the <a href="#sync()">sync()</a> method must be called. <p> TBD: The current implementation does NOT handle the "reviews" information for each user. Should User extend Mapping? <P> <P> <DL> <DT><B>Version:</B></DT> <DD>$Date: 2008/01/28 $ $Revision: #7 $</DD> <DT><B>Author:</B></DT> <DD><a href="mailto:david@markley.cc">David Markley</a></DD> <DT><B>See Also:</B><DD><A HREF="../../../com/perforce/api/HashDecay.html" title="class in com.perforce.api"><CODE>HashDecay</CODE></A></DL> <HR> <P> <!-- ======== CONSTRUCTOR SUMMARY ======== --> <A NAME="constructor_summary"><!-- --></A> <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> <B>Constructor Summary</B></FONT></TH> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD><CODE><B><A HREF="../../../com/perforce/api/User.html#User()">User</A></B>()</CODE> <BR> Default no-argument constructor.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <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" title="class or interface in java.lang">String</A> id)</CODE> <BR> Constructor that accepts the id of the user.</TD> </TR> </TABLE> <!-- ========== METHOD SUMMARY =========== --> <A NAME="method_summary"><!-- --></A> <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> <B>Method Summary</B></FONT></TH> </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/User.html#commit()">commit</A></B>()</CODE> <BR> TBD: The <code>commit</code> method is not working yet.</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" title="class in com.perforce.api">HashDecay</A></CODE></FONT></TD> <TD><CODE><B><A HREF="../../../com/perforce/api/User.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> <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A></CODE></FONT></TD> <TD><CODE><B><A HREF="../../../com/perforce/api/User.html#getEmail()">getEmail</A></B>()</CODE> <BR> Returns the e-mail address for this user.</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" title="class or interface in java.lang">String</A></CODE></FONT></TD> <TD><CODE><B><A HREF="../../../com/perforce/api/User.html#getFullName()">getFullName</A></B>()</CODE> <BR> Returns the full name of this user.</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" title="class or interface in java.lang">String</A></CODE></FONT></TD> <TD><CODE><B><A HREF="../../../com/perforce/api/User.html#getId()">getId</A></B>()</CODE> <BR> Returns the id for this user.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE>static <A HREF="../../../com/perforce/api/User.html" title="class in com.perforce.api">User</A></CODE></FONT></TD> <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" title="class in com.perforce.api">Env</A> env, <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> uid)</CODE> <BR> Gets the user information for the specified user.</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" title="class or interface in java.util">Enumeration</A></CODE></FONT></TD> <TD><CODE><B><A HREF="../../../com/perforce/api/User.html#getUsers()">getUsers</A></B>()</CODE> <BR> Returns an <code>Enumeration</code> of all <code>User</code> objects.</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" title="class or interface in java.util">Enumeration</A></CODE></FONT></TD> <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" title="class in com.perforce.api">Env</A> env)</CODE> <BR> Returns an <code>Enumeration</code> of all <code>User</code> objects.</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/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" title="class or interface in java.lang">String</A> email)</CODE> <BR> Sets the e-mail address for this user.</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/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" title="class or interface in java.lang">String</A> fullname)</CODE> <BR> Sets the full name of this user.</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/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" title="class or interface in java.lang">String</A> id)</CODE> <BR> Sets the id for this user.</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/User.html#sync()">sync</A></B>()</CODE> <BR> Synchronizes the user information with P4.</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/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" title="class or interface in java.lang">String</A> id)</CODE> <BR> Synchronizes the user information with 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" title="class or interface in java.lang">String</A></CODE></FONT></TD> <TD><CODE><B><A HREF="../../../com/perforce/api/User.html#toString()">toString</A></B>()</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" title="class or interface in java.lang">String</A></CODE></FONT></TD> <TD><CODE><B><A HREF="../../../com/perforce/api/User.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.SourceControlObject"><!-- --></A> <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> <TH ALIGN="left"><B>Methods inherited from class com.perforce.api.<A HREF="../../../com/perforce/api/SourceControlObject.html" title="class in com.perforce.api">SourceControlObject</A></B></TH> </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" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> <TH ALIGN="left"><B>Methods inherited from class java.lang.<A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A></B></TH> </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()" title="class or interface in java.lang">clone</A>, <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang">equals</A>, <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/Object.html#finalize()" title="class or interface in java.lang">finalize</A>, <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/Object.html#getClass()" title="class or interface in java.lang">getClass</A>, <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/Object.html#hashCode()" title="class or interface in java.lang">hashCode</A>, <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/Object.html#notify()" title="class or interface in java.lang">notify</A>, <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/Object.html#notifyAll()" title="class or interface in java.lang">notifyAll</A>, <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/Object.html#wait()" title="class or interface in java.lang">wait</A>, <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/Object.html#wait(long)" title="class or interface in java.lang">wait</A>, <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/Object.html#wait(long, int)" title="class or interface in java.lang">wait</A></CODE></TD> </TR> </TABLE> <P> <!-- ========= CONSTRUCTOR DETAIL ======== --> <A NAME="constructor_detail"><!-- --></A> <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> <B>Constructor Detail</B></FONT></TH> </TR> </TABLE> <A NAME="User()"><!-- --></A><H3> User</H3> <PRE> public <B>User</B>()</PRE> <DL> <DD>Default no-argument constructor. <P> </DL> <HR> <A NAME="User(java.lang.String)"><!-- --></A><H3> User</H3> <PRE> public <B>User</B>(<A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> id)</PRE> <DL> <DD>Constructor that accepts the id of the user. This simply creates an instance that has the id set. No other information in the class will be present until the <a href="#sync()">sync() method is called. <P> <DL> <DT><B>Parameters:</B><DD><CODE>id</CODE> - Id for the user.</DL> </DL> <!-- ============ METHOD DETAIL ========== --> <A NAME="method_detail"><!-- --></A> <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> <B>Method Detail</B></FONT></TH> </TR> </TABLE> <A NAME="commit()"><!-- --></A><H3> commit</H3> <PRE> public void <B>commit</B>()</PRE> <DL> <DD>TBD: The <code>commit</code> method is not working yet. <P> <DD><DL> <DT><B>Specified by:</B><DD><CODE><A HREF="../../../com/perforce/api/Cacheable.html#commit()">commit</A></CODE> in interface <CODE><A HREF="../../../com/perforce/api/Cacheable.html" title="interface in com.perforce.api">Cacheable</A></CODE><DT><B>Specified by:</B><DD><CODE><A HREF="../../../com/perforce/api/SourceControlObject.html#commit()">commit</A></CODE> in class <CODE><A HREF="../../../com/perforce/api/SourceControlObject.html" title="class in com.perforce.api">SourceControlObject</A></CODE></DL> </DD> <DD><DL> </DL> </DD> </DL> <HR> <A NAME="getCache()"><!-- --></A><H3> getCache</H3> <PRE> public <A HREF="../../../com/perforce/api/HashDecay.html" title="class in com.perforce.api">HashDecay</A> <B>getCache</B>()</PRE> <DL> <DD><B>Description copied from class: <CODE><A HREF="../../../com/perforce/api/SourceControlObject.html#getCache()">SourceControlObject</A></CODE></B></DD> <DD>Returns the HashDecay instance for this class <P> <DD><DL> <DT><B>Specified by:</B><DD><CODE><A HREF="../../../com/perforce/api/Cacheable.html#getCache()">getCache</A></CODE> in interface <CODE><A HREF="../../../com/perforce/api/Cacheable.html" title="interface in com.perforce.api">Cacheable</A></CODE><DT><B>Specified by:</B><DD><CODE><A HREF="../../../com/perforce/api/SourceControlObject.html#getCache()">getCache</A></CODE> in class <CODE><A HREF="../../../com/perforce/api/SourceControlObject.html" title="class in com.perforce.api">SourceControlObject</A></CODE></DL> </DD> <DD><DL> </DL> </DD> </DL> <HR> <A NAME="getEmail()"><!-- --></A><H3> getEmail</H3> <PRE> public <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> <B>getEmail</B>()</PRE> <DL> <DD>Returns the e-mail address for this user. <P> <DD><DL> <DT><B>Returns:</B><DD>Email address for the user.</DL> </DD> </DL> <HR> <A NAME="getFullName()"><!-- --></A><H3> getFullName</H3> <PRE> public <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> <B>getFullName</B>()</PRE> <DL> <DD>Returns the full name of this user. <P> <DD><DL> <DT><B>Returns:</B><DD>The full name for the user.</DL> </DD> </DL> <HR> <A NAME="getId()"><!-- --></A><H3> getId</H3> <PRE> public <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> <B>getId</B>()</PRE> <DL> <DD>Returns the id for this user. <P> <DD><DL> <DT><B>Returns:</B><DD>Id for the user.</DL> </DD> </DL> <HR> <A NAME="getUser(com.perforce.api.Env, java.lang.String)"><!-- --></A><H3> getUser</H3> <PRE> public static <A HREF="../../../com/perforce/api/User.html" title="class in com.perforce.api">User</A> <B>getUser</B>(<A HREF="../../../com/perforce/api/Env.html" title="class in com.perforce.api">Env</A> env, <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> uid)</PRE> <DL> <DD>Gets the user information for the specified user. If that user has been gotten before, their user information will not be reloaded from P4. It is instead loaded from an internal HashDecay. <p> If the user information must be up to date, then the <a href="#sync()">sync() method must be called. <P> <DD><DL> <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> </DD> </DL> <HR> <A NAME="getUsers()"><!-- --></A><H3> getUsers</H3> <PRE> public static <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/util/Enumeration.html" title="class or interface in java.util">Enumeration</A> <B>getUsers</B>()</PRE> <DL> <DD>Returns an <code>Enumeration</code> of all <code>User</code> objects. <P> <DD><DL> </DL> </DD> </DL> <HR> <A NAME="getUsers(com.perforce.api.Env)"><!-- --></A><H3> getUsers</H3> <PRE> public static <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/util/Enumeration.html" title="class or interface in java.util">Enumeration</A> <B>getUsers</B>(<A HREF="../../../com/perforce/api/Env.html" title="class in com.perforce.api">Env</A> env)</PRE> <DL> <DD>Returns an <code>Enumeration</code> of all <code>User</code> objects. <P> <DD><DL> </DL> </DD> </DL> <HR> <A NAME="setEmail(java.lang.String)"><!-- --></A><H3> setEmail</H3> <PRE> public void <B>setEmail</B>(<A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> email)</PRE> <DL> <DD>Sets the e-mail address for this user. <P> <DD><DL> <DT><B>Parameters:</B><DD><CODE>email</CODE> - Email address for the user.</DL> </DD> </DL> <HR> <A NAME="setFullName(java.lang.String)"><!-- --></A><H3> setFullName</H3> <PRE> public void <B>setFullName</B>(<A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> fullname)</PRE> <DL> <DD>Sets the full name of this user. <P> <DD><DL> <DT><B>Parameters:</B><DD><CODE>fullname</CODE> - The full name for the user.</DL> </DD> </DL> <HR> <A NAME="setId(java.lang.String)"><!-- --></A><H3> setId</H3> <PRE> public void <B>setId</B>(<A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> id)</PRE> <DL> <DD>Sets the id for this user. <P> <DD><DL> <DT><B>Parameters:</B><DD><CODE>id</CODE> - Id for the user.</DL> </DD> </DL> <HR> <A NAME="sync()"><!-- --></A><H3> sync</H3> <PRE> public void <B>sync</B>()</PRE> <DL> <DD>Synchronizes the user information with P4. This method must be called to ensure that this contains the latest information from p4. <P> <DD><DL> <DT><B>Specified by:</B><DD><CODE><A HREF="../../../com/perforce/api/Cacheable.html#sync()">sync</A></CODE> in interface <CODE><A HREF="../../../com/perforce/api/Cacheable.html" title="interface in com.perforce.api">Cacheable</A></CODE><DT><B>Specified by:</B><DD><CODE><A HREF="../../../com/perforce/api/SourceControlObject.html#sync()">sync</A></CODE> in class <CODE><A HREF="../../../com/perforce/api/SourceControlObject.html" title="class in com.perforce.api">SourceControlObject</A></CODE></DL> </DD> <DD><DL> </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" title="class or interface in java.lang">String</A> id)</PRE> <DL> <DD>Synchronizes the user information with P4. This method must be called to ensure that this contains the latest information from p4. This form of the method can be used to change the user Id in at the same time. <P> <DD><DL> <DT><B>Parameters:</B><DD><CODE>id</CODE> - The user id for this to synchronize from p4.</DL> </DD> </DL> <HR> <A NAME="toString()"><!-- --></A><H3> toString</H3> <PRE> public <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> <B>toString</B>()</PRE> <DL> <DD><DL> <DT><B>Overrides:</B><DD><CODE><A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/Object.html#toString()" title="class or interface in java.lang">toString</A></CODE> in class <CODE><A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A></CODE></DL> </DD> <DD><DL> </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" title="class or interface in java.lang">String</A> <B>toXML</B>()</PRE> <DL> <DD><B>Description copied from class: <CODE><A HREF="../../../com/perforce/api/SourceControlObject.html#toXML()">SourceControlObject</A></CODE></B></DD> <DD>Returns a string containing the object in XML form. <P> <DD><DL> <DT><B>Specified by:</B><DD><CODE><A HREF="../../../com/perforce/api/SourceControlObject.html#toXML()">toXML</A></CODE> in class <CODE><A HREF="../../../com/perforce/api/SourceControlObject.html" title="class in com.perforce.api">SourceControlObject</A></CODE></DL> </DD> <DD><DL> </DL> </DD> </DL> <!-- ========= END OF CLASS DATA ========= --> <HR> <!-- ======= START OF BOTTOM NAVBAR ====== --> <A NAME="navbar_bottom"><!-- --></A> <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A> <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> <TR> <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A NAME="navbar_bottom_firstrow"><!-- --></A> <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> <TR ALIGN="center" VALIGN="top"> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../com/perforce/api/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/User.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/SubmitException.html" title="class in com.perforce.api"><B>PREV CLASS</B></A> <A HREF="../../../com/perforce/api/Utils.html" title="class in com.perforce.api"><B>NEXT CLASS</B></A></FONT></TD> <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> <A HREF="../../../index.html?com/perforce/api/User.html" target="_top"><B>FRAMES</B></A> <A HREF="User.html" target="_top"><B>NO FRAMES</B></A> <SCRIPT type="text/javascript"> <!-- if(window==top) { document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>'); } //--> </SCRIPT> <NOSCRIPT> <A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A> </NOSCRIPT> </FONT></TD> </TR> <TR> <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> SUMMARY: NESTED | 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> <A NAME="skip-navbar_bottom"></A> <!-- ======== END OF BOTTOM NAVBAR ======= --> <HR> <i><a href="doc-files/LICENSE.TXT">Copyright</a> © 2001, Perforce Software, All rights reserved.</i> </BODY> </HTML>
# | Change | User | Description | Committed | |
---|---|---|---|---|---|
#9 | 8157 | michael | Archiving legacy java api projects which predate the supported P4Java api. | ||
#8 | 6166 | Sivananda Poreddy | Fixing problem with last check related to javadoc | ||
#7 | 6164 | Sivananda Poreddy | Updating the javadoc to include all the new changes | ||
#6 | 6141 | Sivananda Poreddy | Updating the p4package with fixes, some new features, jar update, and doc updates | ||
#5 | 2002 | David Markley | Integrated the latest changes for p4package to the public depot. | ||
#4 | 1808 | David Markley |
Updated Env class and fixed fstat issues. Published new Javadocs. |
||
#3 | 1361 | David Markley | Added convenience methods to the Env class. | ||
#2 | 1334 | David Markley |
Added more example code. Added the Counter class. Corrected the filelog methods for the FileEntry class. |
||
#1 | 1043 | David Markley | Initial branch to public area. | ||
//guest/david_markley/p4package/docs/com/perforce/api/User.html | |||||
#2 | 1037 | David Markley | Updated the documentation. | ||
#1 | 1020 | David Markley |
Added Perforce Java API documentation. This is generated using JavaDoc. |