Edit C:\apache-ant-1.8.0\docs\manual\api\org\apache\tools\ant\taskdefs\optional\perforce\P4Base.html
<!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_22) on Mon Feb 01 19:35:50 EST 2010 --> <TITLE> P4Base (Apache Ant API) </TITLE> <META NAME="keywords" CONTENT="org.apache.tools.ant.taskdefs.optional.perforce.P4Base class"> <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../../../stylesheet.css" TITLE="Style"> <SCRIPT type="text/javascript"> function windowTitle() { parent.document.title="P4Base (Apache Ant 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="../../../../../../../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="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="../../../../../../../org/apache/tools/ant/taskdefs/optional/perforce/P4Add.html" title="class in org.apache.tools.ant.taskdefs.optional.perforce"><B>PREV CLASS</B></A> <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/perforce/P4Change.html" title="class in org.apache.tools.ant.taskdefs.optional.perforce"><B>NEXT CLASS</B></A></FONT></TD> <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> <A HREF="../../../../../../../index.html?org/apache/tools/ant/taskdefs/optional/perforce/P4Base.html" target="_top"><B>FRAMES</B></A> <A HREF="P4Base.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 | <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"> org.apache.tools.ant.taskdefs.optional.perforce</FONT> <BR> Class P4Base</H2> <PRE> java.lang.Object <IMG SRC="../../../../../../../resources/inherit.gif" ALT="extended by "><A HREF="../../../../../../../org/apache/tools/ant/ProjectComponent.html" title="class in org.apache.tools.ant">org.apache.tools.ant.ProjectComponent</A> <IMG SRC="../../../../../../../resources/inherit.gif" ALT="extended by "><A HREF="../../../../../../../org/apache/tools/ant/Task.html" title="class in org.apache.tools.ant">org.apache.tools.ant.Task</A> <IMG SRC="../../../../../../../resources/inherit.gif" ALT="extended by "><B>org.apache.tools.ant.taskdefs.optional.perforce.P4Base</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="../../../../../../../org/apache/tools/ant/taskdefs/optional/perforce/P4Add.html" title="class in org.apache.tools.ant.taskdefs.optional.perforce">P4Add</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/perforce/P4Change.html" title="class in org.apache.tools.ant.taskdefs.optional.perforce">P4Change</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/perforce/P4Counter.html" title="class in org.apache.tools.ant.taskdefs.optional.perforce">P4Counter</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/perforce/P4Delete.html" title="class in org.apache.tools.ant.taskdefs.optional.perforce">P4Delete</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/perforce/P4Edit.html" title="class in org.apache.tools.ant.taskdefs.optional.perforce">P4Edit</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/perforce/P4Fstat.html" title="class in org.apache.tools.ant.taskdefs.optional.perforce">P4Fstat</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/perforce/P4Have.html" title="class in org.apache.tools.ant.taskdefs.optional.perforce">P4Have</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/perforce/P4Integrate.html" title="class in org.apache.tools.ant.taskdefs.optional.perforce">P4Integrate</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/perforce/P4Label.html" title="class in org.apache.tools.ant.taskdefs.optional.perforce">P4Label</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/perforce/P4Labelsync.html" title="class in org.apache.tools.ant.taskdefs.optional.perforce">P4Labelsync</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/perforce/P4Reopen.html" title="class in org.apache.tools.ant.taskdefs.optional.perforce">P4Reopen</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/perforce/P4Resolve.html" title="class in org.apache.tools.ant.taskdefs.optional.perforce">P4Resolve</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/perforce/P4Revert.html" title="class in org.apache.tools.ant.taskdefs.optional.perforce">P4Revert</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/perforce/P4Submit.html" title="class in org.apache.tools.ant.taskdefs.optional.perforce">P4Submit</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/perforce/P4Sync.html" title="class in org.apache.tools.ant.taskdefs.optional.perforce">P4Sync</A></DD> </DL> <HR> <DL> <DT><PRE>public abstract class <B>P4Base</B><DT>extends <A HREF="../../../../../../../org/apache/tools/ant/Task.html" title="class in org.apache.tools.ant">Task</A></DL> </PRE> <P> Base class for Perforce (P4) ANT tasks. See individual task for example usage. <P> <P> <DL> <DT><B>See Also:</B><DD><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/perforce/P4Sync.html" title="class in org.apache.tools.ant.taskdefs.optional.perforce"><CODE>P4Sync</CODE></A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/perforce/P4Have.html" title="class in org.apache.tools.ant.taskdefs.optional.perforce"><CODE>P4Have</CODE></A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/perforce/P4Change.html" title="class in org.apache.tools.ant.taskdefs.optional.perforce"><CODE>P4Change</CODE></A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/perforce/P4Edit.html" title="class in org.apache.tools.ant.taskdefs.optional.perforce"><CODE>P4Edit</CODE></A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/perforce/P4Submit.html" title="class in org.apache.tools.ant.taskdefs.optional.perforce"><CODE>P4Submit</CODE></A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/perforce/P4Label.html" title="class in org.apache.tools.ant.taskdefs.optional.perforce"><CODE>P4Label</CODE></A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/Execute.html" title="class in org.apache.tools.ant.taskdefs"><CODE>Execute</CODE></A></DL> <HR> <P> <!-- =========== 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="../../../../../../../org/apache/tools/ant/taskdefs/optional/perforce/P4Base.html#failOnError">failOnError</A></B></CODE> <BR> Keep going or fail on error - defaults to fail.</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="../../../../../../../org/apache/tools/ant/taskdefs/optional/perforce/P4Base.html#P4Client">P4Client</A></B></CODE> <BR> Perforce Client (eg myclientspec)</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="../../../../../../../org/apache/tools/ant/taskdefs/optional/perforce/P4Base.html#P4CmdOpts">P4CmdOpts</A></B></CODE> <BR> Perforce command opts.</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="../../../../../../../org/apache/tools/ant/taskdefs/optional/perforce/P4Base.html#P4Opts">P4Opts</A></B></CODE> <BR> Perforce 'global' opts.</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="../../../../../../../org/apache/tools/ant/taskdefs/optional/perforce/P4Base.html#P4Port">P4Port</A></B></CODE> <BR> Perforce Server Port (eg KM01:1666)</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="../../../../../../../org/apache/tools/ant/taskdefs/optional/perforce/P4Base.html#P4User">P4User</A></B></CODE> <BR> Perforce User (eg fbloggs)</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="../../../../../../../org/apache/tools/ant/taskdefs/optional/perforce/P4Base.html#P4View">P4View</A></B></CODE> <BR> Perforce view for commands.</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="../../../../../../../org/apache/tools/ant/taskdefs/optional/perforce/P4Base.html#shell">shell</A></B></CODE> <BR> The OS shell to use (cmd.exe or /bin/sh)</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE>protected org.apache.oro.text.perl.Perl5Util</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/perforce/P4Base.html#util">util</A></B></CODE> <BR> Perl5 regexp in Java - cool eh?</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.<A HREF="../../../../../../../org/apache/tools/ant/Task.html" title="class in org.apache.tools.ant">Task</A></B></TH> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD><CODE><A HREF="../../../../../../../org/apache/tools/ant/Task.html#target">target</A>, <A HREF="../../../../../../../org/apache/tools/ant/Task.html#taskName">taskName</A>, <A HREF="../../../../../../../org/apache/tools/ant/Task.html#taskType">taskType</A>, <A HREF="../../../../../../../org/apache/tools/ant/Task.html#wrapper">wrapper</A></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.<A HREF="../../../../../../../org/apache/tools/ant/ProjectComponent.html" title="class in org.apache.tools.ant">ProjectComponent</A></B></TH> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD><CODE><A HREF="../../../../../../../org/apache/tools/ant/ProjectComponent.html#description">description</A>, <A HREF="../../../../../../../org/apache/tools/ant/ProjectComponent.html#location">location</A>, <A HREF="../../../../../../../org/apache/tools/ant/ProjectComponent.html#project">project</A></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="../../../../../../../org/apache/tools/ant/taskdefs/optional/perforce/P4Base.html#P4Base()">P4Base</A></B>()</CODE> <BR> </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="../../../../../../../org/apache/tools/ant/taskdefs/optional/perforce/P4Base.html#execP4Command(java.lang.String)">execP4Command</A></B>(java.lang.String command)</CODE> <BR> no usages found for this method runs a Perforce command without a handler</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="../../../../../../../org/apache/tools/ant/taskdefs/optional/perforce/P4Base.html#execP4Command(java.lang.String, org.apache.tools.ant.taskdefs.optional.perforce.P4Handler)">execP4Command</A></B>(java.lang.String command, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/perforce/P4Handler.html" title="interface in org.apache.tools.ant.taskdefs.optional.perforce">P4Handler</A> handler)</CODE> <BR> Execute P4 command assembled by subclasses.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> java.lang.String</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/perforce/P4Base.html#getErrorMessage()">getErrorMessage</A></B>()</CODE> <BR> gets the error message recorded by the Perforce handler</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> boolean</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/perforce/P4Base.html#getInError()">getInError</A></B>()</CODE> <BR> gets whether or not the task has encountered an error</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="../../../../../../../org/apache/tools/ant/taskdefs/optional/perforce/P4Base.html#init()">init</A></B>()</CODE> <BR> sets attributes Port, Client, User from properties if these properties are defined.</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="../../../../../../../org/apache/tools/ant/taskdefs/optional/perforce/P4Base.html#setClient(java.lang.String)">setClient</A></B>(java.lang.String p4Client)</CODE> <BR> The p4 client spec to use; optional, defaults to the current 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="../../../../../../../org/apache/tools/ant/taskdefs/optional/perforce/P4Base.html#setCmdopts(java.lang.String)">setCmdopts</A></B>(java.lang.String p4CmdOpts)</CODE> <BR> Set extra command options; only used on some of the Perforce tasks.</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="../../../../../../../org/apache/tools/ant/taskdefs/optional/perforce/P4Base.html#setErrorMessage(java.lang.String)">setErrorMessage</A></B>(java.lang.String errorMessage)</CODE> <BR> sets the error message</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="../../../../../../../org/apache/tools/ant/taskdefs/optional/perforce/P4Base.html#setFailonerror(boolean)">setFailonerror</A></B>(boolean fail)</CODE> <BR> whether to stop the build (true, default) or keep going if an error is returned from the p4 command</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="../../../../../../../org/apache/tools/ant/taskdefs/optional/perforce/P4Base.html#setGlobalopts(java.lang.String)">setGlobalopts</A></B>(java.lang.String p4Opts)</CODE> <BR> Set global P4 options; Used on all of the Perforce tasks.</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="../../../../../../../org/apache/tools/ant/taskdefs/optional/perforce/P4Base.html#setInError(boolean)">setInError</A></B>(boolean inError)</CODE> <BR> sets the error flag on the task</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="../../../../../../../org/apache/tools/ant/taskdefs/optional/perforce/P4Base.html#setPort(java.lang.String)">setPort</A></B>(java.lang.String p4Port)</CODE> <BR> The p4d server and port to connect to; optional, default "perforce:1666"</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="../../../../../../../org/apache/tools/ant/taskdefs/optional/perforce/P4Base.html#setUser(java.lang.String)">setUser</A></B>(java.lang.String p4User)</CODE> <BR> The p4 username; optional, defaults to the current 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="../../../../../../../org/apache/tools/ant/taskdefs/optional/perforce/P4Base.html#setView(java.lang.String)">setView</A></B>(java.lang.String p4View)</CODE> <BR> The client, branch or label view to operate upon; optional default "//...".</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.<A HREF="../../../../../../../org/apache/tools/ant/Task.html" title="class in org.apache.tools.ant">Task</A></B></TH> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD><CODE><A HREF="../../../../../../../org/apache/tools/ant/Task.html#bindToOwner(org.apache.tools.ant.Task)">bindToOwner</A>, <A HREF="../../../../../../../org/apache/tools/ant/Task.html#execute()">execute</A>, <A HREF="../../../../../../../org/apache/tools/ant/Task.html#getOwningTarget()">getOwningTarget</A>, <A HREF="../../../../../../../org/apache/tools/ant/Task.html#getRuntimeConfigurableWrapper()">getRuntimeConfigurableWrapper</A>, <A HREF="../../../../../../../org/apache/tools/ant/Task.html#getTaskName()">getTaskName</A>, <A HREF="../../../../../../../org/apache/tools/ant/Task.html#getTaskType()">getTaskType</A>, <A HREF="../../../../../../../org/apache/tools/ant/Task.html#getWrapper()">getWrapper</A>, <A HREF="../../../../../../../org/apache/tools/ant/Task.html#handleErrorFlush(java.lang.String)">handleErrorFlush</A>, <A HREF="../../../../../../../org/apache/tools/ant/Task.html#handleErrorOutput(java.lang.String)">handleErrorOutput</A>, <A HREF="../../../../../../../org/apache/tools/ant/Task.html#handleFlush(java.lang.String)">handleFlush</A>, <A HREF="../../../../../../../org/apache/tools/ant/Task.html#handleInput(byte[], int, int)">handleInput</A>, <A HREF="../../../../../../../org/apache/tools/ant/Task.html#handleOutput(java.lang.String)">handleOutput</A>, <A HREF="../../../../../../../org/apache/tools/ant/Task.html#isInvalid()">isInvalid</A>, <A HREF="../../../../../../../org/apache/tools/ant/Task.html#log(java.lang.String)">log</A>, <A HREF="../../../../../../../org/apache/tools/ant/Task.html#log(java.lang.String, int)">log</A>, <A HREF="../../../../../../../org/apache/tools/ant/Task.html#log(java.lang.String, java.lang.Throwable, int)">log</A>, <A HREF="../../../../../../../org/apache/tools/ant/Task.html#log(java.lang.Throwable, int)">log</A>, <A HREF="../../../../../../../org/apache/tools/ant/Task.html#maybeConfigure()">maybeConfigure</A>, <A HREF="../../../../../../../org/apache/tools/ant/Task.html#perform()">perform</A>, <A HREF="../../../../../../../org/apache/tools/ant/Task.html#reconfigure()">reconfigure</A>, <A HREF="../../../../../../../org/apache/tools/ant/Task.html#setOwningTarget(org.apache.tools.ant.Target)">setOwningTarget</A>, <A HREF="../../../../../../../org/apache/tools/ant/Task.html#setRuntimeConfigurableWrapper(org.apache.tools.ant.RuntimeConfigurable)">setRuntimeConfigurableWrapper</A>, <A HREF="../../../../../../../org/apache/tools/ant/Task.html#setTaskName(java.lang.String)">setTaskName</A>, <A HREF="../../../../../../../org/apache/tools/ant/Task.html#setTaskType(java.lang.String)">setTaskType</A></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.<A HREF="../../../../../../../org/apache/tools/ant/ProjectComponent.html" title="class in org.apache.tools.ant">ProjectComponent</A></B></TH> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD><CODE><A HREF="../../../../../../../org/apache/tools/ant/ProjectComponent.html#clone()">clone</A>, <A HREF="../../../../../../../org/apache/tools/ant/ProjectComponent.html#getDescription()">getDescription</A>, <A HREF="../../../../../../../org/apache/tools/ant/ProjectComponent.html#getLocation()">getLocation</A>, <A HREF="../../../../../../../org/apache/tools/ant/ProjectComponent.html#getProject()">getProject</A>, <A HREF="../../../../../../../org/apache/tools/ant/ProjectComponent.html#setDescription(java.lang.String)">setDescription</A>, <A HREF="../../../../../../../org/apache/tools/ant/ProjectComponent.html#setLocation(org.apache.tools.ant.Location)">setLocation</A>, <A HREF="../../../../../../../org/apache/tools/ant/ProjectComponent.html#setProject(org.apache.tools.ant.Project)">setProject</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.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="util"><!-- --></A><H3> util</H3> <PRE> protected org.apache.oro.text.perl.Perl5Util <B>util</B></PRE> <DL> <DD>Perl5 regexp in Java - cool eh? <P> <DL> </DL> </DL> <HR> <A NAME="shell"><!-- --></A><H3> shell</H3> <PRE> protected java.lang.String <B>shell</B></PRE> <DL> <DD>The OS shell to use (cmd.exe or /bin/sh) <P> <DL> </DL> </DL> <HR> <A NAME="P4Port"><!-- --></A><H3> P4Port</H3> <PRE> protected java.lang.String <B>P4Port</B></PRE> <DL> <DD>Perforce Server Port (eg KM01:1666) <P> <DL> </DL> </DL> <HR> <A NAME="P4Client"><!-- --></A><H3> P4Client</H3> <PRE> protected java.lang.String <B>P4Client</B></PRE> <DL> <DD>Perforce Client (eg myclientspec) <P> <DL> </DL> </DL> <HR> <A NAME="P4User"><!-- --></A><H3> P4User</H3> <PRE> protected java.lang.String <B>P4User</B></PRE> <DL> <DD>Perforce User (eg fbloggs) <P> <DL> </DL> </DL> <HR> <A NAME="P4View"><!-- --></A><H3> P4View</H3> <PRE> protected java.lang.String <B>P4View</B></PRE> <DL> <DD>Perforce view for commands. (eg //projects/foobar/main/source/... ) <P> <DL> </DL> </DL> <HR> <A NAME="failOnError"><!-- --></A><H3> failOnError</H3> <PRE> protected boolean <B>failOnError</B></PRE> <DL> <DD>Keep going or fail on error - defaults to fail. <P> <DL> </DL> </DL> <HR> <A NAME="P4Opts"><!-- --></A><H3> P4Opts</H3> <PRE> protected java.lang.String <B>P4Opts</B></PRE> <DL> <DD>Perforce 'global' opts. Forms half of low level API <P> <DL> </DL> </DL> <HR> <A NAME="P4CmdOpts"><!-- --></A><H3> P4CmdOpts</H3> <PRE> protected java.lang.String <B>P4CmdOpts</B></PRE> <DL> <DD>Perforce command opts. Forms half of low level API <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="P4Base()"><!-- --></A><H3> P4Base</H3> <PRE> public <B>P4Base</B>()</PRE> <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="getInError()"><!-- --></A><H3> getInError</H3> <PRE> public boolean <B>getInError</B>()</PRE> <DL> <DD>gets whether or not the task has encountered an error <P> <DD><DL> <DT><B>Returns:</B><DD>error flag<DT><B>Since:</B></DT> <DD>ant 1.6</DD> </DL> </DD> </DL> <HR> <A NAME="setInError(boolean)"><!-- --></A><H3> setInError</H3> <PRE> public void <B>setInError</B>(boolean inError)</PRE> <DL> <DD>sets the error flag on the task <P> <DD><DL> <DT><B>Parameters:</B><DD><CODE>inError</CODE> - if true an error has been encountered by the handler<DT><B>Since:</B></DT> <DD>ant 1.6</DD> </DL> </DD> </DL> <HR> <A NAME="getErrorMessage()"><!-- --></A><H3> getErrorMessage</H3> <PRE> public java.lang.String <B>getErrorMessage</B>()</PRE> <DL> <DD>gets the error message recorded by the Perforce handler <P> <DD><DL> <DT><B>Returns:</B><DD>error message</DL> </DD> </DL> <HR> <A NAME="setErrorMessage(java.lang.String)"><!-- --></A><H3> setErrorMessage</H3> <PRE> public void <B>setErrorMessage</B>(java.lang.String errorMessage)</PRE> <DL> <DD>sets the error message <P> <DD><DL> <DT><B>Parameters:</B><DD><CODE>errorMessage</CODE> - line of error output</DL> </DD> </DL> <HR> <A NAME="setPort(java.lang.String)"><!-- --></A><H3> setPort</H3> <PRE> public void <B>setPort</B>(java.lang.String p4Port)</PRE> <DL> <DD>The p4d server and port to connect to; optional, default "perforce:1666" <P> <DD><DL> <DT><B>Parameters:</B><DD><CODE>p4Port</CODE> - the port one wants to set such as localhost:1666</DL> </DD> </DL> <HR> <A NAME="setClient(java.lang.String)"><!-- --></A><H3> setClient</H3> <PRE> public void <B>setClient</B>(java.lang.String p4Client)</PRE> <DL> <DD>The p4 client spec to use; optional, defaults to the current user <P> <DD><DL> <DT><B>Parameters:</B><DD><CODE>p4Client</CODE> - the name of the Perforce client spec</DL> </DD> </DL> <HR> <A NAME="setUser(java.lang.String)"><!-- --></A><H3> setUser</H3> <PRE> public void <B>setUser</B>(java.lang.String p4User)</PRE> <DL> <DD>The p4 username; optional, defaults to the current user <P> <DD><DL> <DT><B>Parameters:</B><DD><CODE>p4User</CODE> - the user name</DL> </DD> </DL> <HR> <A NAME="setGlobalopts(java.lang.String)"><!-- --></A><H3> setGlobalopts</H3> <PRE> public void <B>setGlobalopts</B>(java.lang.String p4Opts)</PRE> <DL> <DD>Set global P4 options; Used on all of the Perforce tasks. <P> <DD><DL> <DT><B>Parameters:</B><DD><CODE>p4Opts</CODE> - global options, to use a specific P4Config file for instance</DL> </DD> </DL> <HR> <A NAME="setView(java.lang.String)"><!-- --></A><H3> setView</H3> <PRE> public void <B>setView</B>(java.lang.String p4View)</PRE> <DL> <DD>The client, branch or label view to operate upon; optional default "//...". the view is required for the following tasks : <ul> <li>p4delete</li> <li>p4edit</li> <li>p4reopen</li> <li>p4resolve</li> </ul> <P> <DD><DL> <DT><B>Parameters:</B><DD><CODE>p4View</CODE> - the view one wants to use</DL> </DD> </DL> <HR> <A NAME="setCmdopts(java.lang.String)"><!-- --></A><H3> setCmdopts</H3> <PRE> public void <B>setCmdopts</B>(java.lang.String p4CmdOpts)</PRE> <DL> <DD>Set extra command options; only used on some of the Perforce tasks. <P> <DD><DL> <DT><B>Parameters:</B><DD><CODE>p4CmdOpts</CODE> - command line options going after the particular Perforce command</DL> </DD> </DL> <HR> <A NAME="setFailonerror(boolean)"><!-- --></A><H3> setFailonerror</H3> <PRE> public void <B>setFailonerror</B>(boolean fail)</PRE> <DL> <DD>whether to stop the build (true, default) or keep going if an error is returned from the p4 command <P> <DD><DL> <DT><B>Parameters:</B><DD><CODE>fail</CODE> - indicates whether one wants to fail the build if an error comes from the Perforce command</DL> </DD> </DL> <HR> <A NAME="init()"><!-- --></A><H3> init</H3> <PRE> public void <B>init</B>()</PRE> <DL> <DD>sets attributes Port, Client, User from properties if these properties are defined. Called automatically by UnknownElement <P> <DD><DL> <DT><B>Overrides:</B><DD><CODE><A HREF="../../../../../../../org/apache/tools/ant/Task.html#init()">init</A></CODE> in class <CODE><A HREF="../../../../../../../org/apache/tools/ant/Task.html" title="class in org.apache.tools.ant">Task</A></CODE></DL> </DD> <DD><DL> <DT><B>See Also:</B><DD><A HREF="../../../../../../../org/apache/tools/ant/UnknownElement.html" title="class in org.apache.tools.ant"><CODE><table> <tr><th>Property</th><th>Attribute</th></tr> <tr><td>p4.port</td><td>Port</td></tr> <tr><td>p4.client</td><td>Client</td></tr> <tr><td>p4.user</td><td>User</td></tr> </table></CODE></A></DL> </DD> </DL> <HR> <A NAME="execP4Command(java.lang.String)"><!-- --></A><H3> execP4Command</H3> <PRE> protected void <B>execP4Command</B>(java.lang.String command) throws <A HREF="../../../../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</A></PRE> <DL> <DD>no usages found for this method runs a Perforce command without a handler <P> <DD><DL> <DT><B>Parameters:</B><DD><CODE>command</CODE> - the command that one wants to execute <DT><B>Throws:</B> <DD><CODE><A HREF="../../../../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</A></CODE> - if failonerror is set and the command fails</DL> </DD> </DL> <HR> <A NAME="execP4Command(java.lang.String, org.apache.tools.ant.taskdefs.optional.perforce.P4Handler)"><!-- --></A><H3> execP4Command</H3> <PRE> protected void <B>execP4Command</B>(java.lang.String command, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/perforce/P4Handler.html" title="interface in org.apache.tools.ant.taskdefs.optional.perforce">P4Handler</A> handler) throws <A HREF="../../../../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</A></PRE> <DL> <DD>Execute P4 command assembled by subclasses. <P> <DD><DL> <DT><B>Parameters:</B><DD><CODE>command</CODE> - The command to run<DD><CODE>handler</CODE> - A P4Handler to process any input and output <DT><B>Throws:</B> <DD><CODE><A HREF="../../../../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</A></CODE> - if failonerror has been set to true</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="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="../../../../../../../org/apache/tools/ant/taskdefs/optional/perforce/P4Add.html" title="class in org.apache.tools.ant.taskdefs.optional.perforce"><B>PREV CLASS</B></A> <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/perforce/P4Change.html" title="class in org.apache.tools.ant.taskdefs.optional.perforce"><B>NEXT CLASS</B></A></FONT></TD> <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> <A HREF="../../../../../../../index.html?org/apache/tools/ant/taskdefs/optional/perforce/P4Base.html" target="_top"><B>FRAMES</B></A> <A HREF="P4Base.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 | <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> </BODY> </HTML>
Ms-Dos/Windows
Unix
Write backup
jsp File Browser version 1.2 by
www.vonloesch.de