source: other-projects/trunk/gs3-release-maker/apache-ant-1.6.5/build/javadocs/org/apache/tools/ant/taskdefs/optional/starteam/TreeBasedTask.UnmatchedFileMap.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: 12.0 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.UnmatchedFileMap (Apache Ant API)
8</TITLE>
9
10<META NAME="keywords" CONTENT="org.apache.tools.ant.taskdefs.optional.starteam.TreeBasedTask.UnmatchedFileMap 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.UnmatchedFileMap (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/TreeBasedTask.html" title="class in org.apache.tools.ant.taskdefs.optional.starteam"><B>PREV CLASS</B></A>&nbsp;
53&nbsp;NEXT CLASS</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.UnmatchedFileMap.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;NESTED&nbsp;|&nbsp;FIELD&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 TreeBasedTask.UnmatchedFileMap</H2>
87<PRE>
88java.lang.Object
89 <IMG SRC="../../../../../../../resources/inherit.gif" ALT="extended by">java.util.Dictionary
90 <IMG SRC="../../../../../../../resources/inherit.gif" ALT="extended by">java.util.Hashtable
91 <IMG SRC="../../../../../../../resources/inherit.gif" ALT="extended by"><B>org.apache.tools.ant.taskdefs.optional.starteam.TreeBasedTask.UnmatchedFileMap</B>
92</PRE>
93<DL>
94<DT><B>All Implemented Interfaces:</B> <DD>java.lang.Cloneable, java.util.Map, java.io.Serializable</DD>
95</DL>
96<DL>
97<DT><B>Enclosing class:</B><DD><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/starteam/TreeBasedTask.html" title="class in org.apache.tools.ant.taskdefs.optional.starteam">TreeBasedTask</A></DD>
98</DL>
99<HR>
100<DL>
101<DT>protected abstract class <B>TreeBasedTask.UnmatchedFileMap</B><DT>extends java.util.Hashtable</DL>
102
103<P>
104This class implements a map of existing local files to possibly
105 existing repository files. The map is created by a TreeBasedTask
106 upon recursing into a directory. Each local item is mapped to an
107 unattached StarTeam object of the proper type, File->File and
108 Directory->Folder.
109
110 As the TreeBased does its work, it deletes from the map all items
111 it has processed.
112
113 When the TreeBased task processes all the items from the repository,
114 whatever items left in the UnmatchedFileMap are uncontrolled items
115 and can be processed as appropriate to the task. In the case of
116 Checkouts, they can be optionally deleted from the local tree. In the
117 case of Checkins they can optionally be added to the repository.
118<P>
119
120<P>
121<DL>
122<DT><B>See Also:</B><DD><A HREF="../../../../../../../serialized-form.html#org.apache.tools.ant.taskdefs.optional.starteam.TreeBasedTask.UnmatchedFileMap">Serialized Form</A></DL>
123<HR>
124
125<P>
126<!-- ======== NESTED CLASS SUMMARY ======== -->
127
128
129<!-- =========== FIELD SUMMARY =========== -->
130
131
132<!-- ======== CONSTRUCTOR SUMMARY ======== -->
133
134<A NAME="constructor_summary"><!-- --></A>
135<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
136<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
137<TD COLSPAN=2><FONT SIZE="+2">
138<B>Constructor Summary</B></FONT></TD>
139</TR>
140<TR BGCOLOR="white" CLASS="TableRowColor">
141<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
142<CODE>protected </CODE></FONT></TD>
143<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/starteam/TreeBasedTask.UnmatchedFileMap.html#TreeBasedTask.UnmatchedFileMap()">TreeBasedTask.UnmatchedFileMap</A></B>()</CODE>
144
145<BR>
146&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
147</TR>
148</TABLE>
149&nbsp;
150<!-- ========== METHOD SUMMARY =========== -->
151
152<A NAME="method_summary"><!-- --></A>
153<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
154<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
155<TD COLSPAN=2><FONT SIZE="+2">
156<B>Method Summary</B></FONT></TD>
157</TR>
158<TR BGCOLOR="white" CLASS="TableRowColor">
159<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
160<CODE>protected abstract &nbsp;boolean</CODE></FONT></TD>
161<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/starteam/TreeBasedTask.UnmatchedFileMap.html#isActive()">isActive</A></B>()</CODE>
162
163<BR>
164&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;overrides must define this to declare how this method knows if it
165 is active.</TD>
166</TR>
167</TABLE>
168&nbsp;<A NAME="methods_inherited_from_class_java.util.Hashtable"><!-- --></A>
169<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
170<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
171<TD><B>Methods inherited from class java.util.Hashtable</B></TD>
172</TR>
173<TR BGCOLOR="white" CLASS="TableRowColor">
174<TD><CODE>clear, clone, contains, containsKey, containsValue, elements, entrySet, equals, get, hashCode, isEmpty, keys, keySet, put, putAll, rehash, remove, size, toString, values</CODE></TD>
175</TR>
176</TABLE>
177&nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
178<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
179<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
180<TD><B>Methods inherited from class java.lang.Object</B></TD>
181</TR>
182<TR BGCOLOR="white" CLASS="TableRowColor">
183<TD><CODE>finalize, getClass, notify, notifyAll, wait, wait, wait</CODE></TD>
184</TR>
185</TABLE>
186&nbsp;
187<P>
188
189<!-- ============ FIELD DETAIL =========== -->
190
191
192<!-- ========= CONSTRUCTOR DETAIL ======== -->
193
194<A NAME="constructor_detail"><!-- --></A>
195<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
196<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
197<TD COLSPAN=1><FONT SIZE="+2">
198<B>Constructor Detail</B></FONT></TD>
199</TR>
200</TABLE>
201
202<A NAME="TreeBasedTask.UnmatchedFileMap()"><!-- --></A><H3>
203TreeBasedTask.UnmatchedFileMap</H3>
204<PRE>
205protected <B>TreeBasedTask.UnmatchedFileMap</B>()</PRE>
206<DL>
207</DL>
208
209<!-- ============ METHOD DETAIL ========== -->
210
211<A NAME="method_detail"><!-- --></A>
212<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
213<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
214<TD COLSPAN=1><FONT SIZE="+2">
215<B>Method Detail</B></FONT></TD>
216</TR>
217</TABLE>
218
219<A NAME="isActive()"><!-- --></A><H3>
220isActive</H3>
221<PRE>
222protected abstract boolean <B>isActive</B>()</PRE>
223<DL>
224<DD>overrides must define this to declare how this method knows if it
225 is active. This presents extra clock cycles when the functionality
226 is not called for.
227<P>
228<DD><DL>
229
230<DT><B>Returns:</B><DD>True if this object is to perform its functionality.</DL>
231</DD>
232</DL>
233<!-- ========= END OF CLASS DATA ========= -->
234<HR>
235
236
237<!-- ======= START OF BOTTOM NAVBAR ====== -->
238<A NAME="navbar_bottom"><!-- --></A>
239<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
240<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
241<TR>
242<TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
243<A NAME="navbar_bottom_firstrow"><!-- --></A>
244<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
245 <TR ALIGN="center" VALIGN="top">
246 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
247 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
248 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
249 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
250 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
251 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
252 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
253 </TR>
254</TABLE>
255</TD>
256<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
257</EM>
258</TD>
259</TR>
260
261<TR>
262<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
263&nbsp;<A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/starteam/TreeBasedTask.html" title="class in org.apache.tools.ant.taskdefs.optional.starteam"><B>PREV CLASS</B></A>&nbsp;
264&nbsp;NEXT CLASS</FONT></TD>
265<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
266 <A HREF="../../../../../../../index.html" target="_top"><B>FRAMES</B></A> &nbsp;
267&nbsp;<A HREF="TreeBasedTask.UnmatchedFileMap.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
268&nbsp;<SCRIPT type="text/javascript">
269 <!--
270 if(window==top) {
271 document.writeln('<A HREF="../../../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
272 }
273 //-->
274</SCRIPT>
275<NOSCRIPT>
276 <A HREF="../../../../../../../allclasses-noframe.html"><B>All Classes</B></A>
277</NOSCRIPT>
278
279</FONT></TD>
280</TR>
281<TR>
282<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
283 SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
284<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
285DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
286</TR>
287</TABLE>
288<A NAME="skip-navbar_bottom"></A>
289<!-- ======== END OF BOTTOM NAVBAR ======= -->
290
291<HR>
292Copyright © 2000-2007 Apache Software Foundation. All Rights Reserved.
293</BODY>
294</HTML>
Note: See TracBrowser for help on using the repository browser.