<!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:52 PDT 2007 -->
<TITLE>
Client (Perforce API)
</TITLE>
<META NAME="keywords" CONTENT="com.perforce.api.Client class">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../stylesheet.css" TITLE="Style">
<SCRIPT type="text/javascript">
function windowTitle()
{
parent.document.title="Client (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/Client.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
<a target="_top" href="http://www.perforce.com/"><img alt="Perforce" border="0" height="44" width="151" src="doc-files/perforce_logo.gif"></a></EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../com/perforce/api/Change.html" title="class in com.perforce.api"><B>PREV CLASS</B></A>
<A HREF="../../../com/perforce/api/CommitException.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/Client.html" target="_top"><B>FRAMES</B></A>
<A HREF="Client.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 Client</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 "><A HREF="../../../com/perforce/api/Mapping.html" title="class in com.perforce.api">com.perforce.api.Mapping</A>
<IMG SRC="../../../resources/inherit.gif" ALT="extended by "><B>com.perforce.api.Client</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>, <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/Comparable.html" title="class or interface in java.lang">Comparable</A></DD>
</DL>
<HR>
<DL>
<DT><PRE>public final class <B>Client</B><DT>extends <A HREF="../../../com/perforce/api/Mapping.html" title="class in com.perforce.api">Mapping</A></DL>
</PRE>
<P>
Representation of a source control client. This class can be used to retrieve
and hold p4 client information. It's class methods can be used to list
<a href="#getClients()">all loaded clients</a> or list those
<a href="#lookupClient(java.lang.String)">beginning with a particular
prefix</a>. Before these class methods are called, the class method
<a href="#loadClients()">loadClients()</a>
must be called to ensure the client list is up to date.
<P>
<P>
<DL>
<DT><B>Version:</B></DT>
<DD>$Date: 2008/01/10 $ $Revision: #7 $</DD>
<DT><B>Author:</B></DT>
<DD><a href="mailto:david@markley.cc">David Markley</a></DD>
</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/Client.html#Client()">Client</A></B>()</CODE>
<BR>
Default no-argument constructor.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><B><A HREF="../../../com/perforce/api/Client.html#Client(com.perforce.api.Env, java.lang.String)">Client</A></B>(<A HREF="../../../com/perforce/api/Env.html" 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> name)</CODE>
<BR>
Constructor that is passed the client name.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><B><A HREF="../../../com/perforce/api/Client.html#Client(java.lang.String)">Client</A></B>(<A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> name)</CODE>
<BR>
Constructor that is passed the client name.</TD>
</TR>
</TABLE>
<!-- ========== METHOD SUMMARY =========== -->
<A NAME="method_summary"><!-- --></A>
<TABLE BORDER="1" 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/Client.html#commit()">commit</A></B>()</CODE>
<BR>
Stores this object back into Perforce, creating it if it
didn't already exist.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../../com/perforce/api/HashDecay.html" title="class in com.perforce.api">HashDecay</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../com/perforce/api/Client.html#getCache()">getCache</A></B>()</CODE>
<BR>
Returns the HashDecay instance for this class</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static <A HREF="../../../com/perforce/api/Client.html" title="class in com.perforce.api">Client</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../com/perforce/api/Client.html#getClient(com.perforce.api.Env, java.lang.String)">getClient</A></B>(<A HREF="../../../com/perforce/api/Env.html" 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> name)</CODE>
<BR>
Returns a Client with the specified name, or null if not found.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static <A HREF="../../../com/perforce/api/Client.html" title="class in com.perforce.api">Client</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../com/perforce/api/Client.html#getClient(java.lang.String)">getClient</A></B>(<A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> name)</CODE>
<BR>
Returns a Client with the specified name, or null if not found.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/util/Iterator.html" title="class or interface in java.util">Iterator</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../com/perforce/api/Client.html#getClientIterator(com.perforce.api.Env)">getClientIterator</A></B>(<A HREF="../../../com/perforce/api/Env.html" title="class in com.perforce.api">Env</A> env)</CODE>
<BR>
</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/util/Enumeration.html" title="class or interface in java.util">Enumeration</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../com/perforce/api/Client.html#getClients(com.perforce.api.Env)">getClients</A></B>(<A HREF="../../../com/perforce/api/Env.html" title="class in com.perforce.api">Env</A> env)</CODE>
<BR>
</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../com/perforce/api/Client.html#getOptions()">getOptions</A></B>()</CODE>
<BR>
Returns the Client options.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../com/perforce/api/Client.html#getRoot()">getRoot</A></B>()</CODE>
<BR>
Returns the Client root.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../com/perforce/api/Client.html#loadClients()">loadClients</A></B>()</CODE>
<BR>
Loads a list of all the clients into an internal class Hashtable.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../com/perforce/api/Client.html#loadClients(com.perforce.api.Env)">loadClients</A></B>(<A HREF="../../../com/perforce/api/Env.html" title="class in com.perforce.api">Env</A> env)</CODE>
<BR>
Loads a list of all the clients into an internal class Hashtable.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/util/Enumeration.html" title="class or interface in java.util">Enumeration</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../com/perforce/api/Client.html#lookupClient(com.perforce.api.Env, java.lang.String)">lookupClient</A></B>(<A HREF="../../../com/perforce/api/Env.html" 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> prefix)</CODE>
<BR>
Returns a list of clients that begin with the specified prefix.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/util/Enumeration.html" title="class or interface in java.util">Enumeration</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../com/perforce/api/Client.html#lookupClient(java.lang.String)">lookupClient</A></B>(<A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> prefix)</CODE>
<BR>
Returns a list of clients that begin with the specified prefix.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../com/perforce/api/Client.html#setOptions(java.lang.String)">setOptions</A></B>(<A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> options)</CODE>
<BR>
Sets the options for the Client.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../com/perforce/api/Client.html#setRoot(java.lang.String)">setRoot</A></B>(<A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> root)</CODE>
<BR>
Sets the root for the Client.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../com/perforce/api/Client.html#sync()">sync</A></B>()</CODE>
<BR>
Brings this object back into sync with Perforce.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../com/perforce/api/Client.html#sync(java.lang.String)">sync</A></B>(<A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> name)</CODE>
<BR>
Synchronizes the Client with the latest information from P4.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../com/perforce/api/Client.html#toXML()">toXML</A></B>()</CODE>
<BR>
Returns a string containing the object in XML form.</TD>
</TR>
</TABLE>
<A NAME="methods_inherited_from_class_com.perforce.api.Mapping"><!-- --></A>
<TABLE BORDER="1" 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/Mapping.html" title="class in com.perforce.api">Mapping</A></B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><A HREF="../../../com/perforce/api/Mapping.html#addView(java.lang.String)">addView</A>, <A HREF="../../../com/perforce/api/Mapping.html#addView(java.lang.String, java.lang.String)">addView</A>, <A HREF="../../../com/perforce/api/Mapping.html#compareTo(java.lang.Object)">compareTo</A>, <A HREF="../../../com/perforce/api/Mapping.html#getDescription()">getDescription</A>, <A HREF="../../../com/perforce/api/Mapping.html#getName()">getName</A>, <A HREF="../../../com/perforce/api/Mapping.html#getOwner()">getOwner</A>, <A HREF="../../../com/perforce/api/Mapping.html#getView()">getView</A>, <A HREF="../../../com/perforce/api/Mapping.html#getViews()">getViews</A>, <A HREF="../../../com/perforce/api/Mapping.html#lookupMappings(com.perforce.api.HashDecay, java.lang.String)">lookupMappings</A>, <A HREF="../../../com/perforce/api/Mapping.html#setDescription(java.lang.String)">setDescription</A>, <A HREF="../../../com/perforce/api/Mapping.html#setName(java.lang.String)">setName</A>, <A HREF="../../../com/perforce/api/Mapping.html#setOwner(java.lang.String)">setOwner</A>, <A HREF="../../../com/perforce/api/Mapping.html#toString()">toString</A></CODE></TD>
</TR>
</TABLE>
<A NAME="methods_inherited_from_class_com.perforce.api.SourceControlObject"><!-- --></A>
<TABLE BORDER="1" 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="Client()"><!-- --></A><H3>
Client</H3>
<PRE>
public <B>Client</B>()</PRE>
<DL>
<DD>Default no-argument constructor.
<P>
</DL>
<HR>
<A NAME="Client(com.perforce.api.Env, java.lang.String)"><!-- --></A><H3>
Client</H3>
<PRE>
public <B>Client</B>(<A HREF="../../../com/perforce/api/Env.html" 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> name)</PRE>
<DL>
<DD>Constructor that is passed the client name.
<P>
</DL>
<HR>
<A NAME="Client(java.lang.String)"><!-- --></A><H3>
Client</H3>
<PRE>
public <B>Client</B>(<A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> name)</PRE>
<DL>
<DD>Constructor that is passed the client name.
<P>
</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>()
throws <A HREF="../../../com/perforce/api/CommitException.html" title="class in com.perforce.api">CommitException</A></PRE>
<DL>
<DD><B>Description copied from class: <CODE><A HREF="../../../com/perforce/api/SourceControlObject.html#commit()">SourceControlObject</A></CODE></B></DD>
<DD>Stores this object back into Perforce, creating it if it
didn't already exist.
<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/Mapping.html#commit()">commit</A></CODE> in class <CODE><A HREF="../../../com/perforce/api/Mapping.html" title="class in com.perforce.api">Mapping</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../com/perforce/api/CommitException.html" title="class in com.perforce.api">CommitException</A></CODE></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="getClient(com.perforce.api.Env, java.lang.String)"><!-- --></A><H3>
getClient</H3>
<PRE>
public static <A HREF="../../../com/perforce/api/Client.html" title="class in com.perforce.api">Client</A> <B>getClient</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> name)</PRE>
<DL>
<DD>Returns a Client with the specified name, or null if not found. It is
important to keep in mind that the Client returned may not hold valid
information, other than its name. To ensure the Client has valid
information, the sync() method must be called.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>name</CODE> - Name of the client to find.</DL>
</DD>
</DL>
<HR>
<A NAME="getClient(java.lang.String)"><!-- --></A><H3>
getClient</H3>
<PRE>
public static <A HREF="../../../com/perforce/api/Client.html" title="class in com.perforce.api">Client</A> <B>getClient</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> name)</PRE>
<DL>
<DD>Returns a Client with the specified name, or null if not found.
<P>
<DD><DL>
<DT><B>See Also:</B><DD><A HREF="../../../com/perforce/api/Client.html#getClient(com.perforce.api.Env, java.lang.String)"><CODE>getClient(Env, String)</CODE></A></DL>
</DD>
</DL>
<HR>
<A NAME="getClientIterator(com.perforce.api.Env)"><!-- --></A><H3>
getClientIterator</H3>
<PRE>
public static <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/util/Iterator.html" title="class or interface in java.util">Iterator</A> <B>getClientIterator</B>(<A HREF="../../../com/perforce/api/Env.html" title="class in com.perforce.api">Env</A> env)</PRE>
<DL>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>env</CODE> - Environment to use when working with P4
<DT><B>Returns:</B><DD>Iterator for all clients currently loaded.</DL>
</DD>
</DL>
<HR>
<A NAME="getClients(com.perforce.api.Env)"><!-- --></A><H3>
getClients</H3>
<PRE>
public static <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/util/Enumeration.html" title="class or interface in java.util">Enumeration</A> <B>getClients</B>(<A HREF="../../../com/perforce/api/Env.html" title="class in com.perforce.api">Env</A> env)</PRE>
<DL>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>env</CODE> - Environment to use when working with P4
<DT><B>Returns:</B><DD>Enumeration of all clients currently loaded.</DL>
</DD>
</DL>
<HR>
<A NAME="getOptions()"><!-- --></A><H3>
getOptions</H3>
<PRE>
public <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> <B>getOptions</B>()</PRE>
<DL>
<DD>Returns the Client options.
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="getRoot()"><!-- --></A><H3>
getRoot</H3>
<PRE>
public <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> <B>getRoot</B>()</PRE>
<DL>
<DD>Returns the Client root.
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="loadClients()"><!-- --></A><H3>
loadClients</H3>
<PRE>
public static void <B>loadClients</B>()</PRE>
<DL>
<DD>Loads a list of all the clients into an internal class Hashtable. This
method will only be called by the class itself if the Hashtable is
empty. Users should call this method if they believe the p4 client
information needs to be brought up to date.
<P>
<DD><DL>
<DT><B>See Also:</B><DD><A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/util/Hashtable.html" title="class or interface in java.util"><CODE>Hashtable</CODE></A></DL>
</DD>
</DL>
<HR>
<A NAME="loadClients(com.perforce.api.Env)"><!-- --></A><H3>
loadClients</H3>
<PRE>
public static void <B>loadClients</B>(<A HREF="../../../com/perforce/api/Env.html" title="class in com.perforce.api">Env</A> env)</PRE>
<DL>
<DD>Loads a list of all the clients into an internal class Hashtable.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>env</CODE> - Source conrol environment to use.<DT><B>See Also:</B><DD><A HREF="../../../com/perforce/api/Client.html#loadClients()"><CODE>loadClients()</CODE></A></DL>
</DD>
</DL>
<HR>
<A NAME="lookupClient(com.perforce.api.Env, java.lang.String)"><!-- --></A><H3>
lookupClient</H3>
<PRE>
public static <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/util/Enumeration.html" title="class or interface in java.util">Enumeration</A> <B>lookupClient</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> prefix)</PRE>
<DL>
<DD>Returns a list of clients that begin with the specified prefix.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>env</CODE> - P4 environment to use.<DD><CODE>prefix</CODE> - Prefix for all clients to be returned.
<DT><B>Returns:</B><DD>List of clients matching the prefix.</DL>
</DD>
</DL>
<HR>
<A NAME="lookupClient(java.lang.String)"><!-- --></A><H3>
lookupClient</H3>
<PRE>
public static <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/util/Enumeration.html" title="class or interface in java.util">Enumeration</A> <B>lookupClient</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> prefix)</PRE>
<DL>
<DD>Returns a list of clients that begin with the specified prefix.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>prefix</CODE> - Prefix for all clients to be returned
<DT><B>Returns:</B><DD>List of clients matching the prefix.</DL>
</DD>
</DL>
<HR>
<A NAME="setOptions(java.lang.String)"><!-- --></A><H3>
setOptions</H3>
<PRE>
public void <B>setOptions</B>(<A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> options)</PRE>
<DL>
<DD>Sets the options for the Client.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>options</CODE> - Options of the client.</DL>
</DD>
</DL>
<HR>
<A NAME="setRoot(java.lang.String)"><!-- --></A><H3>
setRoot</H3>
<PRE>
public void <B>setRoot</B>(<A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> root)</PRE>
<DL>
<DD>Sets the root for the Client.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>root</CODE> - Root of the client.</DL>
</DD>
</DL>
<HR>
<A NAME="sync()"><!-- --></A><H3>
sync</H3>
<PRE>
public void <B>sync</B>()</PRE>
<DL>
<DD><B>Description copied from class: <CODE><A HREF="../../../com/perforce/api/SourceControlObject.html#sync()">SourceControlObject</A></CODE></B></DD>
<DD>Brings this object back into sync with Perforce. This also sets the
sets the update and sync time for this object.
<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> name)</PRE>
<DL>
<DD>Synchronizes the Client with the latest information from P4. This method
forces the Client to contain the latest, correct information if it didn't
already.
<P>
<DD><DL>
<DT><B>Specified by:</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" title="class in com.perforce.api">Mapping</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>name</CODE> - Name of the Client to synchronize.</DL>
</DD>
</DL>
<HR>
<A NAME="toXML()"><!-- --></A><H3>
toXML</H3>
<PRE>
public <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html" 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>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" title="class in com.perforce.api">Mapping</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/Client.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
<a target="_top" href="http://www.perforce.com/"><img alt="Perforce" border="0" height="44" width="151" src="doc-files/perforce_logo.gif"></a></EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../com/perforce/api/Change.html" title="class in com.perforce.api"><B>PREV CLASS</B></A>
<A HREF="../../../com/perforce/api/CommitException.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/Client.html" target="_top"><B>FRAMES</B></A>
<A HREF="Client.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 | |
|---|---|---|---|---|---|
| #10 | 8157 | michael | Archiving legacy java api projects which predate the supported P4Java api. | ||
| #9 | 6166 | Sivananda Poreddy | Fixing problem with last check related to javadoc | ||
| #8 | 6164 | Sivananda Poreddy | Updating the javadoc to include all the new changes | ||
| #7 | 6141 | Sivananda Poreddy | Updating the p4package with fixes, some new features, jar update, and doc updates | ||
| #6 | 2002 | David Markley | Integrated the latest changes for p4package to the public depot. | ||
| #5 | 1808 | David Markley |
Updated Env class and fixed fstat issues. Published new Javadocs. |
||
| #4 | 1361 | David Markley | Added convenience methods to the Env class. | ||
| #3 | 1334 | David Markley |
Added more example code. Added the Counter class. Corrected the filelog methods for the FileEntry class. |
||
| #2 | 1149 | David Markley | Added more documentation, a few examples, a cleanUp method, and a server timeout threshold. | ||
| #1 | 1043 | David Markley | Initial branch to public area. | ||
| //guest/david_markley/p4package/docs/com/perforce/api/Client.html | |||||
| #3 | 1037 | David Markley | Updated the documentation. | ||
| #2 | 1021 | David Markley |
Corrected spelling of deprecated in the source. Added <pre> tag around license information. |
||
| #1 | 1020 | David Markley |
Added Perforce Java API documentation. This is generated using JavaDoc. |
||