<!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.6.0_06) on Tue Nov 30 14:45:46 PST 2010 --> <TITLE> ServerTask (P4Ant) </TITLE> <META NAME="date" CONTENT="2010-11-30"> <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style"> <SCRIPT type="text/javascript"> function windowTitle() { if (location.href.indexOf('is-external=true') == -1) { parent.document.title="ServerTask (P4Ant)"; } } </SCRIPT> <NOSCRIPT> </NOSCRIPT> </HEAD> <BODY BGCOLOR="white" onload="windowTitle();"> <HR> <!-- ========= 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="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/ServerTask.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="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</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> </EM> </TD> </TR> <TR> <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> <A HREF="../../../../../com/perforce/p4java/ant/tasks/RevertTask.html" title="class in com.perforce.p4java.ant.tasks"><B>PREV CLASS</B></A> <A HREF="../../../../../com/perforce/p4java/ant/tasks/ServerTask.GlobalOption.html" title="class in com.perforce.p4java.ant.tasks"><B>NEXT CLASS</B></A></FONT></TD> <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> <A HREF="../../../../../index.html?com/perforce/p4java/ant/tasks/ServerTask.html" target="_top"><B>FRAMES</B></A> <A HREF="ServerTask.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: <A HREF="#nested_class_summary">NESTED</A> | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> DETAIL: <A HREF="#field_detail">FIELD</A> | <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.p4java.ant.tasks</FONT> <BR> Class ServerTask</H2> <PRE> java.lang.Object <IMG SRC="../../../../../resources/inherit.gif" ALT="extended by ">org.apache.tools.ant.ProjectComponent <IMG SRC="../../../../../resources/inherit.gif" ALT="extended by ">org.apache.tools.ant.Task <IMG SRC="../../../../../resources/inherit.gif" ALT="extended by "><A HREF="../../../../../com/perforce/p4java/ant/tasks/PerforceTask.html" title="class in com.perforce.p4java.ant.tasks">com.perforce.p4java.ant.tasks.PerforceTask</A> <IMG SRC="../../../../../resources/inherit.gif" ALT="extended by "><B>com.perforce.p4java.ant.tasks.ServerTask</B> </PRE> <DL> <DT><B>All Implemented Interfaces:</B> <DD>java.lang.Cloneable</DD> </DL> <DL> <DT><B>Direct Known Subclasses:</B> <DD><A HREF="../../../../../com/perforce/p4java/ant/tasks/ClientTask.html" title="class in com.perforce.p4java.ant.tasks">ClientTask</A>, <A HREF="../../../../../com/perforce/p4java/ant/tasks/CounterTask.html" title="class in com.perforce.p4java.ant.tasks">CounterTask</A>, <A HREF="../../../../../com/perforce/p4java/ant/tasks/JobTask.html" title="class in com.perforce.p4java.ant.tasks">JobTask</A></DD> </DL> <HR> <DL> <DT><PRE>public abstract class <B>ServerTask</B><DT>extends <A HREF="../../../../../com/perforce/p4java/ant/tasks/PerforceTask.html" title="class in com.perforce.p4java.ant.tasks">PerforceTask</A></DL> </PRE> <P> Base class for Perforce server specific Ant tasks. It initializes an instance of the Perforce server. </p> <P> <P> <DL> <DT><B>See Also:</B><DD><A HREF="../../../../../com/perforce/p4java/ant/tasks/PerforceTask.html" title="class in com.perforce.p4java.ant.tasks"><CODE>PerforceTask</CODE></A></DL> <HR> <P> <!-- ======== NESTED CLASS SUMMARY ======== --> <A NAME="nested_class_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>Nested Class Summary</B></FONT></TH> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> class</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../../com/perforce/p4java/ant/tasks/ServerTask.GlobalOption.html" title="class in com.perforce.p4java.ant.tasks">ServerTask.GlobalOption</A></B></CODE> <BR> This inner class is used for handling nested "globaloption" elements.</TD> </TR> </TABLE> <A NAME="nested_classes_inherited_from_class_com.perforce.p4java.ant.tasks.PerforceTask"><!-- --></A> <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> <TH ALIGN="left"><B>Nested classes/interfaces inherited from class com.perforce.p4java.ant.tasks.<A HREF="../../../../../com/perforce/p4java/ant/tasks/PerforceTask.html" title="class in com.perforce.p4java.ant.tasks">PerforceTask</A></B></TH> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD><CODE><A HREF="../../../../../com/perforce/p4java/ant/tasks/PerforceTask.Field.html" title="class in com.perforce.p4java.ant.tasks">PerforceTask.Field</A>, <A HREF="../../../../../com/perforce/p4java/ant/tasks/PerforceTask.File.html" title="class in com.perforce.p4java.ant.tasks">PerforceTask.File</A></CODE></TD> </TR> </TABLE> <!-- =========== FIELD SUMMARY =========== --> <A NAME="field_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>Field Summary</B></FONT></TH> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE>protected boolean</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../../com/perforce/p4java/ant/tasks/ServerTask.html#allHosts">allHosts</A></B></CODE> <BR> If true, corresponds to -a flag on login.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE>protected Options</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../../com/perforce/p4java/ant/tasks/ServerTask.html#commandOptions">commandOptions</A></B></CODE> <BR> Options for Perforce command.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE>protected java.util.List<<A HREF="../../../../../com/perforce/p4java/ant/tasks/ServerTask.GlobalOption.html" title="class in com.perforce.p4java.ant.tasks">ServerTask.GlobalOption</A>></CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../../com/perforce/p4java/ant/tasks/ServerTask.html#globaloptions">globaloptions</A></B></CODE> <BR> Collection of globaloptions (name-value pairs) contained in the "globaloption" nested elements.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE>protected java.lang.String</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../../com/perforce/p4java/ant/tasks/ServerTask.html#hostName">hostName</A></B></CODE> <BR> If not null, specifies the host name used by the server's commands.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE>static java.lang.String</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../../com/perforce/p4java/ant/tasks/ServerTask.html#P4_SERVER_PROTOCOL_PROPERTIES_FILE">P4_SERVER_PROTOCOL_PROPERTIES_FILE</A></B></CODE> <BR> Default Perforce server protocol-specific properties file name.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE>static java.lang.String</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../../com/perforce/p4java/ant/tasks/ServerTask.html#P4_SERVER_USAGE_PROPERTIES_FILE">P4_SERVER_USAGE_PROPERTIES_FILE</A></B></CODE> <BR> Default Perforce server usage properties file name.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE>protected IOptionsServer</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../../com/perforce/p4java/ant/tasks/ServerTask.html#p4Server">p4Server</A></B></CODE> <BR> Perforce server.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE>protected java.lang.String</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../../com/perforce/p4java/ant/tasks/ServerTask.html#programName">programName</A></B></CODE> <BR> If not null, will be used to identify the P4Java application's program name to the Perforce server.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE>protected java.lang.String</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../../com/perforce/p4java/ant/tasks/ServerTask.html#programVersion">programVersion</A></B></CODE> <BR> If not null, will be used to identify the P4Java application's program version to the Perforce server.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE>protected java.lang.String</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../../com/perforce/p4java/ant/tasks/ServerTask.html#protocolPropertiesFile">protocolPropertiesFile</A></B></CODE> <BR> Perforce server protocol-specific properties file.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE>protected java.util.Properties</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../../com/perforce/p4java/ant/tasks/ServerTask.html#protocolProps">protocolProps</A></B></CODE> <BR> Protocol-specific properties.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE>protected java.lang.String</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../../com/perforce/p4java/ant/tasks/ServerTask.html#textLanguage">textLanguage</A></B></CODE> <BR> If not null, use this field to tell the server which language to use in text messages it sends back to the client.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE>protected java.lang.String</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../../com/perforce/p4java/ant/tasks/ServerTask.html#unsetClientName">unsetClientName</A></B></CODE> <BR> If set, this will be used as the name of the client when no client has actually been explicitly set for the associated server(s).</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE>protected java.lang.String</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../../com/perforce/p4java/ant/tasks/ServerTask.html#unsetUserName">unsetUserName</A></B></CODE> <BR> What will be sent to the Perforce server with each command as the user name if no user name has been explicitly set for servers associated with this UsageOption.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE>protected java.lang.String</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../../com/perforce/p4java/ant/tasks/ServerTask.html#usagePropertiesFile">usagePropertiesFile</A></B></CODE> <BR> Perforce server usage properties file.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE>protected java.util.Properties</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../../com/perforce/p4java/ant/tasks/ServerTask.html#usageProps">usageProps</A></B></CODE> <BR> Perforce server usage properties.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE>protected java.lang.String</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../../com/perforce/p4java/ant/tasks/ServerTask.html#workingDirectory">workingDirectory</A></B></CODE> <BR> If not null, this specifies the Perforce server's idea of each command's working directory for the associated server object.</TD> </TR> </TABLE> <A NAME="fields_inherited_from_class_com.perforce.p4java.ant.tasks.PerforceTask"><!-- --></A> <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> <TH ALIGN="left"><B>Fields inherited from class com.perforce.p4java.ant.tasks.<A HREF="../../../../../com/perforce/p4java/ant/tasks/PerforceTask.html" title="class in com.perforce.p4java.ant.tasks">PerforceTask</A></B></TH> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD><CODE><A HREF="../../../../../com/perforce/p4java/ant/tasks/PerforceTask.html#charset">charset</A>, <A HREF="../../../../../com/perforce/p4java/ant/tasks/PerforceTask.html#client">client</A>, <A HREF="../../../../../com/perforce/p4java/ant/tasks/PerforceTask.html#failOnError">failOnError</A>, <A HREF="../../../../../com/perforce/p4java/ant/tasks/PerforceTask.html#fields">fields</A>, <A HREF="../../../../../com/perforce/p4java/ant/tasks/PerforceTask.html#FILE_TOKEN_REGEX_PATTERN">FILE_TOKEN_REGEX_PATTERN</A>, <A HREF="../../../../../com/perforce/p4java/ant/tasks/PerforceTask.html#fileList">fileList</A>, <A HREF="../../../../../com/perforce/p4java/ant/tasks/PerforceTask.html#files">files</A>, <A HREF="../../../../../com/perforce/p4java/ant/tasks/PerforceTask.html#fileSpecs">fileSpecs</A>, <A HREF="../../../../../com/perforce/p4java/ant/tasks/PerforceTask.html#LINE_PADDING">LINE_PADDING</A>, <A HREF="../../../../../com/perforce/p4java/ant/tasks/PerforceTask.html#LINE_SEPARATOR">LINE_SEPARATOR</A>, <A HREF="../../../../../com/perforce/p4java/ant/tasks/PerforceTask.html#p4Messages">p4Messages</A>, <A HREF="../../../../../com/perforce/p4java/ant/tasks/PerforceTask.html#passwd">passwd</A>, <A HREF="../../../../../com/perforce/p4java/ant/tasks/PerforceTask.html#port">port</A>, <A HREF="../../../../../com/perforce/p4java/ant/tasks/PerforceTask.html#protocol">protocol</A>, <A HREF="../../../../../com/perforce/p4java/ant/tasks/PerforceTask.html#retFileSpecs">retFileSpecs</A>, <A HREF="../../../../../com/perforce/p4java/ant/tasks/PerforceTask.html#retStatusMessage">retStatusMessage</A>, <A HREF="../../../../../com/perforce/p4java/ant/tasks/PerforceTask.html#user">user</A></CODE></TD> </TR> </TABLE> <A NAME="fields_inherited_from_class_org.apache.tools.ant.Task"><!-- --></A> <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> <TH ALIGN="left"><B>Fields inherited from class org.apache.tools.ant.Task</B></TH> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD><CODE>target, taskName, taskType, wrapper</CODE></TD> </TR> </TABLE> <A NAME="fields_inherited_from_class_org.apache.tools.ant.ProjectComponent"><!-- --></A> <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> <TH ALIGN="left"><B>Fields inherited from class org.apache.tools.ant.ProjectComponent</B></TH> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD><CODE>description, location, project</CODE></TD> </TR> </TABLE> <!-- ======== 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/p4java/ant/tasks/ServerTask.html#ServerTask()">ServerTask</A></B>()</CODE> <BR> Default constructor.</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>protected void</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../../com/perforce/p4java/ant/tasks/ServerTask.html#cleanupP4()">cleanupP4</A></B>()</CODE> <BR> Cleanup the Perforce server instance.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE>protected void</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../../com/perforce/p4java/ant/tasks/ServerTask.html#cleanupP4Server()">cleanupP4Server</A></B>()</CODE> <BR> Cleanup the Perforce server instance.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> <A HREF="../../../../../com/perforce/p4java/ant/tasks/ServerTask.GlobalOption.html" title="class in com.perforce.p4java.ant.tasks">ServerTask.GlobalOption</A></CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../../com/perforce/p4java/ant/tasks/ServerTask.html#createGlobalOption()">createGlobalOption</A></B>()</CODE> <BR> This method is called by an Ant factory method to instantiates a collection of "globaloption" nested elements.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE>protected java.util.Properties</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../../com/perforce/p4java/ant/tasks/ServerTask.html#getGlobalOptions()">getGlobalOptions</A></B>()</CODE> <BR> Combine all of the globaloptions specified by the "globaloption" nested elements.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> IOptionsServer</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../../com/perforce/p4java/ant/tasks/ServerTask.html#getP4Server()">getP4Server</A></B>()</CODE> <BR> Gets the p4 server.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE>protected void</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../../com/perforce/p4java/ant/tasks/ServerTask.html#initP4()">initP4</A></B>()</CODE> <BR> Initialize the Perforce server instance.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE>protected void</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../../com/perforce/p4java/ant/tasks/ServerTask.html#initP4Server()">initP4Server</A></B>()</CODE> <BR> Initialize an instance of the Perforce server from the factory using the specified protocol, server port, protocol specific properties and usage options.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE>protected void</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../../com/perforce/p4java/ant/tasks/ServerTask.html#initP4ServerOptions()">initP4ServerOptions</A></B>()</CODE> <BR> Initialize the Perforce server options, such as protocol-specific properties and usage options.</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/p4java/ant/tasks/ServerTask.html#setAllHosts(boolean)">setAllHosts</A></B>(boolean allHosts)</CODE> <BR> Sets the all hosts.</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/p4java/ant/tasks/ServerTask.html#setHostName(java.lang.String)">setHostName</A></B>(java.lang.String hostName)</CODE> <BR> Sets the host name.</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/p4java/ant/tasks/ServerTask.html#setP4Server(IOptionsServer)">setP4Server</A></B>(IOptionsServer p4Server)</CODE> <BR> Sets the p4 server.</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/p4java/ant/tasks/ServerTask.html#setProgramName(java.lang.String)">setProgramName</A></B>(java.lang.String programName)</CODE> <BR> Sets the program name.</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/p4java/ant/tasks/ServerTask.html#setProgramVersion(java.lang.String)">setProgramVersion</A></B>(java.lang.String programVersion)</CODE> <BR> Sets the program version.</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/p4java/ant/tasks/ServerTask.html#setProtocolPropertiesFile(java.lang.String)">setProtocolPropertiesFile</A></B>(java.lang.String protocolPropertiesFile)</CODE> <BR> Sets the protocol properties file.</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/p4java/ant/tasks/ServerTask.html#setProtocolProps(java.util.Properties)">setProtocolProps</A></B>(java.util.Properties protocolProps)</CODE> <BR> Sets the protocol props.</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/p4java/ant/tasks/ServerTask.html#setTextLanguage(java.lang.String)">setTextLanguage</A></B>(java.lang.String textLanguage)</CODE> <BR> Sets the text language.</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/p4java/ant/tasks/ServerTask.html#setUnsetClientName(java.lang.String)">setUnsetClientName</A></B>(java.lang.String unsetClientName)</CODE> <BR> Sets the unset client name.</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/p4java/ant/tasks/ServerTask.html#setUnsetUserName(java.lang.String)">setUnsetUserName</A></B>(java.lang.String unsetUserName)</CODE> <BR> Sets the unset user name.</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/p4java/ant/tasks/ServerTask.html#setUsagePropertiesFile(java.lang.String)">setUsagePropertiesFile</A></B>(java.lang.String usagePropertiesFile)</CODE> <BR> Sets the usage properties file.</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/p4java/ant/tasks/ServerTask.html#setUsageProps(java.util.Properties)">setUsageProps</A></B>(java.util.Properties usageProps)</CODE> <BR> Sets the usage props.</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/p4java/ant/tasks/ServerTask.html#setWorkingDirectory(java.lang.String)">setWorkingDirectory</A></B>(java.lang.String workingDirectory)</CODE> <BR> Sets the working directory.</TD> </TR> </TABLE> <A NAME="methods_inherited_from_class_com.perforce.p4java.ant.tasks.PerforceTask"><!-- --></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.p4java.ant.tasks.<A HREF="../../../../../com/perforce/p4java/ant/tasks/PerforceTask.html" title="class in com.perforce.p4java.ant.tasks">PerforceTask</A></B></TH> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD><CODE><A HREF="../../../../../com/perforce/p4java/ant/tasks/PerforceTask.html#addFileset(org.apache.tools.ant.types.FileSet)">addFileset</A>, <A HREF="../../../../../com/perforce/p4java/ant/tasks/PerforceTask.html#createField()">createField</A>, <A HREF="../../../../../com/perforce/p4java/ant/tasks/PerforceTask.html#createFile()">createFile</A>, <A HREF="../../../../../com/perforce/p4java/ant/tasks/PerforceTask.html#execP4Command()">execP4Command</A>, <A HREF="../../../../../com/perforce/p4java/ant/tasks/PerforceTask.html#execute()">execute</A>, <A HREF="../../../../../com/perforce/p4java/ant/tasks/PerforceTask.html#getFields()">getFields</A>, <A HREF="../../../../../com/perforce/p4java/ant/tasks/PerforceTask.html#getFiles()">getFiles</A>, <A HREF="../../../../../com/perforce/p4java/ant/tasks/PerforceTask.html#getFileSpecs()">getFileSpecs</A>, <A HREF="../../../../../com/perforce/p4java/ant/tasks/PerforceTask.html#getRetFileSpecs()">getRetFileSpecs</A>, <A HREF="../../../../../com/perforce/p4java/ant/tasks/PerforceTask.html#getRetStatusMessage()">getRetStatusMessage</A>, <A HREF="../../../../../com/perforce/p4java/ant/tasks/PerforceTask.html#init()">init</A>, <A HREF="../../../../../com/perforce/p4java/ant/tasks/PerforceTask.html#isEmpty(java.lang.String)">isEmpty</A>, <A HREF="../../../../../com/perforce/p4java/ant/tasks/PerforceTask.html#logChangelistSummaries(java.util.List)">logChangelistSummaries</A>, <A HREF="../../../../../com/perforce/p4java/ant/tasks/PerforceTask.html#logChangelistSummary(IChangelistSummary)">logChangelistSummary</A>, <A HREF="../../../../../com/perforce/p4java/ant/tasks/PerforceTask.html#logExtendedFileSpec(IExtendedFileSpec)">logExtendedFileSpec</A>, <A HREF="../../../../../com/perforce/p4java/ant/tasks/PerforceTask.html#logExtendedFileSpecs(java.util.List)">logExtendedFileSpecs</A>, <A HREF="../../../../../com/perforce/p4java/ant/tasks/PerforceTask.html#logFileDiff(IFileDiff)">logFileDiff</A>, <A HREF="../../../../../com/perforce/p4java/ant/tasks/PerforceTask.html#logFileDiffs(java.util.List)">logFileDiffs</A>, <A HREF="../../../../../com/perforce/p4java/ant/tasks/PerforceTask.html#logFileLineMatch(IFileLineMatch)">logFileLineMatch</A>, <A HREF="../../../../../com/perforce/p4java/ant/tasks/PerforceTask.html#logFileLineMatches(java.util.List)">logFileLineMatches</A>, <A HREF="../../../../../com/perforce/p4java/ant/tasks/PerforceTask.html#logFileSpec(IFileSpec)">logFileSpec</A>, <A HREF="../../../../../com/perforce/p4java/ant/tasks/PerforceTask.html#logFileSpecs(java.util.List)">logFileSpecs</A>, <A HREF="../../../../../com/perforce/p4java/ant/tasks/PerforceTask.html#logFix(IFix)">logFix</A>, <A HREF="../../../../../com/perforce/p4java/ant/tasks/PerforceTask.html#logFixes(java.util.List)">logFixes</A>, <A HREF="../../../../../com/perforce/p4java/ant/tasks/PerforceTask.html#logJob(IJob)">logJob</A>, <A HREF="../../../../../com/perforce/p4java/ant/tasks/PerforceTask.html#logJobs(java.util.List)">logJobs</A>, <A HREF="../../../../../com/perforce/p4java/ant/tasks/PerforceTask.html#parseChangelist(java.lang.String)">parseChangelist</A>, <A HREF="../../../../../com/perforce/p4java/ant/tasks/PerforceTask.html#setCharset(java.lang.String)">setCharset</A>, <A HREF="../../../../../com/perforce/p4java/ant/tasks/PerforceTask.html#setClient(java.lang.String)">setClient</A>, <A HREF="../../../../../com/perforce/p4java/ant/tasks/PerforceTask.html#setFailOnError(boolean)">setFailOnError</A>, <A HREF="../../../../../com/perforce/p4java/ant/tasks/PerforceTask.html#setFiles(java.lang.String)">setFiles</A>, <A HREF="../../../../../com/perforce/p4java/ant/tasks/PerforceTask.html#setPasswd(java.lang.String)">setPasswd</A>, <A HREF="../../../../../com/perforce/p4java/ant/tasks/PerforceTask.html#setPort(java.lang.String)">setPort</A>, <A HREF="../../../../../com/perforce/p4java/ant/tasks/PerforceTask.html#setProtocol(java.lang.String)">setProtocol</A>, <A HREF="../../../../../com/perforce/p4java/ant/tasks/PerforceTask.html#setUser(java.lang.String)">setUser</A></CODE></TD> </TR> </TABLE> <A NAME="methods_inherited_from_class_org.apache.tools.ant.Task"><!-- --></A> <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> <TH ALIGN="left"><B>Methods inherited from class org.apache.tools.ant.Task</B></TH> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD><CODE>bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType</CODE></TD> </TR> </TABLE> <A NAME="methods_inherited_from_class_org.apache.tools.ant.ProjectComponent"><!-- --></A> <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> <TH ALIGN="left"><B>Methods inherited from class org.apache.tools.ant.ProjectComponent</B></TH> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD><CODE>clone, getDescription, getLocation, getProject, setDescription, setLocation, setProject</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.Object</B></TH> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD><CODE>equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD> </TR> </TABLE> <P> <!-- ============ FIELD DETAIL =========== --> <A NAME="field_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>Field Detail</B></FONT></TH> </TR> </TABLE> <A NAME="globaloptions"><!-- --></A><H3> globaloptions</H3> <PRE> protected java.util.List<<A HREF="../../../../../com/perforce/p4java/ant/tasks/ServerTask.GlobalOption.html" title="class in com.perforce.p4java.ant.tasks">ServerTask.GlobalOption</A>> <B>globaloptions</B></PRE> <DL> <DD>Collection of globaloptions (name-value pairs) contained in the "globaloption" nested elements. <P> <DL> </DL> </DL> <HR> <A NAME="P4_SERVER_PROTOCOL_PROPERTIES_FILE"><!-- --></A><H3> P4_SERVER_PROTOCOL_PROPERTIES_FILE</H3> <PRE> public static final java.lang.String <B>P4_SERVER_PROTOCOL_PROPERTIES_FILE</B></PRE> <DL> <DD>Default Perforce server protocol-specific properties file name. <P> <DL> <DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#com.perforce.p4java.ant.tasks.ServerTask.P4_SERVER_PROTOCOL_PROPERTIES_FILE">Constant Field Values</A></DL> </DL> <HR> <A NAME="P4_SERVER_USAGE_PROPERTIES_FILE"><!-- --></A><H3> P4_SERVER_USAGE_PROPERTIES_FILE</H3> <PRE> public static final java.lang.String <B>P4_SERVER_USAGE_PROPERTIES_FILE</B></PRE> <DL> <DD>Default Perforce server usage properties file name. <P> <DL> <DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#com.perforce.p4java.ant.tasks.ServerTask.P4_SERVER_USAGE_PROPERTIES_FILE">Constant Field Values</A></DL> </DL> <HR> <A NAME="p4Server"><!-- --></A><H3> p4Server</H3> <PRE> protected IOptionsServer <B>p4Server</B></PRE> <DL> <DD>Perforce server. <P> <DL> </DL> </DL> <HR> <A NAME="protocolPropertiesFile"><!-- --></A><H3> protocolPropertiesFile</H3> <PRE> protected java.lang.String <B>protocolPropertiesFile</B></PRE> <DL> <DD>Perforce server protocol-specific properties file. <P> <DL> </DL> </DL> <HR> <A NAME="usagePropertiesFile"><!-- --></A><H3> usagePropertiesFile</H3> <PRE> protected java.lang.String <B>usagePropertiesFile</B></PRE> <DL> <DD>Perforce server usage properties file. <P> <DL> </DL> </DL> <HR> <A NAME="protocolProps"><!-- --></A><H3> protocolProps</H3> <PRE> protected java.util.Properties <B>protocolProps</B></PRE> <DL> <DD>Protocol-specific properties. Note that these are typically described in usage or implementation notes supplied elsewhere, and are not typically used by end-users. <P> <DL> </DL> </DL> <HR> <A NAME="usageProps"><!-- --></A><H3> usageProps</H3> <PRE> protected java.util.Properties <B>usageProps</B></PRE> <DL> <DD>Perforce server usage properties. Note that these properties are potentially accessed for each command. <P> <DL> </DL> </DL> <HR> <A NAME="programName"><!-- --></A><H3> programName</H3> <PRE> protected java.lang.String <B>programName</B></PRE> <DL> <DD>If not null, will be used to identify the P4Java application's program name to the Perforce server. <P> <DL> </DL> </DL> <HR> <A NAME="programVersion"><!-- --></A><H3> programVersion</H3> <PRE> protected java.lang.String <B>programVersion</B></PRE> <DL> <DD>If not null, will be used to identify the P4Java application's program version to the Perforce server. <P> <DL> </DL> </DL> <HR> <A NAME="workingDirectory"><!-- --></A><H3> workingDirectory</H3> <PRE> protected java.lang.String <B>workingDirectory</B></PRE> <DL> <DD>If not null, this specifies the Perforce server's idea of each command's working directory for the associated server object. Corresponds to the p4 -d usage option. <p> This affects all commands on the associated server from this point on, and the passed-in path should be both absolute and valid, otherwise strange errors may appear from the server. If workingDirectory is null, the Java VM's actual current working directory <b>at the time this object is constructed</b> is used instead (which is almost always a safe option unless you're using Perforce alt roots). <p> Note: no checking is done at any time for correctness (or otherwise) of the workingDirectory option. <P> <DL> </DL> </DL> <HR> <A NAME="hostName"><!-- --></A><H3> hostName</H3> <PRE> protected java.lang.String <B>hostName</B></PRE> <DL> <DD>If not null, specifies the host name used by the server's commands. Set to null by the default constructor. Corresponds to the p4 -H usage option. HostName is not live -- that is, unlike many other UsageOption fields, its value is only read once when the associated server is created; subsequent changes will not be reflected in the associated server. <P> <DL> </DL> </DL> <HR> <A NAME="textLanguage"><!-- --></A><H3> textLanguage</H3> <PRE> protected java.lang.String <B>textLanguage</B></PRE> <DL> <DD>If not null, use this field to tell the server which language to use in text messages it sends back to the client. Corresponds to the p4 -L option, with the same limitations. Set to null by the default constructor. <P> <DL> </DL> </DL> <HR> <A NAME="unsetUserName"><!-- --></A><H3> unsetUserName</H3> <PRE> protected java.lang.String <B>unsetUserName</B></PRE> <DL> <DD>What will be sent to the Perforce server with each command as the user name if no user name has been explicitly set for servers associated with this UsageOption. <P> <DL> </DL> </DL> <HR> <A NAME="unsetClientName"><!-- --></A><H3> unsetClientName</H3> <PRE> protected java.lang.String <B>unsetClientName</B></PRE> <DL> <DD>If set, this will be used as the name of the client when no client has actually been explicitly set for the associated server(s). <P> <DL> </DL> </DL> <HR> <A NAME="allHosts"><!-- --></A><H3> allHosts</H3> <PRE> protected boolean <B>allHosts</B></PRE> <DL> <DD>If true, corresponds to -a flag on login. <P> <DL> </DL> </DL> <HR> <A NAME="commandOptions"><!-- --></A><H3> commandOptions</H3> <PRE> protected Options <B>commandOptions</B></PRE> <DL> <DD>Options for Perforce command. <P> <DL> </DL> </DL> <!-- ========= 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="ServerTask()"><!-- --></A><H3> ServerTask</H3> <PRE> public <B>ServerTask</B>()</PRE> <DL> <DD>Default constructor. <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="createGlobalOption()"><!-- --></A><H3> createGlobalOption</H3> <PRE> public <A HREF="../../../../../com/perforce/p4java/ant/tasks/ServerTask.GlobalOption.html" title="class in com.perforce.p4java.ant.tasks">ServerTask.GlobalOption</A> <B>createGlobalOption</B>()</PRE> <DL> <DD>This method is called by an Ant factory method to instantiates a collection of "globaloption" nested elements. It saves the reference to the collection and returns it to Ant Core. <P> <DD><DL> <DT><B>Returns:</B><DD>the globaloption</DL> </DD> </DL> <HR> <A NAME="getP4Server()"><!-- --></A><H3> getP4Server</H3> <PRE> public IOptionsServer <B>getP4Server</B>()</PRE> <DL> <DD>Gets the p4 server. <P> <DD><DL> <DT><B>Returns:</B><DD>the p4 server</DL> </DD> </DL> <HR> <A NAME="setP4Server(IOptionsServer)"><!-- --></A><H3> setP4Server</H3> <PRE> public void <B>setP4Server</B>(IOptionsServer p4Server)</PRE> <DL> <DD>Sets the p4 server. <P> <DD><DL> <DT><B>Parameters:</B><DD><CODE>p4Server</CODE> - the new p4 server</DL> </DD> </DL> <HR> <A NAME="setProtocolPropertiesFile(java.lang.String)"><!-- --></A><H3> setProtocolPropertiesFile</H3> <PRE> public void <B>setProtocolPropertiesFile</B>(java.lang.String protocolPropertiesFile)</PRE> <DL> <DD>Sets the protocol properties file. <P> <DD><DL> <DT><B>Parameters:</B><DD><CODE>protocolPropertiesFile</CODE> - the new protocol properties file</DL> </DD> </DL> <HR> <A NAME="setUsagePropertiesFile(java.lang.String)"><!-- --></A><H3> setUsagePropertiesFile</H3> <PRE> public void <B>setUsagePropertiesFile</B>(java.lang.String usagePropertiesFile)</PRE> <DL> <DD>Sets the usage properties file. <P> <DD><DL> <DT><B>Parameters:</B><DD><CODE>usagePropertiesFile</CODE> - the new usage properties file</DL> </DD> </DL> <HR> <A NAME="setProtocolProps(java.util.Properties)"><!-- --></A><H3> setProtocolProps</H3> <PRE> public void <B>setProtocolProps</B>(java.util.Properties protocolProps)</PRE> <DL> <DD>Sets the protocol props. <P> <DD><DL> <DT><B>Parameters:</B><DD><CODE>protocolProps</CODE> - the new protocol props</DL> </DD> </DL> <HR> <A NAME="setUsageProps(java.util.Properties)"><!-- --></A><H3> setUsageProps</H3> <PRE> public void <B>setUsageProps</B>(java.util.Properties usageProps)</PRE> <DL> <DD>Sets the usage props. <P> <DD><DL> <DT><B>Parameters:</B><DD><CODE>usageProps</CODE> - the new usage props</DL> </DD> </DL> <HR> <A NAME="setProgramName(java.lang.String)"><!-- --></A><H3> setProgramName</H3> <PRE> public void <B>setProgramName</B>(java.lang.String programName)</PRE> <DL> <DD>Sets the program name. <P> <DD><DL> <DT><B>Parameters:</B><DD><CODE>programName</CODE> - the new program name</DL> </DD> </DL> <HR> <A NAME="setProgramVersion(java.lang.String)"><!-- --></A><H3> setProgramVersion</H3> <PRE> public void <B>setProgramVersion</B>(java.lang.String programVersion)</PRE> <DL> <DD>Sets the program version. <P> <DD><DL> <DT><B>Parameters:</B><DD><CODE>programVersion</CODE> - the new program version</DL> </DD> </DL> <HR> <A NAME="setWorkingDirectory(java.lang.String)"><!-- --></A><H3> setWorkingDirectory</H3> <PRE> public void <B>setWorkingDirectory</B>(java.lang.String workingDirectory)</PRE> <DL> <DD>Sets the working directory. <P> <DD><DL> <DT><B>Parameters:</B><DD><CODE>workingDirectory</CODE> - the new working directory</DL> </DD> </DL> <HR> <A NAME="setHostName(java.lang.String)"><!-- --></A><H3> setHostName</H3> <PRE> public void <B>setHostName</B>(java.lang.String hostName)</PRE> <DL> <DD>Sets the host name. <P> <DD><DL> <DT><B>Parameters:</B><DD><CODE>hostName</CODE> - the new host name</DL> </DD> </DL> <HR> <A NAME="setTextLanguage(java.lang.String)"><!-- --></A><H3> setTextLanguage</H3> <PRE> public void <B>setTextLanguage</B>(java.lang.String textLanguage)</PRE> <DL> <DD>Sets the text language. <P> <DD><DL> <DT><B>Parameters:</B><DD><CODE>textLanguage</CODE> - the new text language</DL> </DD> </DL> <HR> <A NAME="setUnsetUserName(java.lang.String)"><!-- --></A><H3> setUnsetUserName</H3> <PRE> public void <B>setUnsetUserName</B>(java.lang.String unsetUserName)</PRE> <DL> <DD>Sets the unset user name. <P> <DD><DL> <DT><B>Parameters:</B><DD><CODE>unsetUserName</CODE> - the new unset user name</DL> </DD> </DL> <HR> <A NAME="setUnsetClientName(java.lang.String)"><!-- --></A><H3> setUnsetClientName</H3> <PRE> public void <B>setUnsetClientName</B>(java.lang.String unsetClientName)</PRE> <DL> <DD>Sets the unset client name. <P> <DD><DL> <DT><B>Parameters:</B><DD><CODE>unsetClientName</CODE> - the new unset client name</DL> </DD> </DL> <HR> <A NAME="setAllHosts(boolean)"><!-- --></A><H3> setAllHosts</H3> <PRE> public void <B>setAllHosts</B>(boolean allHosts)</PRE> <DL> <DD>Sets the all hosts. <P> <DD><DL> <DT><B>Parameters:</B><DD><CODE>allHosts</CODE> - the new all hosts</DL> </DD> </DL> <HR> <A NAME="initP4Server()"><!-- --></A><H3> initP4Server</H3> <PRE> protected void <B>initP4Server</B>()</PRE> <DL> <DD>Initialize an instance of the Perforce server from the factory using the specified protocol, server port, protocol specific properties and usage options. Register callback on the server. Connect to server; set the user (if present) to server and login to the server with the user's password (if present). <P> <DD><DL> </DL> </DD> </DL> <HR> <A NAME="initP4ServerOptions()"><!-- --></A><H3> initP4ServerOptions</H3> <PRE> protected void <B>initP4ServerOptions</B>()</PRE> <DL> <DD>Initialize the Perforce server options, such as protocol-specific properties and usage options. <P> <DD><DL> </DL> </DD> </DL> <HR> <A NAME="cleanupP4Server()"><!-- --></A><H3> cleanupP4Server</H3> <PRE> protected void <B>cleanupP4Server</B>()</PRE> <DL> <DD>Cleanup the Perforce server instance. Logout the user and disconnect from the Perforce server. Also, set the server to null. <P> <DD><DL> </DL> </DD> </DL> <HR> <A NAME="initP4()"><!-- --></A><H3> initP4</H3> <PRE> protected void <B>initP4</B>() throws org.apache.tools.ant.BuildException</PRE> <DL> <DD>Initialize the Perforce server instance. <P> <DD><DL> <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../com/perforce/p4java/ant/tasks/PerforceTask.html#initP4()">initP4</A></CODE> in class <CODE><A HREF="../../../../../com/perforce/p4java/ant/tasks/PerforceTask.html" title="class in com.perforce.p4java.ant.tasks">PerforceTask</A></CODE></DL> </DD> <DD><DL> <DT><B>Throws:</B> <DD><CODE>org.apache.tools.ant.BuildException</CODE> - the build exception<DT><B>See Also:</B><DD><A HREF="../../../../../com/perforce/p4java/ant/tasks/PerforceTask.html#initP4()"><CODE>PerforceTask.initP4()</CODE></A></DL> </DD> </DL> <HR> <A NAME="cleanupP4()"><!-- --></A><H3> cleanupP4</H3> <PRE> protected void <B>cleanupP4</B>() throws org.apache.tools.ant.BuildException</PRE> <DL> <DD>Cleanup the Perforce server instance. <P> <DD><DL> <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../com/perforce/p4java/ant/tasks/PerforceTask.html#cleanupP4()">cleanupP4</A></CODE> in class <CODE><A HREF="../../../../../com/perforce/p4java/ant/tasks/PerforceTask.html" title="class in com.perforce.p4java.ant.tasks">PerforceTask</A></CODE></DL> </DD> <DD><DL> <DT><B>Throws:</B> <DD><CODE>org.apache.tools.ant.BuildException</CODE> - the build exception<DT><B>See Also:</B><DD><A HREF="../../../../../com/perforce/p4java/ant/tasks/PerforceTask.html#cleanupP4()"><CODE>PerforceTask.cleanupP4()</CODE></A></DL> </DD> </DL> <HR> <A NAME="getGlobalOptions()"><!-- --></A><H3> getGlobalOptions</H3> <PRE> protected java.util.Properties <B>getGlobalOptions</B>()</PRE> <DL> <DD>Combine all of the globaloptions specified by the "globaloption" nested elements. <P> <DD><DL> <DT><B>Returns:</B><DD>the properties</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="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/ServerTask.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="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</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> </EM> </TD> </TR> <TR> <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> <A HREF="../../../../../com/perforce/p4java/ant/tasks/RevertTask.html" title="class in com.perforce.p4java.ant.tasks"><B>PREV CLASS</B></A> <A HREF="../../../../../com/perforce/p4java/ant/tasks/ServerTask.GlobalOption.html" title="class in com.perforce.p4java.ant.tasks"><B>NEXT CLASS</B></A></FONT></TD> <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> <A HREF="../../../../../index.html?com/perforce/p4java/ant/tasks/ServerTask.html" target="_top"><B>FRAMES</B></A> <A HREF="ServerTask.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: <A HREF="#nested_class_summary">NESTED</A> | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> DETAIL: <A HREF="#field_detail">FIELD</A> | <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>Copyright (c) 2010 Perforce Software. All rights reserved.</i> </BODY> </HTML>