source: other-projects/trunk/gs3-release-maker/apache-ant-1.6.5/build/javadocs/org/apache/tools/ant/taskdefs/optional/starteam/StarTeamCheckout.html@ 14627

Last change on this file since 14627 was 14627, checked in by oranfry, 17 years ago

initial import of the gs3-release-maker
File size: 43.7 KB
Line 
1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
2<!--NewPage-->
3<HTML>
4<HEAD>
5<!-- Generated by javadoc (build 1.4.2_13) on Mon Oct 01 14:33:30 NZST 2007 -->
6<TITLE>
7StarTeamCheckout (Apache Ant API)
8</TITLE>
9
10<META NAME="keywords" CONTENT="org.apache.tools.ant.taskdefs.optional.starteam.StarTeamCheckout class">
11
12<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../../../stylesheet.css" TITLE="Style">
13
14<SCRIPT type="text/javascript">
15function windowTitle()
16{
17 parent.document.title="StarTeamCheckout (Apache Ant API)";
18}
19</SCRIPT>
20
21</HEAD>
22
23<BODY BGCOLOR="white" onload="windowTitle();">
24
25
26<!-- ========= START OF TOP NAVBAR ======= -->
27<A NAME="navbar_top"><!-- --></A>
28<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
29<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
30<TR>
31<TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
32<A NAME="navbar_top_firstrow"><!-- --></A>
33<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
34 <TR ALIGN="center" VALIGN="top">
35 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
36 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
37 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
38 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
39 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
40 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
41 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
42 </TR>
43</TABLE>
44</TD>
45<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
46</EM>
47</TD>
48</TR>
49
50<TR>
51<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
52&nbsp;<A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/starteam/StarTeamCheckin.html" title="class in org.apache.tools.ant.taskdefs.optional.starteam"><B>PREV CLASS</B></A>&nbsp;
53&nbsp;<A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/starteam/StarTeamLabel.html" title="class in org.apache.tools.ant.taskdefs.optional.starteam"><B>NEXT CLASS</B></A></FONT></TD>
54<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
55 <A HREF="../../../../../../../index.html" target="_top"><B>FRAMES</B></A> &nbsp;
56&nbsp;<A HREF="StarTeamCheckout.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
57&nbsp;<SCRIPT type="text/javascript">
58 <!--
59 if(window==top) {
60 document.writeln('<A HREF="../../../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
61 }
62 //-->
63</SCRIPT>
64<NOSCRIPT>
65 <A HREF="../../../../../../../allclasses-noframe.html"><B>All Classes</B></A>
66</NOSCRIPT>
67
68</FONT></TD>
69</TR>
70<TR>
71<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
72 SUMMARY:&nbsp;<A HREF="#nested_classes_inherited_from_class_org.apache.tools.ant.taskdefs.optional.starteam.TreeBasedTask">NESTED</A>&nbsp;|&nbsp;<A HREF="#fields_inherited_from_class_org.apache.tools.ant.taskdefs.optional.starteam.TreeBasedTask">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
73<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
74DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
75</TR>
76</TABLE>
77<A NAME="skip-navbar_top"></A>
78<!-- ========= END OF TOP NAVBAR ========= -->
79
80<HR>
81<!-- ======== START OF CLASS DATA ======== -->
82<H2>
83<FONT SIZE="-1">
84org.apache.tools.ant.taskdefs.optional.starteam</FONT>
85<BR>
86Class StarTeamCheckout</H2>
87<PRE>
88java.lang.Object
89 <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>
90 <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>
91 <IMG SRC="../../../../../../../resources/inherit.gif" ALT="extended by"><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/starteam/StarTeamTask.html" title="class in org.apache.tools.ant.taskdefs.optional.starteam">org.apache.tools.ant.taskdefs.optional.starteam.StarTeamTask</A>
92 <IMG SRC="../../../../../../../resources/inherit.gif" ALT="extended by"><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/starteam/TreeBasedTask.html" title="class in org.apache.tools.ant.taskdefs.optional.starteam">org.apache.tools.ant.taskdefs.optional.starteam.TreeBasedTask</A>
93 <IMG SRC="../../../../../../../resources/inherit.gif" ALT="extended by"><B>org.apache.tools.ant.taskdefs.optional.starteam.StarTeamCheckout</B>
94</PRE>
95<HR>
96<DL>
97<DT>public class <B>StarTeamCheckout</B><DT>extends <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/starteam/TreeBasedTask.html" title="class in org.apache.tools.ant.taskdefs.optional.starteam">TreeBasedTask</A></DL>
98
99<P>
100Checks out files from a StarTeam project.
101 It also creates all working directories on the
102 local directory if appropriate. Ant Usage:
103 <pre>
104 &lt;taskdef name="starteamcheckout"
105 classname="org.apache.tools.ant.taskdefs.StarTeamCheckout"/&gt;
106 &lt;starteamcheckout username="BuildMaster" password="ant" starteamFolder="Source"
107 starteamurl="servername:portnum/project/view"
108 createworkingdirectories="true"/&gt;
109 </pre>
110<P>
111
112<P>
113<DL>
114<DT><B>Version:</B></DT>
115 <DD>1.1</DD>
116<DT><B>See Also:</B><DD><A HREF="http://www.starbase.com/">StarBase Web Site</A></DL>
117<HR>
118
119<P>
120<!-- ======== NESTED CLASS SUMMARY ======== -->
121
122<A NAME="nested_class_summary"><!-- --></A>
123<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
124<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
125<TD COLSPAN=2><FONT SIZE="+2">
126<B>Nested Class Summary</B></FONT></TD>
127</TR>
128</TABLE>
129&nbsp;<A NAME="nested_classes_inherited_from_class_org.apache.tools.ant.taskdefs.optional.starteam.TreeBasedTask"><!-- --></A>
130<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
131<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
132<TD><B>Nested classes inherited from class org.apache.tools.ant.taskdefs.optional.starteam.<A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/starteam/TreeBasedTask.html" title="class in org.apache.tools.ant.taskdefs.optional.starteam">TreeBasedTask</A></B></TD>
133</TR>
134<TR BGCOLOR="white" CLASS="TableRowColor">
135<TD><CODE><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/starteam/TreeBasedTask.UnmatchedFileMap.html" title="class in org.apache.tools.ant.taskdefs.optional.starteam">TreeBasedTask.UnmatchedFileMap</A></CODE></TD>
136</TR>
137</TABLE>
138&nbsp;
139<!-- =========== FIELD SUMMARY =========== -->
140
141<A NAME="field_summary"><!-- --></A>
142<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
143<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
144<TD COLSPAN=2><FONT SIZE="+2">
145<B>Field Summary</B></FONT></TD>
146</TR>
147</TABLE>
148&nbsp;<A NAME="fields_inherited_from_class_org.apache.tools.ant.taskdefs.optional.starteam.TreeBasedTask"><!-- --></A>
149<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
150<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
151<TD><B>Fields inherited from class org.apache.tools.ant.taskdefs.optional.starteam.<A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/starteam/TreeBasedTask.html" title="class in org.apache.tools.ant.taskdefs.optional.starteam">TreeBasedTask</A></B></TD>
152</TR>
153<TR BGCOLOR="white" CLASS="TableRowColor">
154<TD><CODE><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/starteam/TreeBasedTask.html#DEFAULT_EXCLUDESETTING">DEFAULT_EXCLUDESETTING</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/starteam/TreeBasedTask.html#DEFAULT_INCLUDESETTING">DEFAULT_INCLUDESETTING</A></CODE></TD>
155</TR>
156</TABLE>
157&nbsp;<A NAME="fields_inherited_from_class_org.apache.tools.ant.Task"><!-- --></A>
158<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
159<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
160<TD><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></TD>
161</TR>
162<TR BGCOLOR="white" CLASS="TableRowColor">
163<TD><CODE><A HREF="../../../../../../../org/apache/tools/ant/Task.html#description">description</A>, <A HREF="../../../../../../../org/apache/tools/ant/Task.html#location">location</A>, <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>
164</TR>
165</TABLE>
166&nbsp;<A NAME="fields_inherited_from_class_org.apache.tools.ant.ProjectComponent"><!-- --></A>
167<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
168<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
169<TD><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></TD>
170</TR>
171<TR BGCOLOR="white" CLASS="TableRowColor">
172<TD><CODE><A HREF="../../../../../../../org/apache/tools/ant/ProjectComponent.html#project">project</A></CODE></TD>
173</TR>
174</TABLE>
175&nbsp;
176<!-- ======== CONSTRUCTOR SUMMARY ======== -->
177
178<A NAME="constructor_summary"><!-- --></A>
179<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
180<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
181<TD COLSPAN=2><FONT SIZE="+2">
182<B>Constructor Summary</B></FONT></TD>
183</TR>
184<TR BGCOLOR="white" CLASS="TableRowColor">
185<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/starteam/StarTeamCheckout.html#StarTeamCheckout()">StarTeamCheckout</A></B>()</CODE>
186
187<BR>
188&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
189</TR>
190</TABLE>
191&nbsp;
192<!-- ========== METHOD SUMMARY =========== -->
193
194<A NAME="method_summary"><!-- --></A>
195<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
196<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
197<TD COLSPAN=2><FONT SIZE="+2">
198<B>Method Summary</B></FONT></TD>
199</TR>
200<TR BGCOLOR="white" CLASS="TableRowColor">
201<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
202<CODE>protected &nbsp;View</CODE></FONT></TD>
203<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/starteam/StarTeamCheckout.html#createSnapshotView(View)">createSnapshotView</A></B>(View&nbsp;raw)</CODE>
204
205<BR>
206&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Override of base-class abstract function creates an
207 appropriately configured view for checkouts - either
208 the current view or a view from this.label or the raw
209 view itself in the case of a revision label.</TD>
210</TR>
211<TR BGCOLOR="white" CLASS="TableRowColor">
212<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
213<CODE>&nbsp;boolean</CODE></FONT></TD>
214<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/starteam/StarTeamCheckout.html#getUseRepositoryTimeStamp()">getUseRepositoryTimeStamp</A></B>()</CODE>
215
216<BR>
217&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;returns the value of the useRepositoryTimestamp member</TD>
218</TR>
219<TR BGCOLOR="white" CLASS="TableRowColor">
220<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
221<CODE>protected &nbsp;void</CODE></FONT></TD>
222<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/starteam/StarTeamCheckout.html#logOperationDescription(Folder, java.io.File)">logOperationDescription</A></B>(Folder&nbsp;starteamrootFolder,
223 java.io.File&nbsp;targetrootFolder)</CODE>
224
225<BR>
226&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;extenders should emit to the log an entry describing the parameters
227 that will be used by this operation.</TD>
228</TR>
229<TR BGCOLOR="white" CLASS="TableRowColor">
230<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
231<CODE>&nbsp;void</CODE></FONT></TD>
232<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/starteam/StarTeamCheckout.html#setAsOfDate(java.lang.String)">setAsOfDate</A></B>(java.lang.String&nbsp;asOfDateParam)</CODE>
233
234<BR>
235&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;List files, dates, and statuses as of this date; optional.</TD>
236</TR>
237<TR BGCOLOR="white" CLASS="TableRowColor">
238<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
239<CODE>&nbsp;void</CODE></FONT></TD>
240<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/starteam/StarTeamCheckout.html#setAsOfDateFormat(java.lang.String)">setAsOfDateFormat</A></B>(java.lang.String&nbsp;asOfDateFormat)</CODE>
241
242<BR>
243&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Date Format with which asOfDate parameter to be parsed; optional.</TD>
244</TR>
245<TR BGCOLOR="white" CLASS="TableRowColor">
246<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
247<CODE>&nbsp;void</CODE></FONT></TD>
248<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/starteam/StarTeamCheckout.html#setConvertEOL(boolean)">setConvertEOL</A></B>(boolean&nbsp;value)</CODE>
249
250<BR>
251&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Set whether or not files should be checked out using the
252 local machine's EOL convention.</TD>
253</TR>
254<TR BGCOLOR="white" CLASS="TableRowColor">
255<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
256<CODE>&nbsp;void</CODE></FONT></TD>
257<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/starteam/StarTeamCheckout.html#setCreateWorkingDirs(boolean)">setCreateWorkingDirs</A></B>(boolean&nbsp;value)</CODE>
258
259<BR>
260&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;flag (defaults to true) to create all directories
261 that are in the Starteam repository even if they are empty.</TD>
262</TR>
263<TR BGCOLOR="white" CLASS="TableRowColor">
264<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
265<CODE>&nbsp;void</CODE></FONT></TD>
266<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/starteam/StarTeamCheckout.html#setDeleteUncontrolled(boolean)">setDeleteUncontrolled</A></B>(boolean&nbsp;value)</CODE>
267
268<BR>
269&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Whether or not all local files <i>not<i> in StarTeam should be deleted.</TD>
270</TR>
271<TR BGCOLOR="white" CLASS="TableRowColor">
272<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
273<CODE>&nbsp;void</CODE></FONT></TD>
274<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/starteam/StarTeamCheckout.html#setLabel(java.lang.String)">setLabel</A></B>(java.lang.String&nbsp;label)</CODE>
275
276<BR>
277&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Sets the label StarTeam is to use for checkout; defaults to the most recent file.</TD>
278</TR>
279<TR BGCOLOR="white" CLASS="TableRowColor">
280<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
281<CODE>&nbsp;void</CODE></FONT></TD>
282<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/starteam/StarTeamCheckout.html#setLocked(boolean)">setLocked</A></B>(boolean&nbsp;v)</CODE>
283
284<BR>
285&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Set to do a locked checkout; optional default is false.</TD>
286</TR>
287<TR BGCOLOR="white" CLASS="TableRowColor">
288<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
289<CODE>&nbsp;void</CODE></FONT></TD>
290<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/starteam/StarTeamCheckout.html#setUnlocked(boolean)">setUnlocked</A></B>(boolean&nbsp;v)</CODE>
291
292<BR>
293&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Set to do an unlocked checkout.</TD>
294</TR>
295<TR BGCOLOR="white" CLASS="TableRowColor">
296<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
297<CODE>&nbsp;void</CODE></FONT></TD>
298<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/starteam/StarTeamCheckout.html#setUseRepositoryTimeStamp(boolean)">setUseRepositoryTimeStamp</A></B>(boolean&nbsp;useRepositoryTimeStamp)</CODE>
299
300<BR>
301&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;sets the useRepositoryTimestmp member.</TD>
302</TR>
303<TR BGCOLOR="white" CLASS="TableRowColor">
304<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
305<CODE>protected &nbsp;void</CODE></FONT></TD>
306<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/starteam/StarTeamCheckout.html#testPreconditions()">testPreconditions</A></B>()</CODE>
307
308<BR>
309&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Implements base-class abstract function to define tests for
310 any preconditons required by the task.</TD>
311</TR>
312<TR BGCOLOR="white" CLASS="TableRowColor">
313<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
314<CODE>protected &nbsp;void</CODE></FONT></TD>
315<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/starteam/StarTeamCheckout.html#visit(Folder, java.io.File)">visit</A></B>(Folder&nbsp;starteamFolder,
316 java.io.File&nbsp;targetFolder)</CODE>
317
318<BR>
319&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Implements base-class abstract function to perform the checkout
320 operation on the files in each folder of the tree.</TD>
321</TR>
322</TABLE>
323&nbsp;<A NAME="methods_inherited_from_class_org.apache.tools.ant.taskdefs.optional.starteam.TreeBasedTask"><!-- --></A>
324<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
325<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
326<TD><B>Methods inherited from class org.apache.tools.ant.taskdefs.optional.starteam.<A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/starteam/TreeBasedTask.html" title="class in org.apache.tools.ant.taskdefs.optional.starteam">TreeBasedTask</A></B></TD>
327</TR>
328<TR BGCOLOR="white" CLASS="TableRowColor">
329<TD><CODE><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/starteam/TreeBasedTask.html#_setAsOfDate(java.lang.String)">_setAsOfDate</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/starteam/TreeBasedTask.html#_setAsOfDateFormat(java.lang.String)">_setAsOfDateFormat</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/starteam/TreeBasedTask.html#_setLabel(java.lang.String)">_setLabel</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/starteam/TreeBasedTask.html#execute()">execute</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/starteam/TreeBasedTask.html#getAsOfDate()">getAsOfDate</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/starteam/TreeBasedTask.html#getExcludes()">getExcludes</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/starteam/TreeBasedTask.html#getFullRepositoryPath(com.starbase.starteam.File)">getFullRepositoryPath</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/starteam/TreeBasedTask.html#getIDofLabelInUse()">getIDofLabelInUse</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/starteam/TreeBasedTask.html#getIncludes()">getIncludes</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/starteam/TreeBasedTask.html#getLabel()">getLabel</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/starteam/TreeBasedTask.html#getLabelID(View)">getLabelID</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/starteam/TreeBasedTask.html#getLabelInUse()">getLabelInUse</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/starteam/TreeBasedTask.html#getRootLocalFolder()">getRootLocalFolder</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/starteam/TreeBasedTask.html#getRootStarteamFolder()">getRootStarteamFolder</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/starteam/TreeBasedTask.html#getViewConfiguredByDate(View)">getViewConfiguredByDate</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/starteam/TreeBasedTask.html#isForced()">isForced</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/starteam/TreeBasedTask.html#isPreloadFileInformation()">isPreloadFileInformation</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/starteam/TreeBasedTask.html#isRecursive()">isRecursive</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/starteam/TreeBasedTask.html#isUsingRevisionLabel()">isUsingRevisionLabel</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/starteam/TreeBasedTask.html#isUsingViewLabel()">isUsingViewLabel</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/starteam/TreeBasedTask.html#logAsOfDate()">logAsOfDate</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/starteam/TreeBasedTask.html#logExcludes()">logExcludes</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/starteam/TreeBasedTask.html#logIncludes()">logIncludes</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/starteam/TreeBasedTask.html#logLabel()">logLabel</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/starteam/TreeBasedTask.html#matchPatterns(java.lang.String, java.lang.String)">matchPatterns</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/starteam/TreeBasedTask.html#setExcludes(java.lang.String)">setExcludes</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/starteam/TreeBasedTask.html#setForced(boolean)">setForced</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/starteam/TreeBasedTask.html#setIncludes(java.lang.String)">setIncludes</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/starteam/TreeBasedTask.html#setPreloadFileInformation(boolean)">setPreloadFileInformation</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/starteam/TreeBasedTask.html#setRecursive(boolean)">setRecursive</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/starteam/TreeBasedTask.html#setRootLocalFolder(java.lang.String)">setRootLocalFolder</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/starteam/TreeBasedTask.html#setRootStarteamFolder(java.lang.String)">setRootStarteamFolder</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/starteam/TreeBasedTask.html#shouldProcess(java.lang.String)">shouldProcess</A></CODE></TD>
330</TR>
331</TABLE>
332&nbsp;<A NAME="methods_inherited_from_class_org.apache.tools.ant.taskdefs.optional.starteam.StarTeamTask"><!-- --></A>
333<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
334<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
335<TD><B>Methods inherited from class org.apache.tools.ant.taskdefs.optional.starteam.<A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/starteam/StarTeamTask.html" title="class in org.apache.tools.ant.taskdefs.optional.starteam">StarTeamTask</A></B></TD>
336</TR>
337<TR BGCOLOR="white" CLASS="TableRowColor">
338<TD><CODE><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/starteam/StarTeamTask.html#disconnectFromServer()">disconnectFromServer</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/starteam/StarTeamTask.html#getPassword()">getPassword</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/starteam/StarTeamTask.html#getProjectname()">getProjectname</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/starteam/StarTeamTask.html#getServer()">getServer</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/starteam/StarTeamTask.html#getServername()">getServername</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/starteam/StarTeamTask.html#getServerport()">getServerport</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/starteam/StarTeamTask.html#getTypeNames()">getTypeNames</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/starteam/StarTeamTask.html#getURL()">getURL</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/starteam/StarTeamTask.html#getUserName()">getUserName</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/starteam/StarTeamTask.html#getUserName(int)">getUserName</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/starteam/StarTeamTask.html#getViewname()">getViewname</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/starteam/StarTeamTask.html#getViewURL()">getViewURL</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/starteam/StarTeamTask.html#openView()">openView</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/starteam/StarTeamTask.html#setPassword(java.lang.String)">setPassword</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/starteam/StarTeamTask.html#setProjectname(java.lang.String)">setProjectname</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/starteam/StarTeamTask.html#setServername(java.lang.String)">setServername</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/starteam/StarTeamTask.html#setServerport(java.lang.String)">setServerport</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/starteam/StarTeamTask.html#setURL(java.lang.String)">setURL</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/starteam/StarTeamTask.html#setUserName(java.lang.String)">setUserName</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/starteam/StarTeamTask.html#setViewname(java.lang.String)">setViewname</A></CODE></TD>
339</TR>
340</TABLE>
341&nbsp;<A NAME="methods_inherited_from_class_org.apache.tools.ant.Task"><!-- --></A>
342<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
343<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
344<TD><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></TD>
345</TR>
346<TR BGCOLOR="white" CLASS="TableRowColor">
347<TD><CODE><A HREF="../../../../../../../org/apache/tools/ant/Task.html#getDescription()">getDescription</A>, <A HREF="../../../../../../../org/apache/tools/ant/Task.html#getLocation()">getLocation</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#init()">init</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#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#setDescription(java.lang.String)">setDescription</A>, <A HREF="../../../../../../../org/apache/tools/ant/Task.html#setLocation(org.apache.tools.ant.Location)">setLocation</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>
348</TR>
349</TABLE>
350&nbsp;<A NAME="methods_inherited_from_class_org.apache.tools.ant.ProjectComponent"><!-- --></A>
351<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
352<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
353<TD><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></TD>
354</TR>
355<TR BGCOLOR="white" CLASS="TableRowColor">
356<TD><CODE><A HREF="../../../../../../../org/apache/tools/ant/ProjectComponent.html#getProject()">getProject</A>, <A HREF="../../../../../../../org/apache/tools/ant/ProjectComponent.html#setProject(org.apache.tools.ant.Project)">setProject</A></CODE></TD>
357</TR>
358</TABLE>
359&nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
360<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
361<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
362<TD><B>Methods inherited from class java.lang.Object</B></TD>
363</TR>
364<TR BGCOLOR="white" CLASS="TableRowColor">
365<TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
366</TR>
367</TABLE>
368&nbsp;
369<P>
370
371<!-- ============ FIELD DETAIL =========== -->
372
373
374<!-- ========= CONSTRUCTOR DETAIL ======== -->
375
376<A NAME="constructor_detail"><!-- --></A>
377<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
378<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
379<TD COLSPAN=1><FONT SIZE="+2">
380<B>Constructor Detail</B></FONT></TD>
381</TR>
382</TABLE>
383
384<A NAME="StarTeamCheckout()"><!-- --></A><H3>
385StarTeamCheckout</H3>
386<PRE>
387public <B>StarTeamCheckout</B>()</PRE>
388<DL>
389</DL>
390
391<!-- ============ METHOD DETAIL ========== -->
392
393<A NAME="method_detail"><!-- --></A>
394<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
395<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
396<TD COLSPAN=1><FONT SIZE="+2">
397<B>Method Detail</B></FONT></TD>
398</TR>
399</TABLE>
400
401<A NAME="setCreateWorkingDirs(boolean)"><!-- --></A><H3>
402setCreateWorkingDirs</H3>
403<PRE>
404public void <B>setCreateWorkingDirs</B>(boolean&nbsp;value)</PRE>
405<DL>
406<DD>flag (defaults to true) to create all directories
407 that are in the Starteam repository even if they are empty.
408<P>
409<DD><DL>
410<DT><B>Parameters:</B><DD><CODE>value</CODE> - the value to set the attribute to.</DL>
411</DD>
412</DL>
413<HR>
414
415<A NAME="setDeleteUncontrolled(boolean)"><!-- --></A><H3>
416setDeleteUncontrolled</H3>
417<PRE>
418public void <B>setDeleteUncontrolled</B>(boolean&nbsp;value)</PRE>
419<DL>
420<DD>Whether or not all local files <i>not<i> in StarTeam should be deleted.
421 Optional, defaults to <code>true</code>.
422<P>
423<DD><DL>
424<DT><B>Parameters:</B><DD><CODE>value</CODE> - the value to set the attribute to.</DL>
425</DD>
426</DL>
427<HR>
428
429<A NAME="setConvertEOL(boolean)"><!-- --></A><H3>
430setConvertEOL</H3>
431<PRE>
432public void <B>setConvertEOL</B>(boolean&nbsp;value)</PRE>
433<DL>
434<DD>Set whether or not files should be checked out using the
435 local machine's EOL convention.
436 Optional, defaults to <code>true</code>.
437<P>
438<DD><DL>
439<DT><B>Parameters:</B><DD><CODE>value</CODE> - the value to set the attribute to.</DL>
440</DD>
441</DL>
442<HR>
443
444<A NAME="setLabel(java.lang.String)"><!-- --></A><H3>
445setLabel</H3>
446<PRE>
447public void <B>setLabel</B>(java.lang.String&nbsp;label)</PRE>
448<DL>
449<DD>Sets the label StarTeam is to use for checkout; defaults to the most recent file.
450 The label must exist in starteam or an exception will be thrown.
451<P>
452<DD><DL>
453<DT><B>Parameters:</B><DD><CODE>label</CODE> - the label to be used</DL>
454</DD>
455</DL>
456<HR>
457
458<A NAME="setLocked(boolean)"><!-- --></A><H3>
459setLocked</H3>
460<PRE>
461public void <B>setLocked</B>(boolean&nbsp;v)
462 throws <A HREF="../../../../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</A></PRE>
463<DL>
464<DD>Set to do a locked checkout; optional default is false.
465<P>
466<DD><DL>
467<DT><B>Parameters:</B><DD><CODE>v</CODE> - True to do a locked checkout, false to checkout without
468 changing status/.
469<DT><B>Throws:</B>
470<DD><CODE><A HREF="../../../../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</A></CODE> - if both locked and unlocked are set true</DL>
471</DD>
472</DL>
473<HR>
474
475<A NAME="setUnlocked(boolean)"><!-- --></A><H3>
476setUnlocked</H3>
477<PRE>
478public void <B>setUnlocked</B>(boolean&nbsp;v)
479 throws <A HREF="../../../../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</A></PRE>
480<DL>
481<DD>Set to do an unlocked checkout. Default is false;
482<P>
483<DD><DL>
484<DT><B>Parameters:</B><DD><CODE>v</CODE> - True to do an unlocked checkout, false to checkout without
485 changing status.
486<DT><B>Throws:</B>
487<DD><CODE><A HREF="../../../../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</A></CODE> - if both locked and unlocked are set true</DL>
488</DD>
489</DL>
490<HR>
491
492<A NAME="setUseRepositoryTimeStamp(boolean)"><!-- --></A><H3>
493setUseRepositoryTimeStamp</H3>
494<PRE>
495public void <B>setUseRepositoryTimeStamp</B>(boolean&nbsp;useRepositoryTimeStamp)</PRE>
496<DL>
497<DD>sets the useRepositoryTimestmp member.
498<P>
499<DD><DL>
500<DT><B>Parameters:</B><DD><CODE>useRepositoryTimeStamp</CODE> - true means checked out files will get the repository timestamp.
501 false means the checked out files will be timestamped at the time
502 of checkout.</DL>
503</DD>
504</DL>
505<HR>
506
507<A NAME="getUseRepositoryTimeStamp()"><!-- --></A><H3>
508getUseRepositoryTimeStamp</H3>
509<PRE>
510public boolean <B>getUseRepositoryTimeStamp</B>()</PRE>
511<DL>
512<DD>returns the value of the useRepositoryTimestamp member
513<P>
514<DD><DL>
515
516<DT><B>Returns:</B><DD>the value of the useRepositoryTimestamp member</DL>
517</DD>
518</DL>
519<HR>
520
521<A NAME="setAsOfDate(java.lang.String)"><!-- --></A><H3>
522setAsOfDate</H3>
523<PRE>
524public void <B>setAsOfDate</B>(java.lang.String&nbsp;asOfDateParam)</PRE>
525<DL>
526<DD>List files, dates, and statuses as of this date; optional.
527 If not specified, the most recent version of each file will be listed.
528<P>
529<DD><DL>
530<DT><B>Parameters:</B><DD><CODE>asOfDateParam</CODE> - the date as of which the listing to be made<DT><B>Since:</B></DT>
531 <DD>Ant 1.6</DD>
532</DL>
533</DD>
534</DL>
535<HR>
536
537<A NAME="setAsOfDateFormat(java.lang.String)"><!-- --></A><H3>
538setAsOfDateFormat</H3>
539<PRE>
540public void <B>setAsOfDateFormat</B>(java.lang.String&nbsp;asOfDateFormat)</PRE>
541<DL>
542<DD>Date Format with which asOfDate parameter to be parsed; optional.
543 Must be a SimpleDateFormat compatible string.
544 If not specified, and asOfDateParam is specified, parse will use ISO8601
545 datetime and date formats.
546<P>
547<DD><DL>
548<DT><B>Parameters:</B><DD><CODE>asOfDateFormat</CODE> - the SimpleDateFormat-compatible format string<DT><B>Since:</B></DT>
549 <DD>Ant 1.6</DD>
550</DL>
551</DD>
552</DL>
553<HR>
554
555<A NAME="createSnapshotView(View)"><!-- --></A><H3>
556createSnapshotView</H3>
557<PRE>
558protected View <B>createSnapshotView</B>(View&nbsp;raw)
559 throws <A HREF="../../../../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</A></PRE>
560<DL>
561<DD>Override of base-class abstract function creates an
562 appropriately configured view for checkouts - either
563 the current view or a view from this.label or the raw
564 view itself in the case of a revision label.
565<P>
566<DD><DL>
567<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/starteam/StarTeamTask.html#createSnapshotView(View)">createSnapshotView</A></CODE> in class <CODE><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/starteam/StarTeamTask.html" title="class in org.apache.tools.ant.taskdefs.optional.starteam">StarTeamTask</A></CODE></DL>
568</DD>
569<DD><DL>
570<DT><B>Parameters:</B><DD><CODE>raw</CODE> - the unconfigured <code>View</code>
571<DT><B>Returns:</B><DD>the snapshot <code>View</code> appropriately configured.
572<DT><B>Throws:</B>
573<DD><CODE><A HREF="../../../../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</A></CODE> - on error</DL>
574</DD>
575</DL>
576<HR>
577
578<A NAME="testPreconditions()"><!-- --></A><H3>
579testPreconditions</H3>
580<PRE>
581protected void <B>testPreconditions</B>()
582 throws <A HREF="../../../../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</A></PRE>
583<DL>
584<DD>Implements base-class abstract function to define tests for
585 any preconditons required by the task.
586<P>
587<DD><DL>
588<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/starteam/TreeBasedTask.html#testPreconditions()">testPreconditions</A></CODE> in class <CODE><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/starteam/TreeBasedTask.html" title="class in org.apache.tools.ant.taskdefs.optional.starteam">TreeBasedTask</A></CODE></DL>
589</DD>
590<DD><DL>
591
592<DT><B>Throws:</B>
593<DD><CODE><A HREF="../../../../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</A></CODE> - thrown if both rootLocalFolder
594 and viewRootLocalFolder are defined<DT><B>See Also:</B><DD><code>execute()</code></DL>
595</DD>
596</DL>
597<HR>
598
599<A NAME="logOperationDescription(Folder, java.io.File)"><!-- --></A><H3>
600logOperationDescription</H3>
601<PRE>
602protected void <B>logOperationDescription</B>(Folder&nbsp;starteamrootFolder,
603 java.io.File&nbsp;targetrootFolder)</PRE>
604<DL>
605<DD>extenders should emit to the log an entry describing the parameters
606 that will be used by this operation.
607<P>
608<DD><DL>
609<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/starteam/TreeBasedTask.html#logOperationDescription(Folder, java.io.File)">logOperationDescription</A></CODE> in class <CODE><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/starteam/TreeBasedTask.html" title="class in org.apache.tools.ant.taskdefs.optional.starteam">TreeBasedTask</A></CODE></DL>
610</DD>
611<DD><DL>
612<DT><B>Parameters:</B><DD><CODE>starteamrootFolder</CODE> - root folder in StarTeam for the operation<DD><CODE>targetrootFolder</CODE> - root local folder for the operation (whether specified
613 by the user or not.</DL>
614</DD>
615</DL>
616<HR>
617
618<A NAME="visit(Folder, java.io.File)"><!-- --></A><H3>
619visit</H3>
620<PRE>
621protected void <B>visit</B>(Folder&nbsp;starteamFolder,
622 java.io.File&nbsp;targetFolder)
623 throws <A HREF="../../../../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</A></PRE>
624<DL>
625<DD>Implements base-class abstract function to perform the checkout
626 operation on the files in each folder of the tree.
627<P>
628<DD><DL>
629<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/starteam/TreeBasedTask.html#visit(Folder, java.io.File)">visit</A></CODE> in class <CODE><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/starteam/TreeBasedTask.html" title="class in org.apache.tools.ant.taskdefs.optional.starteam">TreeBasedTask</A></CODE></DL>
630</DD>
631<DD><DL>
632<DT><B>Parameters:</B><DD><CODE>starteamFolder</CODE> - the StarTeam folder from which files to be
633 checked out<DD><CODE>targetFolder</CODE> - the local mapping of rootStarteamFolder
634<DT><B>Throws:</B>
635<DD><CODE><A HREF="../../../../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</A></CODE> - if any error occurs</DL>
636</DD>
637</DL>
638<!-- ========= END OF CLASS DATA ========= -->
639<HR>
640
641
642<!-- ======= START OF BOTTOM NAVBAR ====== -->
643<A NAME="navbar_bottom"><!-- --></A>
644<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
645<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
646<TR>
647<TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
648<A NAME="navbar_bottom_firstrow"><!-- --></A>
649<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
650 <TR ALIGN="center" VALIGN="top">
651 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
652 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
653 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
654 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
655 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
656 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
657 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
658 </TR>
659</TABLE>
660</TD>
661<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
662</EM>
663</TD>
664</TR>
665
666<TR>
667<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
668&nbsp;<A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/starteam/StarTeamCheckin.html" title="class in org.apache.tools.ant.taskdefs.optional.starteam"><B>PREV CLASS</B></A>&nbsp;
669&nbsp;<A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/starteam/StarTeamLabel.html" title="class in org.apache.tools.ant.taskdefs.optional.starteam"><B>NEXT CLASS</B></A></FONT></TD>
670<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
671 <A HREF="../../../../../../../index.html" target="_top"><B>FRAMES</B></A> &nbsp;
672&nbsp;<A HREF="StarTeamCheckout.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
673&nbsp;<SCRIPT type="text/javascript">
674 <!--
675 if(window==top) {
676 document.writeln('<A HREF="../../../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
677 }
678 //-->
679</SCRIPT>
680<NOSCRIPT>
681 <A HREF="../../../../../../../allclasses-noframe.html"><B>All Classes</B></A>
682</NOSCRIPT>
683
684</FONT></TD>
685</TR>
686<TR>
687<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
688 SUMMARY:&nbsp;<A HREF="#nested_classes_inherited_from_class_org.apache.tools.ant.taskdefs.optional.starteam.TreeBasedTask">NESTED</A>&nbsp;|&nbsp;<A HREF="#fields_inherited_from_class_org.apache.tools.ant.taskdefs.optional.starteam.TreeBasedTask">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
689<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
690DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
691</TR>
692</TABLE>
693<A NAME="skip-navbar_bottom"></A>
694<!-- ======== END OF BOTTOM NAVBAR ======= -->
695
696<HR>
697Copyright © 2000-2007 Apache Software Foundation. All Rights Reserved.
698</BODY>
699</HTML>
Note: See TracBrowser for help on using the repository browser.