<!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> ShelveTask (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="ShelveTask (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/ShelveTask.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/ServerTask.GlobalOption.html" title="class in com.perforce.p4java.ant.tasks"><B>PREV CLASS</B></A> <A HREF="../../../../../com/perforce/p4java/ant/tasks/SubmitTask.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/ShelveTask.html" target="_top"><B>FRAMES</B></A> <A HREF="ShelveTask.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_classes_inherited_from_class_com.perforce.p4java.ant.tasks.ServerTask">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 ShelveTask</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 "><A HREF="../../../../../com/perforce/p4java/ant/tasks/ServerTask.html" title="class in com.perforce.p4java.ant.tasks">com.perforce.p4java.ant.tasks.ServerTask</A> <IMG SRC="../../../../../resources/inherit.gif" ALT="extended by "><A HREF="../../../../../com/perforce/p4java/ant/tasks/ClientTask.html" title="class in com.perforce.p4java.ant.tasks">com.perforce.p4java.ant.tasks.ClientTask</A> <IMG SRC="../../../../../resources/inherit.gif" ALT="extended by "><B>com.perforce.p4java.ant.tasks.ShelveTask</B> </PRE> <DL> <DT><B>All Implemented Interfaces:</B> <DD>java.lang.Cloneable</DD> </DL> <HR> <DL> <DT><PRE>public class <B>ShelveTask</B><DT>extends <A HREF="../../../../../com/perforce/p4java/ant/tasks/ClientTask.html" title="class in com.perforce.p4java.ant.tasks">ClientTask</A></DL> </PRE> <P> Store files from a pending changelist in the depot, without submitting them. </p> 'p4 shelve' creates, modifies or deletes shelved files in a pending changelist. Shelved files persist in the depot until they are deleted (using 'p4 shelve -d') or replaced by subsequent shelve commands. After 'p4 shelve', the user can revert the files and restore them later using 'p4 unshelve'. Other users can 'p4 unshelve' the stored files into their own workspaces. </p> Files that have been shelved can be accessed by the 'p4 diff', 'p4 diff2', 'p4 files' and 'p4 print' commands using the revision specification '@=change', where 'change' is the pending changelist number. </p> By default, 'p4 shelve' creates a changelist, adds files from the user's default changelist then shelves those files into the depot. The user is presented with a changelist form in the user's text editor that is configured for editing Perforce specifications. </p> If a file pattern is specified, 'p4 shelve' limits the list of files to those matching the pattern. </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>, <A HREF="../../../../../com/perforce/p4java/ant/tasks/ClientTask.html" title="class in com.perforce.p4java.ant.tasks"><CODE>ClientTask</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> </TABLE> <A NAME="nested_classes_inherited_from_class_com.perforce.p4java.ant.tasks.ServerTask"><!-- --></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/ServerTask.html" title="class in com.perforce.p4java.ant.tasks">ServerTask</A></B></TH> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD><CODE><A HREF="../../../../../com/perforce/p4java/ant/tasks/ServerTask.GlobalOption.html" title="class in com.perforce.p4java.ant.tasks">ServerTask.GlobalOption</A></CODE></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 java.lang.String</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../../com/perforce/p4java/ant/tasks/ShelveTask.html#changelist">changelist</A></B></CODE> <BR> The pending changelist that contains shelved files to be created, deleted, or modified.</TD> </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/ShelveTask.html#deleteFiles">deleteFiles</A></B></CODE> <BR> If true, delete incoming files from the shelve.</TD> </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/ShelveTask.html#forceShelve">forceShelve</A></B></CODE> <BR> If true, force the shelve operation.</TD> </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/ShelveTask.html#replaceFiles">replaceFiles</A></B></CODE> <BR> If true, allow the incoming files to replace the shelved files.</TD> </TR> </TABLE> <A NAME="fields_inherited_from_class_com.perforce.p4java.ant.tasks.ClientTask"><!-- --></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/ClientTask.html" title="class in com.perforce.p4java.ant.tasks">ClientTask</A></B></TH> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD><CODE><A HREF="../../../../../com/perforce/p4java/ant/tasks/ClientTask.html#p4Client">p4Client</A></CODE></TD> </TR> </TABLE> <A NAME="fields_inherited_from_class_com.perforce.p4java.ant.tasks.ServerTask"><!-- --></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/ServerTask.html" title="class in com.perforce.p4java.ant.tasks">ServerTask</A></B></TH> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD><CODE><A HREF="../../../../../com/perforce/p4java/ant/tasks/ServerTask.html#allHosts">allHosts</A>, <A HREF="../../../../../com/perforce/p4java/ant/tasks/ServerTask.html#commandOptions">commandOptions</A>, <A HREF="../../../../../com/perforce/p4java/ant/tasks/ServerTask.html#globaloptions">globaloptions</A>, <A HREF="../../../../../com/perforce/p4java/ant/tasks/ServerTask.html#hostName">hostName</A>, <A HREF="../../../../../com/perforce/p4java/ant/tasks/ServerTask.html#P4_SERVER_PROTOCOL_PROPERTIES_FILE">P4_SERVER_PROTOCOL_PROPERTIES_FILE</A>, <A HREF="../../../../../com/perforce/p4java/ant/tasks/ServerTask.html#P4_SERVER_USAGE_PROPERTIES_FILE">P4_SERVER_USAGE_PROPERTIES_FILE</A>, <A HREF="../../../../../com/perforce/p4java/ant/tasks/ServerTask.html#p4Server">p4Server</A>, <A HREF="../../../../../com/perforce/p4java/ant/tasks/ServerTask.html#programName">programName</A>, <A HREF="../../../../../com/perforce/p4java/ant/tasks/ServerTask.html#programVersion">programVersion</A>, <A HREF="../../../../../com/perforce/p4java/ant/tasks/ServerTask.html#protocolPropertiesFile">protocolPropertiesFile</A>, <A HREF="../../../../../com/perforce/p4java/ant/tasks/ServerTask.html#protocolProps">protocolProps</A>, <A HREF="../../../../../com/perforce/p4java/ant/tasks/ServerTask.html#textLanguage">textLanguage</A>, <A HREF="../../../../../com/perforce/p4java/ant/tasks/ServerTask.html#unsetClientName">unsetClientName</A>, <A HREF="../../../../../com/perforce/p4java/ant/tasks/ServerTask.html#unsetUserName">unsetUserName</A>, <A HREF="../../../../../com/perforce/p4java/ant/tasks/ServerTask.html#usagePropertiesFile">usagePropertiesFile</A>, <A HREF="../../../../../com/perforce/p4java/ant/tasks/ServerTask.html#usageProps">usageProps</A>, <A HREF="../../../../../com/perforce/p4java/ant/tasks/ServerTask.html#workingDirectory">workingDirectory</A></CODE></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/ShelveTask.html#ShelveTask()">ShelveTask</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/ShelveTask.html#execP4Command()">execP4Command</A></B>()</CODE> <BR> Execute the Perforce shelve command with file specs, changelist and 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/ShelveTask.html#setChangelist(java.lang.String)">setChangelist</A></B>(java.lang.String changelist)</CODE> <BR> Sets the changelist.</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/ShelveTask.html#setDeleteFiles(boolean)">setDeleteFiles</A></B>(boolean deleteFiles)</CODE> <BR> Sets the delete files.</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/ShelveTask.html#setForceShelve(boolean)">setForceShelve</A></B>(boolean forceShelve)</CODE> <BR> Sets the force shelve.</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/ShelveTask.html#setReplaceFiles(boolean)">setReplaceFiles</A></B>(boolean replaceFiles)</CODE> <BR> Sets the replace files.</TD> </TR> </TABLE> <A NAME="methods_inherited_from_class_com.perforce.p4java.ant.tasks.ClientTask"><!-- --></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/ClientTask.html" title="class in com.perforce.p4java.ant.tasks">ClientTask</A></B></TH> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD><CODE><A HREF="../../../../../com/perforce/p4java/ant/tasks/ClientTask.html#cleanupP4()">cleanupP4</A>, <A HREF="../../../../../com/perforce/p4java/ant/tasks/ClientTask.html#getP4Client()">getP4Client</A>, <A HREF="../../../../../com/perforce/p4java/ant/tasks/ClientTask.html#initP4()">initP4</A>, <A HREF="../../../../../com/perforce/p4java/ant/tasks/ClientTask.html#setP4Client(IClient)">setP4Client</A></CODE></TD> </TR> </TABLE> <A NAME="methods_inherited_from_class_com.perforce.p4java.ant.tasks.ServerTask"><!-- --></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/ServerTask.html" title="class in com.perforce.p4java.ant.tasks">ServerTask</A></B></TH> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD><CODE><A HREF="../../../../../com/perforce/p4java/ant/tasks/ServerTask.html#cleanupP4Server()">cleanupP4Server</A>, <A HREF="../../../../../com/perforce/p4java/ant/tasks/ServerTask.html#createGlobalOption()">createGlobalOption</A>, <A HREF="../../../../../com/perforce/p4java/ant/tasks/ServerTask.html#getGlobalOptions()">getGlobalOptions</A>, <A HREF="../../../../../com/perforce/p4java/ant/tasks/ServerTask.html#getP4Server()">getP4Server</A>, <A HREF="../../../../../com/perforce/p4java/ant/tasks/ServerTask.html#initP4Server()">initP4Server</A>, <A HREF="../../../../../com/perforce/p4java/ant/tasks/ServerTask.html#initP4ServerOptions()">initP4ServerOptions</A>, <A HREF="../../../../../com/perforce/p4java/ant/tasks/ServerTask.html#setAllHosts(boolean)">setAllHosts</A>, <A HREF="../../../../../com/perforce/p4java/ant/tasks/ServerTask.html#setHostName(java.lang.String)">setHostName</A>, <A HREF="../../../../../com/perforce/p4java/ant/tasks/ServerTask.html#setP4Server(IOptionsServer)">setP4Server</A>, <A HREF="../../../../../com/perforce/p4java/ant/tasks/ServerTask.html#setProgramName(java.lang.String)">setProgramName</A>, <A HREF="../../../../../com/perforce/p4java/ant/tasks/ServerTask.html#setProgramVersion(java.lang.String)">setProgramVersion</A>, <A HREF="../../../../../com/perforce/p4java/ant/tasks/ServerTask.html#setProtocolPropertiesFile(java.lang.String)">setProtocolPropertiesFile</A>, <A HREF="../../../../../com/perforce/p4java/ant/tasks/ServerTask.html#setProtocolProps(java.util.Properties)">setProtocolProps</A>, <A HREF="../../../../../com/perforce/p4java/ant/tasks/ServerTask.html#setTextLanguage(java.lang.String)">setTextLanguage</A>, <A HREF="../../../../../com/perforce/p4java/ant/tasks/ServerTask.html#setUnsetClientName(java.lang.String)">setUnsetClientName</A>, <A HREF="../../../../../com/perforce/p4java/ant/tasks/ServerTask.html#setUnsetUserName(java.lang.String)">setUnsetUserName</A>, <A HREF="../../../../../com/perforce/p4java/ant/tasks/ServerTask.html#setUsagePropertiesFile(java.lang.String)">setUsagePropertiesFile</A>, <A HREF="../../../../../com/perforce/p4java/ant/tasks/ServerTask.html#setUsageProps(java.util.Properties)">setUsageProps</A>, <A HREF="../../../../../com/perforce/p4java/ant/tasks/ServerTask.html#setWorkingDirectory(java.lang.String)">setWorkingDirectory</A></CODE></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#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="changelist"><!-- --></A><H3> changelist</H3> <PRE> protected java.lang.String <B>changelist</B></PRE> <DL> <DD>The pending changelist that contains shelved files to be created, deleted, or modified. <P> <DL> </DL> </DL> <HR> <A NAME="forceShelve"><!-- --></A><H3> forceShelve</H3> <PRE> protected boolean <B>forceShelve</B></PRE> <DL> <DD>If true, force the shelve operation. <P> <DL> </DL> </DL> <HR> <A NAME="replaceFiles"><!-- --></A><H3> replaceFiles</H3> <PRE> protected boolean <B>replaceFiles</B></PRE> <DL> <DD>If true, allow the incoming files to replace the shelved files. <P> <DL> </DL> </DL> <HR> <A NAME="deleteFiles"><!-- --></A><H3> deleteFiles</H3> <PRE> protected boolean <B>deleteFiles</B></PRE> <DL> <DD>If true, delete incoming files from the shelve. <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="ShelveTask()"><!-- --></A><H3> ShelveTask</H3> <PRE> public <B>ShelveTask</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="setChangelist(java.lang.String)"><!-- --></A><H3> setChangelist</H3> <PRE> public void <B>setChangelist</B>(java.lang.String changelist)</PRE> <DL> <DD>Sets the changelist. <P> <DD><DL> <DT><B>Parameters:</B><DD><CODE>changelist</CODE> - the new changelist</DL> </DD> </DL> <HR> <A NAME="setForceShelve(boolean)"><!-- --></A><H3> setForceShelve</H3> <PRE> public void <B>setForceShelve</B>(boolean forceShelve)</PRE> <DL> <DD>Sets the force shelve. <P> <DD><DL> <DT><B>Parameters:</B><DD><CODE>forceShelve</CODE> - the new force shelve</DL> </DD> </DL> <HR> <A NAME="setReplaceFiles(boolean)"><!-- --></A><H3> setReplaceFiles</H3> <PRE> public void <B>setReplaceFiles</B>(boolean replaceFiles)</PRE> <DL> <DD>Sets the replace files. <P> <DD><DL> <DT><B>Parameters:</B><DD><CODE>replaceFiles</CODE> - the new replace files</DL> </DD> </DL> <HR> <A NAME="setDeleteFiles(boolean)"><!-- --></A><H3> setDeleteFiles</H3> <PRE> public void <B>setDeleteFiles</B>(boolean deleteFiles)</PRE> <DL> <DD>Sets the delete files. <P> <DD><DL> <DT><B>Parameters:</B><DD><CODE>deleteFiles</CODE> - the new delete files</DL> </DD> </DL> <HR> <A NAME="execP4Command()"><!-- --></A><H3> execP4Command</H3> <PRE> protected void <B>execP4Command</B>() throws org.apache.tools.ant.BuildException</PRE> <DL> <DD>Execute the Perforce shelve command with file specs, changelist and options. Log the returned file specs. <p> Shelve files in a changelist. Store them on the Perforce server without committing them. <P> <DD><DL> <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../com/perforce/p4java/ant/tasks/PerforceTask.html#execP4Command()">execP4Command</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#execP4Command()"><CODE>PerforceTask.execP4Command()</CODE></A></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/ShelveTask.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/ServerTask.GlobalOption.html" title="class in com.perforce.p4java.ant.tasks"><B>PREV CLASS</B></A> <A HREF="../../../../../com/perforce/p4java/ant/tasks/SubmitTask.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/ShelveTask.html" target="_top"><B>FRAMES</B></A> <A HREF="ShelveTask.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_classes_inherited_from_class_com.perforce.p4java.ant.tasks.ServerTask">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>