source: release-kits/lirk3/resources/gs3-release-maker/ant/docs/manual/api/org/apache/tools/ant/taskdefs/optional/starteam/TreeBasedTask.html@ 14982

Last change on this file since 14982 was 14982, checked in by oranfry, 16 years ago

initial import of LiRK3
File size: 60.3 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:31 NZST 2007 -->
6<TITLE>
7TreeBasedTask (Apache Ant API)
8</TITLE>
9
10<META NAME="keywords" CONTENT="org.apache.tools.ant.taskdefs.optional.starteam.TreeBasedTask 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="TreeBasedTask (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/StarTeamTask.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/TreeBasedTask.UnmatchedFileMap.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="TreeBasedTask.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_class_summary">NESTED</A>&nbsp;|&nbsp;<A HREF="#field_summary">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;<A HREF="#field_detail">FIELD</A>&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 TreeBasedTask</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"><B>org.apache.tools.ant.taskdefs.optional.starteam.TreeBasedTask</B>
93</PRE>
94<DL>
95<DT><B>Direct Known Subclasses:</B> <DD><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/starteam/StarTeamCheckin.html" title="class in org.apache.tools.ant.taskdefs.optional.starteam">StarTeamCheckin</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/starteam/StarTeamCheckout.html" title="class in org.apache.tools.ant.taskdefs.optional.starteam">StarTeamCheckout</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/starteam/StarTeamList.html" title="class in org.apache.tools.ant.taskdefs.optional.starteam">StarTeamList</A></DD>
96</DL>
97<HR>
98<DL>
99<DT>public abstract class <B>TreeBasedTask</B><DT>extends <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/starteam/StarTeamTask.html" title="class in org.apache.tools.ant.taskdefs.optional.starteam">StarTeamTask</A></DL>
100
101<P>
102TreeBasedTask.java
103 This abstract class is the base for any tasks that are tree-based, that
104 is, for tasks which iterate over a tree of folders in StarTeam which
105 is reflected in a tree of folder the local machine.
106
107 This class provides the tree-iteration functionality. Derived classes
108 will implement their specific task functionality by the visitor pattern,
109 specifically by implementing the method
110 <code>visit(Folder rootStarteamFolder, java.io.File rootLocalFolder)</code>
111
112 Created: Sat Dec 15 16:55:19 2001
113<P>
114
115<P>
116<DL>
117<DT><B>Version:</B></DT>
118 <DD>1.0</DD>
119<DT><B>See Also:</B><DD><A HREF="http://www.starbase.com/">StarBase Web Site</A></DL>
120<HR>
121
122<P>
123<!-- ======== NESTED CLASS SUMMARY ======== -->
124
125<A NAME="nested_class_summary"><!-- --></A>
126<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
127<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
128<TD COLSPAN=2><FONT SIZE="+2">
129<B>Nested Class Summary</B></FONT></TD>
130</TR>
131<TR BGCOLOR="white" CLASS="TableRowColor">
132<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
133<CODE>protected &nbsp;class</CODE></FONT></TD>
134<TD><CODE><B><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></B></CODE>
135
136<BR>
137&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;This class implements a map of existing local files to possibly
138 existing repository files.</TD>
139</TR>
140</TABLE>
141&nbsp;
142<!-- =========== FIELD SUMMARY =========== -->
143
144<A NAME="field_summary"><!-- --></A>
145<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
146<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
147<TD COLSPAN=2><FONT SIZE="+2">
148<B>Field Summary</B></FONT></TD>
149</TR>
150<TR BGCOLOR="white" CLASS="TableRowColor">
151<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
152<CODE>static&nbsp;java.lang.String</CODE></FONT></TD>
153<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/starteam/TreeBasedTask.html#DEFAULT_EXCLUDESETTING">DEFAULT_EXCLUDESETTING</A></B></CODE>
154
155<BR>
156&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;This disables the exclude filter by default.</TD>
157</TR>
158<TR BGCOLOR="white" CLASS="TableRowColor">
159<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
160<CODE>static&nbsp;java.lang.String</CODE></FONT></TD>
161<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/starteam/TreeBasedTask.html#DEFAULT_INCLUDESETTING">DEFAULT_INCLUDESETTING</A></B></CODE>
162
163<BR>
164&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;This constant sets the filter to include all files.</TD>
165</TR>
166</TABLE>
167&nbsp;<A NAME="fields_inherited_from_class_org.apache.tools.ant.Task"><!-- --></A>
168<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
169<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
170<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>
171</TR>
172<TR BGCOLOR="white" CLASS="TableRowColor">
173<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>
174</TR>
175</TABLE>
176&nbsp;<A NAME="fields_inherited_from_class_org.apache.tools.ant.ProjectComponent"><!-- --></A>
177<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
178<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
179<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>
180</TR>
181<TR BGCOLOR="white" CLASS="TableRowColor">
182<TD><CODE><A HREF="../../../../../../../org/apache/tools/ant/ProjectComponent.html#project">project</A></CODE></TD>
183</TR>
184</TABLE>
185&nbsp;
186<!-- ======== CONSTRUCTOR SUMMARY ======== -->
187
188<A NAME="constructor_summary"><!-- --></A>
189<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
190<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
191<TD COLSPAN=2><FONT SIZE="+2">
192<B>Constructor Summary</B></FONT></TD>
193</TR>
194<TR BGCOLOR="white" CLASS="TableRowColor">
195<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/starteam/TreeBasedTask.html#TreeBasedTask()">TreeBasedTask</A></B>()</CODE>
196
197<BR>
198&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
199</TR>
200</TABLE>
201&nbsp;
202<!-- ========== METHOD SUMMARY =========== -->
203
204<A NAME="method_summary"><!-- --></A>
205<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
206<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
207<TD COLSPAN=2><FONT SIZE="+2">
208<B>Method Summary</B></FONT></TD>
209</TR>
210<TR BGCOLOR="white" CLASS="TableRowColor">
211<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
212<CODE>protected &nbsp;void</CODE></FONT></TD>
213<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/starteam/TreeBasedTask.html#_setAsOfDate(java.lang.String)">_setAsOfDate</A></B>(java.lang.String&nbsp;asOfDate)</CODE>
214
215<BR>
216&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;non-public method callable only by derived classes that implement
217 setAsOfDate (so that derived tasks that do not accept this
218 parameter will fail if user attempts to use it.</TD>
219</TR>
220<TR BGCOLOR="white" CLASS="TableRowColor">
221<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
222<CODE>protected &nbsp;void</CODE></FONT></TD>
223<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/starteam/TreeBasedTask.html#_setAsOfDateFormat(java.lang.String)">_setAsOfDateFormat</A></B>(java.lang.String&nbsp;asOfDateFormat)</CODE>
224
225<BR>
226&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;non-public method callable only by derived classes that implement
227 setAsOfDateFormat (so that derived tasks that do not accept this
228 parameter will fail if user attempts to use it.</TD>
229</TR>
230<TR BGCOLOR="white" CLASS="TableRowColor">
231<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
232<CODE>protected &nbsp;void</CODE></FONT></TD>
233<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/starteam/TreeBasedTask.html#_setLabel(java.lang.String)">_setLabel</A></B>(java.lang.String&nbsp;label)</CODE>
234
235<BR>
236&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;protected function to allow subclasses to set the label (or not).</TD>
237</TR>
238<TR BGCOLOR="white" CLASS="TableRowColor">
239<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
240<CODE>&nbsp;void</CODE></FONT></TD>
241<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/starteam/TreeBasedTask.html#execute()">execute</A></B>()</CODE>
242
243<BR>
244&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;This method does the work of opening the supplied Starteam view and
245 calling the <code>visit()</code> method to perform the task.</TD>
246</TR>
247<TR BGCOLOR="white" CLASS="TableRowColor">
248<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
249<CODE>protected &nbsp;java.lang.String</CODE></FONT></TD>
250<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/starteam/TreeBasedTask.html#getAsOfDate()">getAsOfDate</A></B>()</CODE>
251
252<BR>
253&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;return the asOfDate entered by the user for internal use by derived
254 classes.</TD>
255</TR>
256<TR BGCOLOR="white" CLASS="TableRowColor">
257<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
258<CODE>&nbsp;java.lang.String</CODE></FONT></TD>
259<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/starteam/TreeBasedTask.html#getExcludes()">getExcludes</A></B>()</CODE>
260
261<BR>
262&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Gets the patterns from the exclude filter.</TD>
263</TR>
264<TR BGCOLOR="white" CLASS="TableRowColor">
265<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
266<CODE>static&nbsp;java.lang.String</CODE></FONT></TD>
267<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/starteam/TreeBasedTask.html#getFullRepositoryPath(com.starbase.starteam.File)">getFullRepositoryPath</A></B>(com.starbase.starteam.File&nbsp;remotefile)</CODE>
268
269<BR>
270&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Return the full repository path name of a file.</TD>
271</TR>
272<TR BGCOLOR="white" CLASS="TableRowColor">
273<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
274<CODE>protected &nbsp;int</CODE></FONT></TD>
275<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/starteam/TreeBasedTask.html#getIDofLabelInUse()">getIDofLabelInUse</A></B>()</CODE>
276
277<BR>
278&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
279</TR>
280<TR BGCOLOR="white" CLASS="TableRowColor">
281<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
282<CODE>&nbsp;java.lang.String</CODE></FONT></TD>
283<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/starteam/TreeBasedTask.html#getIncludes()">getIncludes</A></B>()</CODE>
284
285<BR>
286&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Gets the patterns from the include filter.</TD>
287</TR>
288<TR BGCOLOR="white" CLASS="TableRowColor">
289<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
290<CODE>protected &nbsp;java.lang.String</CODE></FONT></TD>
291<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/starteam/TreeBasedTask.html#getLabel()">getLabel</A></B>()</CODE>
292
293<BR>
294&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;return the label passed to the task by the user as a string</TD>
295</TR>
296<TR BGCOLOR="white" CLASS="TableRowColor">
297<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
298<CODE>protected &nbsp;int</CODE></FONT></TD>
299<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/starteam/TreeBasedTask.html#getLabelID(View)">getLabelID</A></B>(View&nbsp;v)</CODE>
300
301<BR>
302&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Helper method calls on the StarTeam API to retrieve an ID number
303 for the specified view, corresponding to this.label.</TD>
304</TR>
305<TR BGCOLOR="white" CLASS="TableRowColor">
306<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
307<CODE>protected &nbsp;Label</CODE></FONT></TD>
308<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/starteam/TreeBasedTask.html#getLabelInUse()">getLabelInUse</A></B>()</CODE>
309
310<BR>
311&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;returns the label being used</TD>
312</TR>
313<TR BGCOLOR="white" CLASS="TableRowColor">
314<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
315<CODE>&nbsp;java.lang.String</CODE></FONT></TD>
316<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/starteam/TreeBasedTask.html#getRootLocalFolder()">getRootLocalFolder</A></B>()</CODE>
317
318<BR>
319&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the local folder specified by the user,
320 corresponding to the starteam folder for this operation
321 or null if not specified.</TD>
322</TR>
323<TR BGCOLOR="white" CLASS="TableRowColor">
324<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
325<CODE>&nbsp;java.lang.String</CODE></FONT></TD>
326<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/starteam/TreeBasedTask.html#getRootStarteamFolder()">getRootStarteamFolder</A></B>()</CODE>
327
328<BR>
329&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;returns the root folder in the Starteam repository
330 used for this operation</TD>
331</TR>
332<TR BGCOLOR="white" CLASS="TableRowColor">
333<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
334<CODE>protected &nbsp;View</CODE></FONT></TD>
335<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/starteam/TreeBasedTask.html#getViewConfiguredByDate(View)">getViewConfiguredByDate</A></B>(View&nbsp;raw)</CODE>
336
337<BR>
338&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;If an asofDate parameter has been supplied by the user return a
339 StarTeam view based on the configuration of the StarTeam view
340 specified the user as of the date specified in the parameter.</TD>
341</TR>
342<TR BGCOLOR="white" CLASS="TableRowColor">
343<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
344<CODE>&nbsp;boolean</CODE></FONT></TD>
345<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/starteam/TreeBasedTask.html#isForced()">isForced</A></B>()</CODE>
346
347<BR>
348&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get the value of forced.</TD>
349</TR>
350<TR BGCOLOR="white" CLASS="TableRowColor">
351<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
352<CODE>&nbsp;boolean</CODE></FONT></TD>
353<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/starteam/TreeBasedTask.html#isPreloadFileInformation()">isPreloadFileInformation</A></B>()</CODE>
354
355<BR>
356&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get the value of preloadFileInformation.</TD>
357</TR>
358<TR BGCOLOR="white" CLASS="TableRowColor">
359<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
360<CODE>&nbsp;boolean</CODE></FONT></TD>
361<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/starteam/TreeBasedTask.html#isRecursive()">isRecursive</A></B>()</CODE>
362
363<BR>
364&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get the value of recursive.</TD>
365</TR>
366<TR BGCOLOR="white" CLASS="TableRowColor">
367<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
368<CODE>protected &nbsp;boolean</CODE></FONT></TD>
369<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/starteam/TreeBasedTask.html#isUsingRevisionLabel()">isUsingRevisionLabel</A></B>()</CODE>
370
371<BR>
372&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;returns true if a label has been specified and it is a revision label.</TD>
373</TR>
374<TR BGCOLOR="white" CLASS="TableRowColor">
375<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
376<CODE>protected &nbsp;boolean</CODE></FONT></TD>
377<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/starteam/TreeBasedTask.html#isUsingViewLabel()">isUsingViewLabel</A></B>()</CODE>
378
379<BR>
380&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;returns true if a label has been specified and it is a view label.</TD>
381</TR>
382<TR BGCOLOR="white" CLASS="TableRowColor">
383<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
384<CODE>protected &nbsp;void</CODE></FONT></TD>
385<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/starteam/TreeBasedTask.html#logAsOfDate()">logAsOfDate</A></B>()</CODE>
386
387<BR>
388&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;show the asofDate in the log</TD>
389</TR>
390<TR BGCOLOR="white" CLASS="TableRowColor">
391<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
392<CODE>protected &nbsp;void</CODE></FONT></TD>
393<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/starteam/TreeBasedTask.html#logExcludes()">logExcludes</A></B>()</CODE>
394
395<BR>
396&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;if excludes have been specified, emit the list to the log</TD>
397</TR>
398<TR BGCOLOR="white" CLASS="TableRowColor">
399<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
400<CODE>protected &nbsp;void</CODE></FONT></TD>
401<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/starteam/TreeBasedTask.html#logIncludes()">logIncludes</A></B>()</CODE>
402
403<BR>
404&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;if excludes have been specified, emit the list to the log</TD>
405</TR>
406<TR BGCOLOR="white" CLASS="TableRowColor">
407<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
408<CODE>protected &nbsp;void</CODE></FONT></TD>
409<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/starteam/TreeBasedTask.html#logLabel()">logLabel</A></B>()</CODE>
410
411<BR>
412&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;show the label in the log and its type.</TD>
413</TR>
414<TR BGCOLOR="white" CLASS="TableRowColor">
415<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
416<CODE>protected abstract &nbsp;void</CODE></FONT></TD>
417<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/starteam/TreeBasedTask.html#logOperationDescription(Folder, java.io.File)">logOperationDescription</A></B>(Folder&nbsp;starteamrootFolder,
418 java.io.File&nbsp;targetrootFolder)</CODE>
419
420<BR>
421&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;extenders should emit to the log an entry describing the parameters
422 that will be used by this operation.</TD>
423</TR>
424<TR BGCOLOR="white" CLASS="TableRowColor">
425<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
426<CODE>protected &nbsp;boolean</CODE></FONT></TD>
427<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/starteam/TreeBasedTask.html#matchPatterns(java.lang.String, java.lang.String)">matchPatterns</A></B>(java.lang.String&nbsp;patterns,
428 java.lang.String&nbsp;pName)</CODE>
429
430<BR>
431&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Convenience method to see if a string match a one pattern
432 in given set of space-separated patterns.</TD>
433</TR>
434<TR BGCOLOR="white" CLASS="TableRowColor">
435<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
436<CODE>&nbsp;void</CODE></FONT></TD>
437<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/starteam/TreeBasedTask.html#setExcludes(java.lang.String)">setExcludes</A></B>(java.lang.String&nbsp;excludes)</CODE>
438
439<BR>
440&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Declare files to exclude using standard <tt>excludes</tt> patterns; optional.</TD>
441</TR>
442<TR BGCOLOR="white" CLASS="TableRowColor">
443<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
444<CODE>&nbsp;void</CODE></FONT></TD>
445<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/starteam/TreeBasedTask.html#setForced(boolean)">setForced</A></B>(boolean&nbsp;v)</CODE>
446
447<BR>
448&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Flag to force actions regardless of the status
449 that StarTeam is maintaining for the file; optional, default false.</TD>
450</TR>
451<TR BGCOLOR="white" CLASS="TableRowColor">
452<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
453<CODE>&nbsp;void</CODE></FONT></TD>
454<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/starteam/TreeBasedTask.html#setIncludes(java.lang.String)">setIncludes</A></B>(java.lang.String&nbsp;includes)</CODE>
455
456<BR>
457&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Declare files to include using standard <tt>includes</tt> patterns; optional.</TD>
458</TR>
459<TR BGCOLOR="white" CLASS="TableRowColor">
460<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
461<CODE>&nbsp;void</CODE></FONT></TD>
462<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/starteam/TreeBasedTask.html#setPreloadFileInformation(boolean)">setPreloadFileInformation</A></B>(boolean&nbsp;v)</CODE>
463
464<BR>
465&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Flag to set to preload file information from the server; optional,
466 default true.</TD>
467</TR>
468<TR BGCOLOR="white" CLASS="TableRowColor">
469<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
470<CODE>&nbsp;void</CODE></FONT></TD>
471<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/starteam/TreeBasedTask.html#setRecursive(boolean)">setRecursive</A></B>(boolean&nbsp;v)</CODE>
472
473<BR>
474&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Flag to set to include files in subfolders in the operation; optional,
475 default true.</TD>
476</TR>
477<TR BGCOLOR="white" CLASS="TableRowColor">
478<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
479<CODE>&nbsp;void</CODE></FONT></TD>
480<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/starteam/TreeBasedTask.html#setRootLocalFolder(java.lang.String)">setRootLocalFolder</A></B>(java.lang.String&nbsp;rootLocalFolder)</CODE>
481
482<BR>
483&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Set the local folder that will be the root of the tree
484 to which files are checked out; optional.</TD>
485</TR>
486<TR BGCOLOR="white" CLASS="TableRowColor">
487<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
488<CODE>&nbsp;void</CODE></FONT></TD>
489<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/starteam/TreeBasedTask.html#setRootStarteamFolder(java.lang.String)">setRootStarteamFolder</A></B>(java.lang.String&nbsp;rootStarteamFolder)</CODE>
490
491<BR>
492&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Set the root of the subtree in the StarTeam repository from which to
493 work; optional.</TD>
494</TR>
495<TR BGCOLOR="white" CLASS="TableRowColor">
496<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
497<CODE>protected &nbsp;boolean</CODE></FONT></TD>
498<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/starteam/TreeBasedTask.html#shouldProcess(java.lang.String)">shouldProcess</A></B>(java.lang.String&nbsp;pName)</CODE>
499
500<BR>
501&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Look if the file should be processed by the task.</TD>
502</TR>
503<TR BGCOLOR="white" CLASS="TableRowColor">
504<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
505<CODE>protected abstract &nbsp;void</CODE></FONT></TD>
506<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/starteam/TreeBasedTask.html#testPreconditions()">testPreconditions</A></B>()</CODE>
507
508<BR>
509&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Derived classes must override this method to define tests for
510 any preconditons required by the task.</TD>
511</TR>
512<TR BGCOLOR="white" CLASS="TableRowColor">
513<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
514<CODE>protected abstract &nbsp;void</CODE></FONT></TD>
515<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/starteam/TreeBasedTask.html#visit(Folder, java.io.File)">visit</A></B>(Folder&nbsp;rootStarteamFolder,
516 java.io.File&nbsp;rootLocalFolder)</CODE>
517
518<BR>
519&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Derived classes must override this class to define actual processing
520 to be performed on each folder in the tree defined for the task</TD>
521</TR>
522</TABLE>
523&nbsp;<A NAME="methods_inherited_from_class_org.apache.tools.ant.taskdefs.optional.starteam.StarTeamTask"><!-- --></A>
524<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
525<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
526<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>
527</TR>
528<TR BGCOLOR="white" CLASS="TableRowColor">
529<TD><CODE><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/starteam/StarTeamTask.html#createSnapshotView(View)">createSnapshotView</A>, <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>
530</TR>
531</TABLE>
532&nbsp;<A NAME="methods_inherited_from_class_org.apache.tools.ant.Task"><!-- --></A>
533<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
534<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
535<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>
536</TR>
537<TR BGCOLOR="white" CLASS="TableRowColor">
538<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>
539</TR>
540</TABLE>
541&nbsp;<A NAME="methods_inherited_from_class_org.apache.tools.ant.ProjectComponent"><!-- --></A>
542<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
543<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
544<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>
545</TR>
546<TR BGCOLOR="white" CLASS="TableRowColor">
547<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>
548</TR>
549</TABLE>
550&nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
551<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
552<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
553<TD><B>Methods inherited from class java.lang.Object</B></TD>
554</TR>
555<TR BGCOLOR="white" CLASS="TableRowColor">
556<TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
557</TR>
558</TABLE>
559&nbsp;
560<P>
561
562<!-- ============ FIELD DETAIL =========== -->
563
564<A NAME="field_detail"><!-- --></A>
565<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
566<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
567<TD COLSPAN=1><FONT SIZE="+2">
568<B>Field Detail</B></FONT></TD>
569</TR>
570</TABLE>
571
572<A NAME="DEFAULT_INCLUDESETTING"><!-- --></A><H3>
573DEFAULT_INCLUDESETTING</H3>
574<PRE>
575public static final java.lang.String <B>DEFAULT_INCLUDESETTING</B></PRE>
576<DL>
577<DD>This constant sets the filter to include all files. This default has
578 the same result as <CODE>setIncludes("*")</CODE>.
579<P>
580<DL>
581<DT><B>See Also:</B><DD><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/starteam/TreeBasedTask.html#getIncludes()"><CODE>getIncludes()</CODE></A>,
582<A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/starteam/TreeBasedTask.html#setIncludes(java.lang.String)"><CODE>setIncludes(String includes)</CODE></A>,
583<A HREF="../../../../../../../constant-values.html#org.apache.tools.ant.taskdefs.optional.starteam.TreeBasedTask.DEFAULT_INCLUDESETTING">Constant Field Values</A></DL>
584</DL>
585<HR>
586
587<A NAME="DEFAULT_EXCLUDESETTING"><!-- --></A><H3>
588DEFAULT_EXCLUDESETTING</H3>
589<PRE>
590public static final java.lang.String <B>DEFAULT_EXCLUDESETTING</B></PRE>
591<DL>
592<DD>This disables the exclude filter by default. In other words, no files
593 are excluded. This setting is equivalent to
594 <CODE>setExcludes(null)</CODE>.
595<P>
596<DL>
597<DT><B>See Also:</B><DD><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/starteam/TreeBasedTask.html#getExcludes()"><CODE>getExcludes()</CODE></A>,
598<A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/starteam/TreeBasedTask.html#setExcludes(java.lang.String)"><CODE>setExcludes(String excludes)</CODE></A></DL>
599</DL>
600
601<!-- ========= CONSTRUCTOR DETAIL ======== -->
602
603<A NAME="constructor_detail"><!-- --></A>
604<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
605<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
606<TD COLSPAN=1><FONT SIZE="+2">
607<B>Constructor Detail</B></FONT></TD>
608</TR>
609</TABLE>
610
611<A NAME="TreeBasedTask()"><!-- --></A><H3>
612TreeBasedTask</H3>
613<PRE>
614public <B>TreeBasedTask</B>()</PRE>
615<DL>
616</DL>
617
618<!-- ============ METHOD DETAIL ========== -->
619
620<A NAME="method_detail"><!-- --></A>
621<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
622<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
623<TD COLSPAN=1><FONT SIZE="+2">
624<B>Method Detail</B></FONT></TD>
625</TR>
626</TABLE>
627
628<A NAME="setRootStarteamFolder(java.lang.String)"><!-- --></A><H3>
629setRootStarteamFolder</H3>
630<PRE>
631public void <B>setRootStarteamFolder</B>(java.lang.String&nbsp;rootStarteamFolder)</PRE>
632<DL>
633<DD>Set the root of the subtree in the StarTeam repository from which to
634 work; optional. Defaults to the root folder of the view ('/').
635<P>
636<DD><DL>
637<DT><B>Parameters:</B><DD><CODE>rootStarteamFolder</CODE> - the root folder</DL>
638</DD>
639</DL>
640<HR>
641
642<A NAME="getRootStarteamFolder()"><!-- --></A><H3>
643getRootStarteamFolder</H3>
644<PRE>
645public java.lang.String <B>getRootStarteamFolder</B>()</PRE>
646<DL>
647<DD>returns the root folder in the Starteam repository
648 used for this operation
649<P>
650<DD><DL>
651
652<DT><B>Returns:</B><DD>the root folder in use</DL>
653</DD>
654</DL>
655<HR>
656
657<A NAME="setRootLocalFolder(java.lang.String)"><!-- --></A><H3>
658setRootLocalFolder</H3>
659<PRE>
660public void <B>setRootLocalFolder</B>(java.lang.String&nbsp;rootLocalFolder)</PRE>
661<DL>
662<DD>Set the local folder that will be the root of the tree
663 to which files are checked out; optional.
664 If this is not supplied, then the StarTeam "default folder"
665 associated with <tt>rootstarteamfolder</tt> is used.
666<P>
667<DD><DL>
668<DT><B>Parameters:</B><DD><CODE>rootLocalFolder</CODE> - the local folder that will mirror
669 this.rootStarteamFolder</DL>
670</DD>
671</DL>
672<HR>
673
674<A NAME="getRootLocalFolder()"><!-- --></A><H3>
675getRootLocalFolder</H3>
676<PRE>
677public java.lang.String <B>getRootLocalFolder</B>()</PRE>
678<DL>
679<DD>Returns the local folder specified by the user,
680 corresponding to the starteam folder for this operation
681 or null if not specified.
682<P>
683<DD><DL>
684
685<DT><B>Returns:</B><DD>the local folder that mirrors this.rootStarteamFolder</DL>
686</DD>
687</DL>
688<HR>
689
690<A NAME="setIncludes(java.lang.String)"><!-- --></A><H3>
691setIncludes</H3>
692<PRE>
693public void <B>setIncludes</B>(java.lang.String&nbsp;includes)</PRE>
694<DL>
695<DD>Declare files to include using standard <tt>includes</tt> patterns; optional.
696<P>
697<DD><DL>
698<DT><B>Parameters:</B><DD><CODE>includes</CODE> - A string of filter patterns to include. Separate the
699 patterns by spaces.<DT><B>See Also:</B><DD><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/starteam/TreeBasedTask.html#getIncludes()"><CODE>getIncludes()</CODE></A>,
700<A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/starteam/TreeBasedTask.html#setExcludes(java.lang.String)"><CODE>setExcludes(String excludes)</CODE></A>,
701<A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/starteam/TreeBasedTask.html#getExcludes()"><CODE>getExcludes()</CODE></A></DL>
702</DD>
703</DL>
704<HR>
705
706<A NAME="getIncludes()"><!-- --></A><H3>
707getIncludes</H3>
708<PRE>
709public java.lang.String <B>getIncludes</B>()</PRE>
710<DL>
711<DD>Gets the patterns from the include filter. Rather that duplicate the
712 details of AntStarTeamCheckOut's filtering here, refer to these
713 links:
714<P>
715<DD><DL>
716
717<DT><B>Returns:</B><DD>A string of filter patterns separated by spaces.<DT><B>See Also:</B><DD><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/starteam/TreeBasedTask.html#setIncludes(java.lang.String)"><CODE>setIncludes(String includes)</CODE></A>,
718<A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/starteam/TreeBasedTask.html#setExcludes(java.lang.String)"><CODE>setExcludes(String excludes)</CODE></A>,
719<A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/starteam/TreeBasedTask.html#getExcludes()"><CODE>getExcludes()</CODE></A></DL>
720</DD>
721</DL>
722<HR>
723
724<A NAME="logIncludes()"><!-- --></A><H3>
725logIncludes</H3>
726<PRE>
727protected void <B>logIncludes</B>()</PRE>
728<DL>
729<DD>if excludes have been specified, emit the list to the log
730<P>
731<DD><DL>
732</DL>
733</DD>
734</DL>
735<HR>
736
737<A NAME="setExcludes(java.lang.String)"><!-- --></A><H3>
738setExcludes</H3>
739<PRE>
740public void <B>setExcludes</B>(java.lang.String&nbsp;excludes)</PRE>
741<DL>
742<DD>Declare files to exclude using standard <tt>excludes</tt> patterns; optional.
743 When filtering files, AntStarTeamCheckOut
744 uses an unmodified version of <CODE>DirectoryScanner</CODE>'s
745 <CODE>match</CODE> method, so here are the patterns straight from the
746 Ant source code:
747 <BR><BR>
748 Matches a string against a pattern. The pattern contains two special
749 characters:
750 <BR>'*' which means zero or more characters,
751 <BR>'?' which means one and only one character.
752 <BR><BR>
753 For example, if you want to check out all files except .XML and
754 .HTML files, you would put the following line in your program:
755 <CODE>setExcludes("*.XML,*.HTML");</CODE>
756 Finally, note that filters have no effect on the <B>directories</B>
757 that are scanned; you could not skip over all files in directories
758 whose names begin with "project," for instance.
759 <BR><BR>
760 Treatment of overlapping inlcudes and excludes: To give a simplistic
761 example suppose that you set your include filter to "*.htm *.html"
762 and your exclude filter to "index.*". What happens to index.html?
763 AntStarTeamCheckOut will not check out index.html, as it matches an
764 exclude filter ("index.*"), even though it matches the include
765 filter, as well.
766 <BR><BR>
767 Please also read the following sections before using filters:
768<P>
769<DD><DL>
770<DT><B>Parameters:</B><DD><CODE>excludes</CODE> - A string of filter patterns to exclude. Separate the
771 patterns by spaces.<DT><B>See Also:</B><DD><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/starteam/TreeBasedTask.html#setIncludes(java.lang.String)"><CODE>setIncludes(String includes)</CODE></A>,
772<A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/starteam/TreeBasedTask.html#getIncludes()"><CODE>getIncludes()</CODE></A>,
773<A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/starteam/TreeBasedTask.html#getExcludes()"><CODE>getExcludes()</CODE></A></DL>
774</DD>
775</DL>
776<HR>
777
778<A NAME="getExcludes()"><!-- --></A><H3>
779getExcludes</H3>
780<PRE>
781public java.lang.String <B>getExcludes</B>()</PRE>
782<DL>
783<DD>Gets the patterns from the exclude filter. Rather that duplicate the
784 details of AntStarTeanCheckOut's filtering here, refer to these
785 links:
786<P>
787<DD><DL>
788
789<DT><B>Returns:</B><DD>A string of filter patterns separated by spaces.<DT><B>See Also:</B><DD><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/starteam/TreeBasedTask.html#setExcludes(java.lang.String)"><CODE>setExcludes(String excludes)</CODE></A>,
790<A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/starteam/TreeBasedTask.html#setIncludes(java.lang.String)"><CODE>setIncludes(String includes)</CODE></A>,
791<A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/starteam/TreeBasedTask.html#getIncludes()"><CODE>getIncludes()</CODE></A></DL>
792</DD>
793</DL>
794<HR>
795
796<A NAME="logExcludes()"><!-- --></A><H3>
797logExcludes</H3>
798<PRE>
799protected void <B>logExcludes</B>()</PRE>
800<DL>
801<DD>if excludes have been specified, emit the list to the log
802<P>
803<DD><DL>
804</DL>
805</DD>
806</DL>
807<HR>
808
809<A NAME="_setLabel(java.lang.String)"><!-- --></A><H3>
810_setLabel</H3>
811<PRE>
812protected void <B>_setLabel</B>(java.lang.String&nbsp;label)</PRE>
813<DL>
814<DD>protected function to allow subclasses to set the label (or not).
815 sets the StarTeam label
816<P>
817<DD><DL>
818<DT><B>Parameters:</B><DD><CODE>label</CODE> - name of the StarTeam label to be set</DL>
819</DD>
820</DL>
821<HR>
822
823<A NAME="_setAsOfDate(java.lang.String)"><!-- --></A><H3>
824_setAsOfDate</H3>
825<PRE>
826protected void <B>_setAsOfDate</B>(java.lang.String&nbsp;asOfDate)</PRE>
827<DL>
828<DD>non-public method callable only by derived classes that implement
829 setAsOfDate (so that derived tasks that do not accept this
830 parameter will fail if user attempts to use it.
831<P>
832<DD><DL>
833<DT><B>Parameters:</B><DD><CODE>asOfDate</CODE> - asOfDate entered by user.<DT><B>Since:</B></DT>
834 <DD>Ant 1.6</DD>
835</DL>
836</DD>
837</DL>
838<HR>
839
840<A NAME="_setAsOfDateFormat(java.lang.String)"><!-- --></A><H3>
841_setAsOfDateFormat</H3>
842<PRE>
843protected void <B>_setAsOfDateFormat</B>(java.lang.String&nbsp;asOfDateFormat)</PRE>
844<DL>
845<DD>non-public method callable only by derived classes that implement
846 setAsOfDateFormat (so that derived tasks that do not accept this
847 parameter will fail if user attempts to use it.
848<P>
849<DD><DL>
850<DT><B>Parameters:</B><DD><CODE>asOfDateFormat</CODE> - asOfDate format entered by user.<DT><B>Since:</B></DT>
851 <DD>Ant 1.6</DD>
852</DL>
853</DD>
854</DL>
855<HR>
856
857<A NAME="getAsOfDate()"><!-- --></A><H3>
858getAsOfDate</H3>
859<PRE>
860protected java.lang.String <B>getAsOfDate</B>()</PRE>
861<DL>
862<DD>return the asOfDate entered by the user for internal use by derived
863 classes.
864<P>
865<DD><DL>
866
867<DT><B>Returns:</B><DD>the asOfDate entered by the user<DT><B>Since:</B></DT>
868 <DD>Ant 1.6</DD>
869</DL>
870</DD>
871</DL>
872<HR>
873
874<A NAME="getViewConfiguredByDate(View)"><!-- --></A><H3>
875getViewConfiguredByDate</H3>
876<PRE>
877protected View <B>getViewConfiguredByDate</B>(View&nbsp;raw)
878 throws <A HREF="../../../../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</A></PRE>
879<DL>
880<DD>If an asofDate parameter has been supplied by the user return a
881 StarTeam view based on the configuration of the StarTeam view
882 specified the user as of the date specified in the parameter.
883 If no asofDate has been specified, return null.
884
885 This method is meant to be called from within implementations of the
886 <code>createSnapshotView</code> abstract method.
887<P>
888<DD><DL>
889<DT><B>Parameters:</B><DD><CODE>raw</CODE> - the raw view to be configured as of the supplied date
890<DT><B>Returns:</B><DD>the view as configured.
891<DT><B>Throws:</B>
892<DD><CODE><A HREF="../../../../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</A></CODE> - thrown if the date is not parsable by the default or
893 supplied format patterns.<DT><B>Since:</B></DT>
894 <DD>Ant 1.6</DD>
895</DL>
896</DD>
897</DL>
898<HR>
899
900<A NAME="getLabel()"><!-- --></A><H3>
901getLabel</H3>
902<PRE>
903protected java.lang.String <B>getLabel</B>()</PRE>
904<DL>
905<DD>return the label passed to the task by the user as a string
906<P>
907<DD><DL>
908
909<DT><B>Returns:</B><DD>the label passed to the task by the user as a string</DL>
910</DD>
911</DL>
912<HR>
913
914<A NAME="isRecursive()"><!-- --></A><H3>
915isRecursive</H3>
916<PRE>
917public boolean <B>isRecursive</B>()</PRE>
918<DL>
919<DD>Get the value of recursive.
920<P>
921<DD><DL>
922
923<DT><B>Returns:</B><DD>value of recursive.</DL>
924</DD>
925</DL>
926<HR>
927
928<A NAME="setRecursive(boolean)"><!-- --></A><H3>
929setRecursive</H3>
930<PRE>
931public void <B>setRecursive</B>(boolean&nbsp;v)</PRE>
932<DL>
933<DD>Flag to set to include files in subfolders in the operation; optional,
934 default true.
935<P>
936<DD><DL>
937<DT><B>Parameters:</B><DD><CODE>v</CODE> - Value to assign to recursive.</DL>
938</DD>
939</DL>
940<HR>
941
942<A NAME="isPreloadFileInformation()"><!-- --></A><H3>
943isPreloadFileInformation</H3>
944<PRE>
945public boolean <B>isPreloadFileInformation</B>()</PRE>
946<DL>
947<DD>Get the value of preloadFileInformation.
948<P>
949<DD><DL>
950
951<DT><B>Returns:</B><DD>value of preloadFileInformation.</DL>
952</DD>
953</DL>
954<HR>
955
956<A NAME="setPreloadFileInformation(boolean)"><!-- --></A><H3>
957setPreloadFileInformation</H3>
958<PRE>
959public void <B>setPreloadFileInformation</B>(boolean&nbsp;v)</PRE>
960<DL>
961<DD>Flag to set to preload file information from the server; optional,
962 default true.
963 Increases performance significantly for projects with many files
964 and/or folders.
965<P>
966<DD><DL>
967<DT><B>Parameters:</B><DD><CODE>v</CODE> - Value to assign to preloadFileInformation.</DL>
968</DD>
969</DL>
970<HR>
971
972<A NAME="isForced()"><!-- --></A><H3>
973isForced</H3>
974<PRE>
975public boolean <B>isForced</B>()</PRE>
976<DL>
977<DD>Get the value of forced.
978<P>
979<DD><DL>
980
981<DT><B>Returns:</B><DD>value of forced.</DL>
982</DD>
983</DL>
984<HR>
985
986<A NAME="setForced(boolean)"><!-- --></A><H3>
987setForced</H3>
988<PRE>
989public void <B>setForced</B>(boolean&nbsp;v)</PRE>
990<DL>
991<DD>Flag to force actions regardless of the status
992 that StarTeam is maintaining for the file; optional, default false.
993 If <tt>rootlocalfolder</tt> is set then
994 this should be set "true" as otherwise the checkout will be based on statuses
995 which do not relate to the target folder.
996<P>
997<DD><DL>
998<DT><B>Parameters:</B><DD><CODE>v</CODE> - Value to assign to forced.</DL>
999</DD>
1000</DL>
1001<HR>
1002
1003<A NAME="isUsingViewLabel()"><!-- --></A><H3>
1004isUsingViewLabel</H3>
1005<PRE>
1006protected boolean <B>isUsingViewLabel</B>()</PRE>
1007<DL>
1008<DD>returns true if a label has been specified and it is a view label.
1009<P>
1010<DD><DL>
1011
1012<DT><B>Returns:</B><DD>true if a label has been specified and it is a view label</DL>
1013</DD>
1014</DL>
1015<HR>
1016
1017<A NAME="isUsingRevisionLabel()"><!-- --></A><H3>
1018isUsingRevisionLabel</H3>
1019<PRE>
1020protected boolean <B>isUsingRevisionLabel</B>()</PRE>
1021<DL>
1022<DD>returns true if a label has been specified and it is a revision label.
1023<P>
1024<DD><DL>
1025
1026<DT><B>Returns:</B><DD>true if a label has been specified and it is a revision label</DL>
1027</DD>
1028</DL>
1029<HR>
1030
1031<A NAME="getLabelInUse()"><!-- --></A><H3>
1032getLabelInUse</H3>
1033<PRE>
1034protected Label <B>getLabelInUse</B>()</PRE>
1035<DL>
1036<DD>returns the label being used
1037<P>
1038<DD><DL>
1039
1040<DT><B>Returns:</B><DD>the label being used</DL>
1041</DD>
1042</DL>
1043<HR>
1044
1045<A NAME="logLabel()"><!-- --></A><H3>
1046logLabel</H3>
1047<PRE>
1048protected void <B>logLabel</B>()</PRE>
1049<DL>
1050<DD>show the label in the log and its type.
1051<P>
1052<DD><DL>
1053</DL>
1054</DD>
1055</DL>
1056<HR>
1057
1058<A NAME="logAsOfDate()"><!-- --></A><H3>
1059logAsOfDate</H3>
1060<PRE>
1061protected void <B>logAsOfDate</B>()</PRE>
1062<DL>
1063<DD>show the asofDate in the log
1064<P>
1065<DD><DL>
1066<DT><B>Since:</B></DT>
1067 <DD>Ant 1.6</DD>
1068</DL>
1069</DD>
1070</DL>
1071<HR>
1072
1073<A NAME="shouldProcess(java.lang.String)"><!-- --></A><H3>
1074shouldProcess</H3>
1075<PRE>
1076protected boolean <B>shouldProcess</B>(java.lang.String&nbsp;pName)</PRE>
1077<DL>
1078<DD>Look if the file should be processed by the task.
1079 Don't process it if it fits no include filters or if
1080 it fits an exclude filter.
1081<P>
1082<DD><DL>
1083<DT><B>Parameters:</B><DD><CODE>pName</CODE> - the item name to look for being included.
1084<DT><B>Returns:</B><DD>whether the file should be processed or not.</DL>
1085</DD>
1086</DL>
1087<HR>
1088
1089<A NAME="matchPatterns(java.lang.String, java.lang.String)"><!-- --></A><H3>
1090matchPatterns</H3>
1091<PRE>
1092protected boolean <B>matchPatterns</B>(java.lang.String&nbsp;patterns,
1093 java.lang.String&nbsp;pName)</PRE>
1094<DL>
1095<DD>Convenience method to see if a string match a one pattern
1096 in given set of space-separated patterns.
1097<P>
1098<DD><DL>
1099<DT><B>Parameters:</B><DD><CODE>patterns</CODE> - the space-separated list of patterns.<DD><CODE>pName</CODE> - the name to look for matching.
1100<DT><B>Returns:</B><DD>whether the name match at least one pattern.</DL>
1101</DD>
1102</DL>
1103<HR>
1104
1105<A NAME="logOperationDescription(Folder, java.io.File)"><!-- --></A><H3>
1106logOperationDescription</H3>
1107<PRE>
1108protected abstract void <B>logOperationDescription</B>(Folder&nbsp;starteamrootFolder,
1109 java.io.File&nbsp;targetrootFolder)</PRE>
1110<DL>
1111<DD>extenders should emit to the log an entry describing the parameters
1112 that will be used by this operation.
1113<P>
1114<DD><DL>
1115<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 by the user or not.</DL>
1116</DD>
1117</DL>
1118<HR>
1119
1120<A NAME="execute()"><!-- --></A><H3>
1121execute</H3>
1122<PRE>
1123public final void <B>execute</B>()
1124 throws <A HREF="../../../../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</A></PRE>
1125<DL>
1126<DD>This method does the work of opening the supplied Starteam view and
1127 calling the <code>visit()</code> method to perform the task.
1128 Derived classes can customize the called methods
1129 <code>testPreconditions()</code> and <code>visit()</code>.
1130<P>
1131<DD><DL>
1132<DT><B>Overrides:</B><DD><CODE><A HREF="../../../../../../../org/apache/tools/ant/Task.html#execute()">execute</A></CODE> in class <CODE><A HREF="../../../../../../../org/apache/tools/ant/Task.html" title="class in org.apache.tools.ant">Task</A></CODE></DL>
1133</DD>
1134<DD><DL>
1135
1136<DT><B>Throws:</B>
1137<DD><CODE><A HREF="../../../../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</A></CODE> - if any error occurs in the processing<DT><B>See Also:</B><DD><code>testPreconditions()</code>,
1138<code>visit()</code></DL>
1139</DD>
1140</DL>
1141<HR>
1142
1143<A NAME="getLabelID(View)"><!-- --></A><H3>
1144getLabelID</H3>
1145<PRE>
1146protected int <B>getLabelID</B>(View&nbsp;v)
1147 throws <A HREF="../../../../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</A></PRE>
1148<DL>
1149<DD>Helper method calls on the StarTeam API to retrieve an ID number
1150 for the specified view, corresponding to this.label.
1151<P>
1152<DD><DL>
1153<DT><B>Parameters:</B><DD><CODE>v</CODE> - the <code>View</code> in which to search for <code>this.label</code>
1154<DT><B>Returns:</B><DD>the ID number corresponding to <code>this.label</code> or -1 if
1155 no label was provided.
1156<DT><B>Throws:</B>
1157<DD><CODE><A HREF="../../../../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</A></CODE> - if <code>this.label</code> does not correspond
1158 to any label in the supplied view</DL>
1159</DD>
1160</DL>
1161<HR>
1162
1163<A NAME="getIDofLabelInUse()"><!-- --></A><H3>
1164getIDofLabelInUse</H3>
1165<PRE>
1166protected int <B>getIDofLabelInUse</B>()</PRE>
1167<DL>
1168<DD><DL>
1169</DL>
1170</DD>
1171</DL>
1172<HR>
1173
1174<A NAME="visit(Folder, java.io.File)"><!-- --></A><H3>
1175visit</H3>
1176<PRE>
1177protected abstract void <B>visit</B>(Folder&nbsp;rootStarteamFolder,
1178 java.io.File&nbsp;rootLocalFolder)
1179 throws <A HREF="../../../../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</A></PRE>
1180<DL>
1181<DD>Derived classes must override this class to define actual processing
1182 to be performed on each folder in the tree defined for the task
1183<P>
1184<DD><DL>
1185<DT><B>Parameters:</B><DD><CODE>rootStarteamFolder</CODE> - the StarTeam folderto be visited<DD><CODE>rootLocalFolder</CODE> - the local mapping of rootStarteamFolder
1186<DT><B>Throws:</B>
1187<DD><CODE><A HREF="../../../../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</A></CODE></DL>
1188</DD>
1189</DL>
1190<HR>
1191
1192<A NAME="testPreconditions()"><!-- --></A><H3>
1193testPreconditions</H3>
1194<PRE>
1195protected abstract void <B>testPreconditions</B>()
1196 throws <A HREF="../../../../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</A></PRE>
1197<DL>
1198<DD>Derived classes must override this method to define tests for
1199 any preconditons required by the task. This method is called at
1200 the beginning of the execute() method.
1201<P>
1202<DD><DL>
1203
1204<DT><B>Throws:</B>
1205<DD><CODE><A HREF="../../../../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</A></CODE> - throw if any fatal error exists in the
1206 parameters supplied. If there is a non-fatal condition, just writing
1207 to the log may be appropriate.<DT><B>See Also:</B><DD><code>execute()</code></DL>
1208</DD>
1209</DL>
1210<HR>
1211
1212<A NAME="getFullRepositoryPath(com.starbase.starteam.File)"><!-- --></A><H3>
1213getFullRepositoryPath</H3>
1214<PRE>
1215public static java.lang.String <B>getFullRepositoryPath</B>(com.starbase.starteam.File&nbsp;remotefile)</PRE>
1216<DL>
1217<DD>Return the full repository path name of a file. Surprisingly there's
1218 no method in com.starbase.starteam.File to provide this.
1219<P>
1220<DD><DL>
1221<DT><B>Parameters:</B><DD><CODE>remotefile</CODE> - the Star Team file whose path is to be returned
1222<DT><B>Returns:</B><DD>the full repository path name of a file.</DL>
1223</DD>
1224</DL>
1225<!-- ========= END OF CLASS DATA ========= -->
1226<HR>
1227
1228
1229<!-- ======= START OF BOTTOM NAVBAR ====== -->
1230<A NAME="navbar_bottom"><!-- --></A>
1231<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
1232<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
1233<TR>
1234<TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
1235<A NAME="navbar_bottom_firstrow"><!-- --></A>
1236<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
1237 <TR ALIGN="center" VALIGN="top">
1238 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
1239 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
1240 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
1241 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
1242 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
1243 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
1244 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
1245 </TR>
1246</TABLE>
1247</TD>
1248<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
1249</EM>
1250</TD>
1251</TR>
1252
1253<TR>
1254<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
1255&nbsp;<A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/starteam/StarTeamTask.html" title="class in org.apache.tools.ant.taskdefs.optional.starteam"><B>PREV CLASS</B></A>&nbsp;
1256&nbsp;<A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/starteam/TreeBasedTask.UnmatchedFileMap.html" title="class in org.apache.tools.ant.taskdefs.optional.starteam"><B>NEXT CLASS</B></A></FONT></TD>
1257<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
1258 <A HREF="../../../../../../../index.html" target="_top"><B>FRAMES</B></A> &nbsp;
1259&nbsp;<A HREF="TreeBasedTask.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
1260&nbsp;<SCRIPT type="text/javascript">
1261 <!--
1262 if(window==top) {
1263 document.writeln('<A HREF="../../../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
1264 }
1265 //-->
1266</SCRIPT>
1267<NOSCRIPT>
1268 <A HREF="../../../../../../../allclasses-noframe.html"><B>All Classes</B></A>
1269</NOSCRIPT>
1270
1271</FONT></TD>
1272</TR>
1273<TR>
1274<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
1275 SUMMARY:&nbsp;<A HREF="#nested_class_summary">NESTED</A>&nbsp;|&nbsp;<A HREF="#field_summary">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
1276<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
1277DETAIL:&nbsp;<A HREF="#field_detail">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
1278</TR>
1279</TABLE>
1280<A NAME="skip-navbar_bottom"></A>
1281<!-- ======== END OF BOTTOM NAVBAR ======= -->
1282
1283<HR>
1284Copyright © 2000-2007 Apache Software Foundation. All Rights Reserved.
1285</BODY>
1286</HTML>
Note: See TracBrowser for help on using the repository browser.