Context Navigation

← Previous Revision
Latest Revision
Next Revision →
Blame
Revision Log

source: other-projects/trunk/gs3-release-maker/apache-ant-1.6.5/build/javadocs/org/apache/tools/ant/taskdefs/optional/scm/AntStarTeamCheckOut.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: 65.4 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:29 NZST 2007 -->
6	<TITLE>
7	AntStarTeamCheckOut (Apache Ant API)
8	</TITLE>
9
10	<META NAME="keywords" CONTENT="org.apache.tools.ant.taskdefs.optional.scm.AntStarTeamCheckOut class">
11
12	<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../../../stylesheet.css" TITLE="Style">
13
14	<SCRIPT type="text/javascript">
15	function windowTitle()
16	{
17	parent.document.title="AntStarTeamCheckOut (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> </TD>
36	<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
37	<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev">  <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
38	<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
39	<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
40	<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
41	<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </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	PREV CLASS
53	NEXT CLASS</FONT></TD>
54	<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
55	<A HREF="../../../../../../../index.html" target="_top"><B>FRAMES</B></A>
56	<A HREF="AntStarTeamCheckOut.html" target="_top"><B>NO FRAMES</B></A>
57	<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: NESTED \| <A HREF="#field_summary">FIELD</A> \| <A HREF="#constructor_summary">CONSTR</A> \| <A HREF="#method_summary">METHOD</A></FONT></TD>
73	<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
74	DETAIL: <A HREF="#field_detail">FIELD</A> \| <A HREF="#constructor_detail">CONSTR</A> \| <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">
84	org.apache.tools.ant.taskdefs.optional.scm</FONT>
85	<BR>
86	Class AntStarTeamCheckOut</H2>
87	<PRE>
88	java.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"><B>org.apache.tools.ant.taskdefs.optional.scm.AntStarTeamCheckOut</B>
92	</PRE>
93	<HR>
94	<DL>
95	<DT>public class <B>AntStarTeamCheckOut</B><DT>extends <A HREF="../../../../../../../org/apache/tools/ant/Task.html" title="class in org.apache.tools.ant">Task</A></DL>
96
97	<P>
98	Checks out files from a specific StarTeam server, project, view, and
99	folder.
100	<BR><BR>
101	This program logs in to a StarTeam server and opens up the specified
102	project and view. Then, it searches through that view for the given
103	folder (or, if you prefer, it uses the root folder). Beginning with
104	that folder and optionally continuing recursivesly, AntStarTeamCheckOut
105	compares each file with your include and exclude filters and checks it
106	out only if appropriate.
107	<BR><BR>
108	Checked out files go to a directory you specify under the subfolder
109	named for the default StarTeam path to the view. That is, if you
110	entered /home/cpovirk/work as the target folder, your project was named
111	"OurProject," the given view was named "TestView," and that view is
112	stored by default at "C:\projects\Test," your files would be checked
113	out to /home/cpovirk/work/Test." I avoided using the project name in
114	the path because you may want to keep several versions of the same
115	project on your computer, and I didn't want to use the view name, as
116	there may be many "Test" or "Version 1.0" views, for example. This
117	system's success, of course, depends on what you set the default path
118	to in StarTeam.
119	<BR><BR>
120	You can set AntStarTeamCheckOut to verbose or quiet mode. Also, it has
121	a safeguard against overwriting the files on your computer: If the
122	target directory you specify already exists, the program will throw a
123	BuildException. To override the exception, set <CODE>force</CODE> to
124	true.
125	<BR><BR>
126	<B>This program makes use of functions from the StarTeam API. As a result
127	AntStarTeamCheckOut is available only to licensed users of StarTeam and
128	requires the StarTeam SDK to function. You must have
129	<CODE>starteam-sdk.jar</CODE> in your classpath to run this program.
130	For more information about the StarTeam API and how to license it, see
131	the link below.</B>
132	<P>
133
134	<P>
135	<DL>
136	<DT><B>Version:</B></DT>
137	<DD>1.0</DD>
138	<DT><B>See Also:</B><DD><A HREF="http://www.starbase.com/">StarBase Web Site</A></DL>
139	<HR>
140
141	<P>
142	<!-- ======== NESTED CLASS SUMMARY ======== -->
143
144
145	<!-- =========== FIELD SUMMARY =========== -->
146
147	<A NAME="field_summary"><!-- --></A>
148	<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
149	<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
150	<TD COLSPAN=2><FONT SIZE="+2">
151	<B>Field Summary</B></FONT></TD>
152	</TR>
153	<TR BGCOLOR="white" CLASS="TableRowColor">
154	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
155	<CODE>static java.lang.String</CODE></FONT></TD>
156	<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/scm/AntStarTeamCheckOut.html#DEFAULT_EXCLUDESETTING">DEFAULT_EXCLUDESETTING</A></B></CODE>
157
158	<BR>
159	This disables the exclude filter by default.</TD>
160	</TR>
161	<TR BGCOLOR="white" CLASS="TableRowColor">
162	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
163	<CODE>static java.lang.String</CODE></FONT></TD>
164	<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/scm/AntStarTeamCheckOut.html#DEFAULT_FOLDERSETTING">DEFAULT_FOLDERSETTING</A></B></CODE>
165
166	<BR>
167	The default folder to search; the root folder.</TD>
168	</TR>
169	<TR BGCOLOR="white" CLASS="TableRowColor">
170	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
171	<CODE>static java.lang.String</CODE></FONT></TD>
172	<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/scm/AntStarTeamCheckOut.html#DEFAULT_INCLUDESETTING">DEFAULT_INCLUDESETTING</A></B></CODE>
173
174	<BR>
175	This constant sets the filter to include all files.</TD>
176	</TR>
177	</TABLE>
178	<A NAME="fields_inherited_from_class_org.apache.tools.ant.Task"><!-- --></A>
179	<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
180	<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
181	<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>
182	</TR>
183	<TR BGCOLOR="white" CLASS="TableRowColor">
184	<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>
185	</TR>
186	</TABLE>
187	<A NAME="fields_inherited_from_class_org.apache.tools.ant.ProjectComponent"><!-- --></A>
188	<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
189	<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
190	<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>
191	</TR>
192	<TR BGCOLOR="white" CLASS="TableRowColor">
193	<TD><CODE><A HREF="../../../../../../../org/apache/tools/ant/ProjectComponent.html#project">project</A></CODE></TD>
194	</TR>
195	</TABLE>
196
197	<!-- ======== CONSTRUCTOR SUMMARY ======== -->
198
199	<A NAME="constructor_summary"><!-- --></A>
200	<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
201	<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
202	<TD COLSPAN=2><FONT SIZE="+2">
203	<B>Constructor Summary</B></FONT></TD>
204	</TR>
205	<TR BGCOLOR="white" CLASS="TableRowColor">
206	<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/scm/AntStarTeamCheckOut.html#AntStarTeamCheckOut()">AntStarTeamCheckOut</A></B>()</CODE>
207
208	<BR>
209	</TD>
210	</TR>
211	</TABLE>
212
213	<!-- ========== METHOD SUMMARY =========== -->
214
215	<A NAME="method_summary"><!-- --></A>
216	<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
217	<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
218	<TD COLSPAN=2><FONT SIZE="+2">
219	<B>Method Summary</B></FONT></TD>
220	</TR>
221	<TR BGCOLOR="white" CLASS="TableRowColor">
222	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
223	<CODE>protected  void</CODE></FONT></TD>
224	<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/scm/AntStarTeamCheckOut.html#checkParameters()">checkParameters</A></B>()</CODE>
225
226	<BR>
227	</TD>
228	</TR>
229	<TR BGCOLOR="white" CLASS="TableRowColor">
230	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
231	<CODE> void</CODE></FONT></TD>
232	<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/scm/AntStarTeamCheckOut.html#execute()">execute</A></B>()</CODE>
233
234	<BR>
235	Do the execution.</TD>
236	</TR>
237	<TR BGCOLOR="white" CLASS="TableRowColor">
238	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
239	<CODE>protected  java.lang.String</CODE></FONT></TD>
240	<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/scm/AntStarTeamCheckOut.html#formatForDisplay(Property, java.lang.Object)">formatForDisplay</A></B>(Property p,
241	java.lang.Object value)</CODE>
242
243	<BR>
244	Formats a property value for display to the user.</TD>
245	</TR>
246	<TR BGCOLOR="white" CLASS="TableRowColor">
247	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
248	<CODE> java.lang.String</CODE></FONT></TD>
249	<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/scm/AntStarTeamCheckOut.html#getExcludes()">getExcludes</A></B>()</CODE>
250
251	<BR>
252	Gets the patterns from the exclude filter.</TD>
253	</TR>
254	<TR BGCOLOR="white" CLASS="TableRowColor">
255	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
256	<CODE> java.lang.String</CODE></FONT></TD>
257	<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/scm/AntStarTeamCheckOut.html#getFolderName()">getFolderName</A></B>()</CODE>
258
259	<BR>
260	Gets the <CODE>folderName</CODE> attribute.</TD>
261	</TR>
262	<TR BGCOLOR="white" CLASS="TableRowColor">
263	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
264	<CODE> boolean</CODE></FONT></TD>
265	<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/scm/AntStarTeamCheckOut.html#getForce()">getForce</A></B>()</CODE>
266
267	<BR>
268	Gets the <CODE>force</CODE> attribute.</TD>
269	</TR>
270	<TR BGCOLOR="white" CLASS="TableRowColor">
271	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
272	<CODE> java.lang.String</CODE></FONT></TD>
273	<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/scm/AntStarTeamCheckOut.html#getIncludes()">getIncludes</A></B>()</CODE>
274
275	<BR>
276	Gets the patterns from the include filter.</TD>
277	</TR>
278	<TR BGCOLOR="white" CLASS="TableRowColor">
279	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
280	<CODE> java.lang.String</CODE></FONT></TD>
281	<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/scm/AntStarTeamCheckOut.html#getPassword()">getPassword</A></B>()</CODE>
282
283	<BR>
284	Gets the <CODE>password</CODE> attribute.</TD>
285	</TR>
286	<TR BGCOLOR="white" CLASS="TableRowColor">
287	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
288	<CODE>protected  Property</CODE></FONT></TD>
289	<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/scm/AntStarTeamCheckOut.html#getPrimaryDescriptor(Type)">getPrimaryDescriptor</A></B>(Type t)</CODE>
290
291	<BR>
292	Get the primary descriptor of the given item type.</TD>
293	</TR>
294	<TR BGCOLOR="white" CLASS="TableRowColor">
295	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
296	<CODE> java.lang.String</CODE></FONT></TD>
297	<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/scm/AntStarTeamCheckOut.html#getProjectName()">getProjectName</A></B>()</CODE>
298
299	<BR>
300	Gets the <CODE>projectName</CODE> attribute.</TD>
301	</TR>
302	<TR BGCOLOR="white" CLASS="TableRowColor">
303	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
304	<CODE> boolean</CODE></FONT></TD>
305	<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/scm/AntStarTeamCheckOut.html#getRecursion()">getRecursion</A></B>()</CODE>
306
307	<BR>
308	Gets the <CODE>recursion</CODE> attribute, which tells
309	AntStarTeamCheckOut whether to search subfolders when checking out
310	files.</TD>
311	</TR>
312	<TR BGCOLOR="white" CLASS="TableRowColor">
313	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
314	<CODE>protected  Property</CODE></FONT></TD>
315	<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/scm/AntStarTeamCheckOut.html#getSecondaryDescriptor(Type)">getSecondaryDescriptor</A></B>(Type t)</CODE>
316
317	<BR>
318	Get the secondary descriptor of the given item type.</TD>
319	</TR>
320	<TR BGCOLOR="white" CLASS="TableRowColor">
321	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
322	<CODE>protected  Server</CODE></FONT></TD>
323	<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/scm/AntStarTeamCheckOut.html#getServer()">getServer</A></B>()</CODE>
324
325	<BR>
326	Creates and logs in to a StarTeam server.</TD>
327	</TR>
328	<TR BGCOLOR="white" CLASS="TableRowColor">
329	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
330	<CODE> java.lang.String</CODE></FONT></TD>
331	<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/scm/AntStarTeamCheckOut.html#getServerName()">getServerName</A></B>()</CODE>
332
333	<BR>
334	Gets the <CODE>serverName</CODE> attribute.</TD>
335	</TR>
336	<TR BGCOLOR="white" CLASS="TableRowColor">
337	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
338	<CODE> int</CODE></FONT></TD>
339	<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/scm/AntStarTeamCheckOut.html#getServerPort()">getServerPort</A></B>()</CODE>
340
341	<BR>
342	Gets the <CODE>serverPort</CODE> attribute.</TD>
343	</TR>
344	<TR BGCOLOR="white" CLASS="TableRowColor">
345	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
346	<CODE> java.lang.String</CODE></FONT></TD>
347	<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/scm/AntStarTeamCheckOut.html#getTargetFolder()">getTargetFolder</A></B>()</CODE>
348
349	<BR>
350	Gets the <CODE>targetFolder</CODE> attribute.</TD>
351	</TR>
352	<TR BGCOLOR="white" CLASS="TableRowColor">
353	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
354	<CODE> boolean</CODE></FONT></TD>
355	<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/scm/AntStarTeamCheckOut.html#getTargetFolderAbsolute()">getTargetFolderAbsolute</A></B>()</CODE>
356
357	<BR>
358	returns whether the StarTeam default path is factored into calculated
359	target path locations (false) or whether targetFolder is an absolute
360	mapping to the root folder named by folderName</TD>
361	</TR>
362	<TR BGCOLOR="white" CLASS="TableRowColor">
363	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
364	<CODE> java.lang.String</CODE></FONT></TD>
365	<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/scm/AntStarTeamCheckOut.html#getUsername()">getUsername</A></B>()</CODE>
366
367	<BR>
368	Gets the <CODE>username</CODE> attribute.</TD>
369	</TR>
370	<TR BGCOLOR="white" CLASS="TableRowColor">
371	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
372	<CODE> boolean</CODE></FONT></TD>
373	<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/scm/AntStarTeamCheckOut.html#getVerbose()">getVerbose</A></B>()</CODE>
374
375	<BR>
376	Gets the <CODE>verbose</CODE> attribute.</TD>
377	</TR>
378	<TR BGCOLOR="white" CLASS="TableRowColor">
379	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
380	<CODE> java.lang.String</CODE></FONT></TD>
381	<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/scm/AntStarTeamCheckOut.html#getViewName()">getViewName</A></B>()</CODE>
382
383	<BR>
384	Gets the <CODE>viewName</CODE> attribute.</TD>
385	</TR>
386	<TR BGCOLOR="white" CLASS="TableRowColor">
387	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
388	<CODE>protected  boolean</CODE></FONT></TD>
389	<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/scm/AntStarTeamCheckOut.html#matchPatterns(java.lang.String, java.lang.String)">matchPatterns</A></B>(java.lang.String patterns,
390	java.lang.String pName)</CODE>
391
392	<BR>
393	Convenient method to see if a string match a one pattern in given set
394	of space-separated patterns.</TD>
395	</TR>
396	<TR BGCOLOR="white" CLASS="TableRowColor">
397	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
398	<CODE>protected  void</CODE></FONT></TD>
399	<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/scm/AntStarTeamCheckOut.html#runFolder(Server, com.starbase.starteam.Project, View, Type, Folder, java.io.File)">runFolder</A></B>(Server s,
400	com.starbase.starteam.Project p,
401	View v,
402	Type t,
403	Folder f,
404	java.io.File tgt)</CODE>
405
406	<BR>
407	Searches for files in the given folder.</TD>
408	</TR>
409	<TR BGCOLOR="white" CLASS="TableRowColor">
410	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
411	<CODE>protected  void</CODE></FONT></TD>
412	<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/scm/AntStarTeamCheckOut.html#runItem(Server, com.starbase.starteam.Project, View, Type, Folder, Item, java.io.File)">runItem</A></B>(Server s,
413	com.starbase.starteam.Project p,
414	View v,
415	Type t,
416	Folder f,
417	Item item,
418	java.io.File tgt)</CODE>
419
420	<BR>
421	Check out one file if it matches the include filter but not the exclude
422	filter.</TD>
423	</TR>
424	<TR BGCOLOR="white" CLASS="TableRowColor">
425	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
426	<CODE>protected  void</CODE></FONT></TD>
427	<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/scm/AntStarTeamCheckOut.html#runProject(Server, com.starbase.starteam.Project)">runProject</A></B>(Server s,
428	com.starbase.starteam.Project p)</CODE>
429
430	<BR>
431	Searches for the given view in the project.</TD>
432	</TR>
433	<TR BGCOLOR="white" CLASS="TableRowColor">
434	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
435	<CODE>protected  void</CODE></FONT></TD>
436	<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/scm/AntStarTeamCheckOut.html#runServer(Server)">runServer</A></B>(Server s)</CODE>
437
438	<BR>
439	Searches for the specified project on the server.</TD>
440	</TR>
441	<TR BGCOLOR="white" CLASS="TableRowColor">
442	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
443	<CODE>protected  void</CODE></FONT></TD>
444	<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/scm/AntStarTeamCheckOut.html#runType(Server, com.starbase.starteam.Project, View, Type)">runType</A></B>(Server s,
445	com.starbase.starteam.Project p,
446	View v,
447	Type t)</CODE>
448
449	<BR>
450	Searches for folders in the given view.</TD>
451	</TR>
452	<TR BGCOLOR="white" CLASS="TableRowColor">
453	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
454	<CODE> void</CODE></FONT></TD>
455	<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/scm/AntStarTeamCheckOut.html#setExcludes(java.lang.String)">setExcludes</A></B>(java.lang.String excludes)</CODE>
456
457	<BR>
458	Sets the exclude filter.</TD>
459	</TR>
460	<TR BGCOLOR="white" CLASS="TableRowColor">
461	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
462	<CODE> void</CODE></FONT></TD>
463	<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/scm/AntStarTeamCheckOut.html#setFolderName(java.lang.String)">setFolderName</A></B>(java.lang.String folderName)</CODE>
464
465	<BR>
466	Sets the <CODE>folderName</CODE> attribute to the given value.</TD>
467	</TR>
468	<TR BGCOLOR="white" CLASS="TableRowColor">
469	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
470	<CODE> void</CODE></FONT></TD>
471	<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/scm/AntStarTeamCheckOut.html#setForce(boolean)">setForce</A></B>(boolean force)</CODE>
472
473	<BR>
474	Sets the <CODE>force</CODE> attribute to the given value.</TD>
475	</TR>
476	<TR BGCOLOR="white" CLASS="TableRowColor">
477	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
478	<CODE> void</CODE></FONT></TD>
479	<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/scm/AntStarTeamCheckOut.html#setIncludes(java.lang.String)">setIncludes</A></B>(java.lang.String includes)</CODE>
480
481	<BR>
482	Sets the include filter.</TD>
483	</TR>
484	<TR BGCOLOR="white" CLASS="TableRowColor">
485	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
486	<CODE> void</CODE></FONT></TD>
487	<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/scm/AntStarTeamCheckOut.html#setPassword(java.lang.String)">setPassword</A></B>(java.lang.String password)</CODE>
488
489	<BR>
490	Sets the <CODE>password</CODE> attribute to the given value.</TD>
491	</TR>
492	<TR BGCOLOR="white" CLASS="TableRowColor">
493	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
494	<CODE> void</CODE></FONT></TD>
495	<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/scm/AntStarTeamCheckOut.html#setProjectName(java.lang.String)">setProjectName</A></B>(java.lang.String projectName)</CODE>
496
497	<BR>
498	Sets the <CODE>projectName</CODE> attribute to the given value.</TD>
499	</TR>
500	<TR BGCOLOR="white" CLASS="TableRowColor">
501	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
502	<CODE> void</CODE></FONT></TD>
503	<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/scm/AntStarTeamCheckOut.html#setRecursion(boolean)">setRecursion</A></B>(boolean recursion)</CODE>
504
505	<BR>
506	Turns recursion on or off.</TD>
507	</TR>
508	<TR BGCOLOR="white" CLASS="TableRowColor">
509	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
510	<CODE> void</CODE></FONT></TD>
511	<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/scm/AntStarTeamCheckOut.html#setServerName(java.lang.String)">setServerName</A></B>(java.lang.String serverName)</CODE>
512
513	<BR>
514	Sets the <CODE>serverName</CODE> attribute to the given value.</TD>
515	</TR>
516	<TR BGCOLOR="white" CLASS="TableRowColor">
517	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
518	<CODE> void</CODE></FONT></TD>
519	<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/scm/AntStarTeamCheckOut.html#setServerPort(int)">setServerPort</A></B>(int serverPort)</CODE>
520
521	<BR>
522	Sets the <CODE>serverPort</CODE> attribute to the given value.</TD>
523	</TR>
524	<TR BGCOLOR="white" CLASS="TableRowColor">
525	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
526	<CODE> void</CODE></FONT></TD>
527	<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/scm/AntStarTeamCheckOut.html#setTargetFolder(java.lang.String)">setTargetFolder</A></B>(java.lang.String targetFolder)</CODE>
528
529	<BR>
530	Sets the <CODE>targetFolder</CODE> attribute to the given value.</TD>
531	</TR>
532	<TR BGCOLOR="white" CLASS="TableRowColor">
533	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
534	<CODE> void</CODE></FONT></TD>
535	<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/scm/AntStarTeamCheckOut.html#setTargetFolderAbsolute(boolean)">setTargetFolderAbsolute</A></B>(boolean targetFolderAbsolute)</CODE>
536
537	<BR>
538	sets the property that indicates whether or not the Star Team "default
539	folder" is to be used when calculation paths for items on the target
540	(false) or if targetFolder is an absolute mapping to the root folder
541	named by foldername.</TD>
542	</TR>
543	<TR BGCOLOR="white" CLASS="TableRowColor">
544	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
545	<CODE> void</CODE></FONT></TD>
546	<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/scm/AntStarTeamCheckOut.html#setUsername(java.lang.String)">setUsername</A></B>(java.lang.String username)</CODE>
547
548	<BR>
549	Sets the <CODE>username</CODE> attribute to the given value.</TD>
550	</TR>
551	<TR BGCOLOR="white" CLASS="TableRowColor">
552	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
553	<CODE> void</CODE></FONT></TD>
554	<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/scm/AntStarTeamCheckOut.html#setVerbose(boolean)">setVerbose</A></B>(boolean verbose)</CODE>
555
556	<BR>
557	Sets the <CODE>verbose</CODE> attribute to the given value.</TD>
558	</TR>
559	<TR BGCOLOR="white" CLASS="TableRowColor">
560	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
561	<CODE> void</CODE></FONT></TD>
562	<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/scm/AntStarTeamCheckOut.html#setViewName(java.lang.String)">setViewName</A></B>(java.lang.String viewName)</CODE>
563
564	<BR>
565	Sets the <CODE>viewName</CODE> attribute to the given value.</TD>
566	</TR>
567	<TR BGCOLOR="white" CLASS="TableRowColor">
568	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
569	<CODE>protected  boolean</CODE></FONT></TD>
570	<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/scm/AntStarTeamCheckOut.html#shouldCheckout(java.lang.String)">shouldCheckout</A></B>(java.lang.String pName)</CODE>
571
572	<BR>
573	Look if the file should be checked out.</TD>
574	</TR>
575	</TABLE>
576	<A NAME="methods_inherited_from_class_org.apache.tools.ant.Task"><!-- --></A>
577	<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
578	<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
579	<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>
580	</TR>
581	<TR BGCOLOR="white" CLASS="TableRowColor">
582	<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>
583	</TR>
584	</TABLE>
585	<A NAME="methods_inherited_from_class_org.apache.tools.ant.ProjectComponent"><!-- --></A>
586	<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
587	<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
588	<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>
589	</TR>
590	<TR BGCOLOR="white" CLASS="TableRowColor">
591	<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>
592	</TR>
593	</TABLE>
594	<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
595	<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
596	<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
597	<TD><B>Methods inherited from class java.lang.Object</B></TD>
598	</TR>
599	<TR BGCOLOR="white" CLASS="TableRowColor">
600	<TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
601	</TR>
602	</TABLE>
603
604	<P>
605
606	<!-- ============ FIELD DETAIL =========== -->
607
608	<A NAME="field_detail"><!-- --></A>
609	<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
610	<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
611	<TD COLSPAN=1><FONT SIZE="+2">
612	<B>Field Detail</B></FONT></TD>
613	</TR>
614	</TABLE>
615
616	<A NAME="DEFAULT_INCLUDESETTING"><!-- --></A><H3>
617	DEFAULT_INCLUDESETTING</H3>
618	<PRE>
619	public static final java.lang.String <B>DEFAULT_INCLUDESETTING</B></PRE>
620	<DL>
621	<DD>This constant sets the filter to include all files. This default has
622	the same result as <CODE>setIncludes("*")</CODE>.
623	<P>
624	<DL>
625	<DT><B>See Also:</B><DD><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/scm/AntStarTeamCheckOut.html#getIncludes()"><CODE>getIncludes()</CODE></A>,
626	<A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/scm/AntStarTeamCheckOut.html#setIncludes(java.lang.String)"><CODE>setIncludes(String includes)</CODE></A>,
627	<A HREF="../../../../../../../constant-values.html#org.apache.tools.ant.taskdefs.optional.scm.AntStarTeamCheckOut.DEFAULT_INCLUDESETTING">Constant Field Values</A></DL>
628	</DL>
629	<HR>
630
631	<A NAME="DEFAULT_EXCLUDESETTING"><!-- --></A><H3>
632	DEFAULT_EXCLUDESETTING</H3>
633	<PRE>
634	public static final java.lang.String <B>DEFAULT_EXCLUDESETTING</B></PRE>
635	<DL>
636	<DD>This disables the exclude filter by default. In other words, no files
637	are excluded. This setting is equivalent to <CODE>setExcludes(null)</CODE>
638	.
639	<P>
640	<DL>
641	<DT><B>See Also:</B><DD><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/scm/AntStarTeamCheckOut.html#getExcludes()"><CODE>getExcludes()</CODE></A>,
642	<A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/scm/AntStarTeamCheckOut.html#setExcludes(java.lang.String)"><CODE>setExcludes(String excludes)</CODE></A></DL>
643	</DL>
644	<HR>
645
646	<A NAME="DEFAULT_FOLDERSETTING"><!-- --></A><H3>
647	DEFAULT_FOLDERSETTING</H3>
648	<PRE>
649	public static final java.lang.String <B>DEFAULT_FOLDERSETTING</B></PRE>
650	<DL>
651	<DD>The default folder to search; the root folder. Since
652	AntStarTeamCheckOut searches subfolders, by default it processes an
653	entire view.
654	<P>
655	<DL>
656	<DT><B>See Also:</B><DD><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/scm/AntStarTeamCheckOut.html#getFolderName()"><CODE>getFolderName()</CODE></A>,
657	<A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/scm/AntStarTeamCheckOut.html#setFolderName(java.lang.String)"><CODE>setFolderName(String folderName)</CODE></A></DL>
658	</DL>
659
660	<!-- ========= CONSTRUCTOR DETAIL ======== -->
661
662	<A NAME="constructor_detail"><!-- --></A>
663	<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
664	<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
665	<TD COLSPAN=1><FONT SIZE="+2">
666	<B>Constructor Detail</B></FONT></TD>
667	</TR>
668	</TABLE>
669
670	<A NAME="AntStarTeamCheckOut()"><!-- --></A><H3>
671	AntStarTeamCheckOut</H3>
672	<PRE>
673	public <B>AntStarTeamCheckOut</B>()</PRE>
674	<DL>
675	</DL>
676
677	<!-- ============ METHOD DETAIL ========== -->
678
679	<A NAME="method_detail"><!-- --></A>
680	<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
681	<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
682	<TD COLSPAN=1><FONT SIZE="+2">
683	<B>Method Detail</B></FONT></TD>
684	</TR>
685	</TABLE>
686
687	<A NAME="checkParameters()"><!-- --></A><H3>
688	checkParameters</H3>
689	<PRE>
690	protected void <B>checkParameters</B>()
691	throws <A HREF="../../../../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</A></PRE>
692	<DL>
693	<DD><DL>
694
695	<DT><B>Throws:</B>
696	<DD><CODE><A HREF="../../../../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</A></CODE></DL>
697	</DD>
698	</DL>
699	<HR>
700
701	<A NAME="execute()"><!-- --></A><H3>
702	execute</H3>
703	<PRE>
704	public void <B>execute</B>()
705	throws <A HREF="../../../../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</A></PRE>
706	<DL>
707	<DD>Do the execution.
708	<P>
709	<DD><DL>
710	<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>
711	</DD>
712	<DD><DL>
713
714	<DT><B>Throws:</B>
715	<DD><CODE><A HREF="../../../../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</A></CODE></DL>
716	</DD>
717	</DL>
718	<HR>
719
720	<A NAME="getServer()"><!-- --></A><H3>
721	getServer</H3>
722	<PRE>
723	protected Server <B>getServer</B>()</PRE>
724	<DL>
725	<DD>Creates and logs in to a StarTeam server.
726	<P>
727	<DD><DL>
728
729	<DT><B>Returns:</B><DD>A StarTeam server.</DL>
730	</DD>
731	</DL>
732	<HR>
733
734	<A NAME="runServer(Server)"><!-- --></A><H3>
735	runServer</H3>
736	<PRE>
737	protected void <B>runServer</B>(Server s)</PRE>
738	<DL>
739	<DD>Searches for the specified project on the server.
740	<P>
741	<DD><DL>
742	<DT><B>Parameters:</B><DD><CODE>s</CODE> - A StarTeam server.</DL>
743	</DD>
744	</DL>
745	<HR>
746
747	<A NAME="runProject(Server, com.starbase.starteam.Project)"><!-- --></A><H3>
748	runProject</H3>
749	<PRE>
750	protected void <B>runProject</B>(Server s,
751	com.starbase.starteam.Project p)</PRE>
752	<DL>
753	<DD>Searches for the given view in the project.
754	<P>
755	<DD><DL>
756	<DT><B>Parameters:</B><DD><CODE>s</CODE> - A StarTeam server.<DD><CODE>p</CODE> - A valid project on the given server.</DL>
757	</DD>
758	</DL>
759	<HR>
760
761	<A NAME="runType(Server, com.starbase.starteam.Project, View, Type)"><!-- --></A><H3>
762	runType</H3>
763	<PRE>
764	protected void <B>runType</B>(Server s,
765	com.starbase.starteam.Project p,
766	View v,
767	Type t)</PRE>
768	<DL>
769	<DD>Searches for folders in the given view.
770	<P>
771	<DD><DL>
772	<DT><B>Parameters:</B><DD><CODE>s</CODE> - A StarTeam server.<DD><CODE>p</CODE> - A valid project on the server.<DD><CODE>v</CODE> - A view name from the specified project.<DD><CODE>t</CODE> - An item type which is currently always "file".</DL>
773	</DD>
774	</DL>
775	<HR>
776
777	<A NAME="runFolder(Server, com.starbase.starteam.Project, View, Type, Folder, java.io.File)"><!-- --></A><H3>
778	runFolder</H3>
779	<PRE>
780	protected void <B>runFolder</B>(Server s,
781	com.starbase.starteam.Project p,
782	View v,
783	Type t,
784	Folder f,
785	java.io.File tgt)</PRE>
786	<DL>
787	<DD>Searches for files in the given folder. This method is recursive and
788	thus searches all subfolders.
789	<P>
790	<DD><DL>
791	<DT><B>Parameters:</B><DD><CODE>s</CODE> - A StarTeam server.<DD><CODE>p</CODE> - A valid project on the server.<DD><CODE>v</CODE> - A view name from the specified project.<DD><CODE>t</CODE> - An item type which is currently always "file".<DD><CODE>f</CODE> - The folder to search.<DD><CODE>tgt</CODE> - Target folder on local machine</DL>
792	</DD>
793	</DL>
794	<HR>
795
796	<A NAME="runItem(Server, com.starbase.starteam.Project, View, Type, Folder, Item, java.io.File)"><!-- --></A><H3>
797	runItem</H3>
798	<PRE>
799	protected void <B>runItem</B>(Server s,
800	com.starbase.starteam.Project p,
801	View v,
802	Type t,
803	Folder f,
804	Item item,
805	java.io.File tgt)</PRE>
806	<DL>
807	<DD>Check out one file if it matches the include filter but not the exclude
808	filter.
809	<P>
810	<DD><DL>
811	<DT><B>Parameters:</B><DD><CODE>s</CODE> - A StarTeam server.<DD><CODE>p</CODE> - A valid project on the server.<DD><CODE>v</CODE> - A view name from the specified project.<DD><CODE>t</CODE> - An item type which is currently always "file".<DD><CODE>f</CODE> - The folder the file is localed in.<DD><CODE>item</CODE> - The file to check out.<DD><CODE>tgt</CODE> - target folder on local machine</DL>
812	</DD>
813	</DL>
814	<HR>
815
816	<A NAME="shouldCheckout(java.lang.String)"><!-- --></A><H3>
817	shouldCheckout</H3>
818	<PRE>
819	protected boolean <B>shouldCheckout</B>(java.lang.String pName)</PRE>
820	<DL>
821	<DD>Look if the file should be checked out. Don't check it out if It fits
822	no include filters and It fits an exclude filter.
823	<P>
824	<DD><DL>
825	<DT><B>Parameters:</B><DD><CODE>pName</CODE> - the item name to look for being included.
826	<DT><B>Returns:</B><DD>whether the file should be checked out or not.</DL>
827	</DD>
828	</DL>
829	<HR>
830
831	<A NAME="matchPatterns(java.lang.String, java.lang.String)"><!-- --></A><H3>
832	matchPatterns</H3>
833	<PRE>
834	protected boolean <B>matchPatterns</B>(java.lang.String patterns,
835	java.lang.String pName)</PRE>
836	<DL>
837	<DD>Convenient method to see if a string match a one pattern in given set
838	of space-separated patterns.
839	<P>
840	<DD><DL>
841	<DT><B>Parameters:</B><DD><CODE>patterns</CODE> - the space-separated list of patterns.<DD><CODE>pName</CODE> - the name to look for matching.
842	<DT><B>Returns:</B><DD>whether the name match at least one pattern.</DL>
843	</DD>
844	</DL>
845	<HR>
846
847	<A NAME="getPrimaryDescriptor(Type)"><!-- --></A><H3>
848	getPrimaryDescriptor</H3>
849	<PRE>
850	protected Property <B>getPrimaryDescriptor</B>(Type t)</PRE>
851	<DL>
852	<DD>Get the primary descriptor of the given item type. Returns null if
853	there isn't one. In practice, all item types have a primary descriptor.
854	<P>
855	<DD><DL>
856	<DT><B>Parameters:</B><DD><CODE>t</CODE> - An item type. At this point it will always be "file".
857	<DT><B>Returns:</B><DD>The specified item's primary descriptor.</DL>
858	</DD>
859	</DL>
860	<HR>
861
862	<A NAME="getSecondaryDescriptor(Type)"><!-- --></A><H3>
863	getSecondaryDescriptor</H3>
864	<PRE>
865	protected Property <B>getSecondaryDescriptor</B>(Type t)</PRE>
866	<DL>
867	<DD>Get the secondary descriptor of the given item type. Returns null if
868	there isn't one.
869	<P>
870	<DD><DL>
871	<DT><B>Parameters:</B><DD><CODE>t</CODE> - An item type. At this point it will always be "file".
872	<DT><B>Returns:</B><DD>The specified item's secondary descriptor. There may not be one
873	for every file.</DL>
874	</DD>
875	</DL>
876	<HR>
877
878	<A NAME="formatForDisplay(Property, java.lang.Object)"><!-- --></A><H3>
879	formatForDisplay</H3>
880	<PRE>
881	protected java.lang.String <B>formatForDisplay</B>(Property p,
882	java.lang.Object value)</PRE>
883	<DL>
884	<DD>Formats a property value for display to the user.
885	<P>
886	<DD><DL>
887	<DT><B>Parameters:</B><DD><CODE>p</CODE> - An item property to format.<DD><CODE>value</CODE> -
888	<DT><B>Returns:</B><DD>A string containing the property, which is truncated to 35
889	characters for display.</DL>
890	</DD>
891	</DL>
892	<HR>
893
894	<A NAME="setServerName(java.lang.String)"><!-- --></A><H3>
895	setServerName</H3>
896	<PRE>
897	public void <B>setServerName</B>(java.lang.String serverName)</PRE>
898	<DL>
899	<DD>Sets the <CODE>serverName</CODE> attribute to the given value.
900	<P>
901	<DD><DL>
902	<DT><B>Parameters:</B><DD><CODE>serverName</CODE> - The name of the server you wish to connect to.<DT><B>See Also:</B><DD><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/scm/AntStarTeamCheckOut.html#getServerName()"><CODE>getServerName()</CODE></A></DL>
903	</DD>
904	</DL>
905	<HR>
906
907	<A NAME="getServerName()"><!-- --></A><H3>
908	getServerName</H3>
909	<PRE>
910	public java.lang.String <B>getServerName</B>()</PRE>
911	<DL>
912	<DD>Gets the <CODE>serverName</CODE> attribute.
913	<P>
914	<DD><DL>
915
916	<DT><B>Returns:</B><DD>The StarTeam server to log in to.<DT><B>See Also:</B><DD><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/scm/AntStarTeamCheckOut.html#setServerName(java.lang.String)"><CODE>setServerName(String serverName)</CODE></A></DL>
917	</DD>
918	</DL>
919	<HR>
920
921	<A NAME="setServerPort(int)"><!-- --></A><H3>
922	setServerPort</H3>
923	<PRE>
924	public void <B>setServerPort</B>(int serverPort)</PRE>
925	<DL>
926	<DD>Sets the <CODE>serverPort</CODE> attribute to the given value. The
927	given value must be a valid integer, but it must be a string object.
928	<P>
929	<DD><DL>
930	<DT><B>Parameters:</B><DD><CODE>serverPort</CODE> - A string containing the port on the StarTeam server
931	to use.<DT><B>See Also:</B><DD><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/scm/AntStarTeamCheckOut.html#getServerPort()"><CODE>getServerPort()</CODE></A></DL>
932	</DD>
933	</DL>
934	<HR>
935
936	<A NAME="getServerPort()"><!-- --></A><H3>
937	getServerPort</H3>
938	<PRE>
939	public int <B>getServerPort</B>()</PRE>
940	<DL>
941	<DD>Gets the <CODE>serverPort</CODE> attribute.
942	<P>
943	<DD><DL>
944
945	<DT><B>Returns:</B><DD>A string containing the port on the StarTeam server to use.<DT><B>See Also:</B><DD><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/scm/AntStarTeamCheckOut.html#setServerPort(int)"><CODE>setServerPort(int)</CODE></A></DL>
946	</DD>
947	</DL>
948	<HR>
949
950	<A NAME="setProjectName(java.lang.String)"><!-- --></A><H3>
951	setProjectName</H3>
952	<PRE>
953	public void <B>setProjectName</B>(java.lang.String projectName)</PRE>
954	<DL>
955	<DD>Sets the <CODE>projectName</CODE> attribute to the given value.
956	<P>
957	<DD><DL>
958	<DT><B>Parameters:</B><DD><CODE>projectName</CODE> - The StarTeam project to search.<DT><B>See Also:</B><DD><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/scm/AntStarTeamCheckOut.html#getProjectName()"><CODE>getProjectName()</CODE></A></DL>
959	</DD>
960	</DL>
961	<HR>
962
963	<A NAME="getProjectName()"><!-- --></A><H3>
964	getProjectName</H3>
965	<PRE>
966	public java.lang.String <B>getProjectName</B>()</PRE>
967	<DL>
968	<DD>Gets the <CODE>projectName</CODE> attribute.
969	<P>
970	<DD><DL>
971
972	<DT><B>Returns:</B><DD>The StarTeam project to search.<DT><B>See Also:</B><DD><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/scm/AntStarTeamCheckOut.html#setProjectName(java.lang.String)"><CODE>setProjectName(String projectName)</CODE></A></DL>
973	</DD>
974	</DL>
975	<HR>
976
977	<A NAME="setViewName(java.lang.String)"><!-- --></A><H3>
978	setViewName</H3>
979	<PRE>
980	public void <B>setViewName</B>(java.lang.String viewName)</PRE>
981	<DL>
982	<DD>Sets the <CODE>viewName</CODE> attribute to the given value.
983	<P>
984	<DD><DL>
985	<DT><B>Parameters:</B><DD><CODE>viewName</CODE> - The view to find the specified folder in.<DT><B>See Also:</B><DD><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/scm/AntStarTeamCheckOut.html#getViewName()"><CODE>getViewName()</CODE></A></DL>
986	</DD>
987	</DL>
988	<HR>
989
990	<A NAME="getViewName()"><!-- --></A><H3>
991	getViewName</H3>
992	<PRE>
993	public java.lang.String <B>getViewName</B>()</PRE>
994	<DL>
995	<DD>Gets the <CODE>viewName</CODE> attribute.
996	<P>
997	<DD><DL>
998
999	<DT><B>Returns:</B><DD>The view to find the specified folder in.<DT><B>See Also:</B><DD><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/scm/AntStarTeamCheckOut.html#setViewName(java.lang.String)"><CODE>setViewName(String viewName)</CODE></A></DL>
1000	</DD>
1001	</DL>
1002	<HR>
1003
1004	<A NAME="setFolderName(java.lang.String)"><!-- --></A><H3>
1005	setFolderName</H3>
1006	<PRE>
1007	public void <B>setFolderName</B>(java.lang.String folderName)</PRE>
1008	<DL>
1009	<DD>Sets the <CODE>folderName</CODE> attribute to the given value. To
1010	search the root folder, use a slash or backslash, or simply don't set a
1011	folder at all.
1012	<P>
1013	<DD><DL>
1014	<DT><B>Parameters:</B><DD><CODE>folderName</CODE> - The subfolder from which to check out files.<DT><B>See Also:</B><DD><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/scm/AntStarTeamCheckOut.html#getFolderName()"><CODE>getFolderName()</CODE></A></DL>
1015	</DD>
1016	</DL>
1017	<HR>
1018
1019	<A NAME="getFolderName()"><!-- --></A><H3>
1020	getFolderName</H3>
1021	<PRE>
1022	public java.lang.String <B>getFolderName</B>()</PRE>
1023	<DL>
1024	<DD>Gets the <CODE>folderName</CODE> attribute.
1025	<P>
1026	<DD><DL>
1027
1028	<DT><B>Returns:</B><DD>The subfolder from which to check out files. All subfolders
1029	will be searched, as well.<DT><B>See Also:</B><DD><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/scm/AntStarTeamCheckOut.html#setFolderName(java.lang.String)"><CODE>setFolderName(String folderName)</CODE></A></DL>
1030	</DD>
1031	</DL>
1032	<HR>
1033
1034	<A NAME="setUsername(java.lang.String)"><!-- --></A><H3>
1035	setUsername</H3>
1036	<PRE>
1037	public void <B>setUsername</B>(java.lang.String username)</PRE>
1038	<DL>
1039	<DD>Sets the <CODE>username</CODE> attribute to the given value.
1040	<P>
1041	<DD><DL>
1042	<DT><B>Parameters:</B><DD><CODE>username</CODE> - Your username for the specified StarTeam server.<DT><B>See Also:</B><DD><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/scm/AntStarTeamCheckOut.html#getUsername()"><CODE>getUsername()</CODE></A></DL>
1043	</DD>
1044	</DL>
1045	<HR>
1046
1047	<A NAME="getUsername()"><!-- --></A><H3>
1048	getUsername</H3>
1049	<PRE>
1050	public java.lang.String <B>getUsername</B>()</PRE>
1051	<DL>
1052	<DD>Gets the <CODE>username</CODE> attribute.
1053	<P>
1054	<DD><DL>
1055
1056	<DT><B>Returns:</B><DD>The username given by the user.<DT><B>See Also:</B><DD><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/scm/AntStarTeamCheckOut.html#setUsername(java.lang.String)"><CODE>setUsername(String username)</CODE></A></DL>
1057	</DD>
1058	</DL>
1059	<HR>
1060
1061	<A NAME="setPassword(java.lang.String)"><!-- --></A><H3>
1062	setPassword</H3>
1063	<PRE>
1064	public void <B>setPassword</B>(java.lang.String password)</PRE>
1065	<DL>
1066	<DD>Sets the <CODE>password</CODE> attribute to the given value.
1067	<P>
1068	<DD><DL>
1069	<DT><B>Parameters:</B><DD><CODE>password</CODE> - Your password for the specified StarTeam server.<DT><B>See Also:</B><DD><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/scm/AntStarTeamCheckOut.html#getPassword()"><CODE>getPassword()</CODE></A></DL>
1070	</DD>
1071	</DL>
1072	<HR>
1073
1074	<A NAME="getPassword()"><!-- --></A><H3>
1075	getPassword</H3>
1076	<PRE>
1077	public java.lang.String <B>getPassword</B>()</PRE>
1078	<DL>
1079	<DD>Gets the <CODE>password</CODE> attribute.
1080	<P>
1081	<DD><DL>
1082
1083	<DT><B>Returns:</B><DD>The password given by the user.<DT><B>See Also:</B><DD><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/scm/AntStarTeamCheckOut.html#setPassword(java.lang.String)"><CODE>setPassword(String password)</CODE></A></DL>
1084	</DD>
1085	</DL>
1086	<HR>
1087
1088	<A NAME="setTargetFolder(java.lang.String)"><!-- --></A><H3>
1089	setTargetFolder</H3>
1090	<PRE>
1091	public void <B>setTargetFolder</B>(java.lang.String targetFolder)</PRE>
1092	<DL>
1093	<DD>Sets the <CODE>targetFolder</CODE> attribute to the given value.
1094	<P>
1095	<DD><DL>
1096	<DT><B>Parameters:</B><DD><CODE>targetFolder</CODE> - The target path on the local machine to check out to.<DT><B>See Also:</B><DD><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/scm/AntStarTeamCheckOut.html#getTargetFolder()"><CODE>getTargetFolder()</CODE></A></DL>
1097	</DD>
1098	</DL>
1099	<HR>
1100
1101	<A NAME="getTargetFolder()"><!-- --></A><H3>
1102	getTargetFolder</H3>
1103	<PRE>
1104	public java.lang.String <B>getTargetFolder</B>()</PRE>
1105	<DL>
1106	<DD>Gets the <CODE>targetFolder</CODE> attribute.
1107	<P>
1108	<DD><DL>
1109
1110	<DT><B>Returns:</B><DD>The target path on the local machine to check out to.<DT><B>See Also:</B><DD><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/scm/AntStarTeamCheckOut.html#setTargetFolder(java.lang.String)"><CODE>setTargetFolder(String targetFolder)</CODE></A></DL>
1111	</DD>
1112	</DL>
1113	<HR>
1114
1115	<A NAME="setForce(boolean)"><!-- --></A><H3>
1116	setForce</H3>
1117	<PRE>
1118	public void <B>setForce</B>(boolean force)</PRE>
1119	<DL>
1120	<DD>Sets the <CODE>force</CODE> attribute to the given value.
1121	<P>
1122	<DD><DL>
1123	<DT><B>Parameters:</B><DD><CODE>force</CODE> - if true, it overwrites files in the target directory. By
1124	default it set to false as a safeguard. Note that if the target
1125	directory does not exist, this setting has no effect.<DT><B>See Also:</B><DD><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/scm/AntStarTeamCheckOut.html#getForce()"><CODE>getForce()</CODE></A></DL>
1126	</DD>
1127	</DL>
1128	<HR>
1129
1130	<A NAME="getForce()"><!-- --></A><H3>
1131	getForce</H3>
1132	<PRE>
1133	public boolean <B>getForce</B>()</PRE>
1134	<DL>
1135	<DD>Gets the <CODE>force</CODE> attribute.
1136	<P>
1137	<DD><DL>
1138
1139	<DT><B>Returns:</B><DD>whether to continue if the target directory exists.<DT><B>See Also:</B><DD><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/scm/AntStarTeamCheckOut.html#setForce(boolean)"><CODE>setForce(boolean)</CODE></A></DL>
1140	</DD>
1141	</DL>
1142	<HR>
1143
1144	<A NAME="setRecursion(boolean)"><!-- --></A><H3>
1145	setRecursion</H3>
1146	<PRE>
1147	public void <B>setRecursion</B>(boolean recursion)</PRE>
1148	<DL>
1149	<DD>Turns recursion on or off.
1150	<P>
1151	<DD><DL>
1152	<DT><B>Parameters:</B><DD><CODE>recursion</CODE> - if it is true, the default, subfolders are searched
1153	recursively for files to check out. Otherwise, only files
1154	specified by <CODE>folderName</CODE> are scanned.<DT><B>See Also:</B><DD><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/scm/AntStarTeamCheckOut.html#getRecursion()"><CODE>getRecursion()</CODE></A></DL>
1155	</DD>
1156	</DL>
1157	<HR>
1158
1159	<A NAME="getRecursion()"><!-- --></A><H3>
1160	getRecursion</H3>
1161	<PRE>
1162	public boolean <B>getRecursion</B>()</PRE>
1163	<DL>
1164	<DD>Gets the <CODE>recursion</CODE> attribute, which tells
1165	AntStarTeamCheckOut whether to search subfolders when checking out
1166	files.
1167	<P>
1168	<DD><DL>
1169
1170	<DT><B>Returns:</B><DD>whether to search subfolders when checking out files.<DT><B>See Also:</B><DD><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/scm/AntStarTeamCheckOut.html#setRecursion(boolean)"><CODE>setRecursion(boolean)</CODE></A></DL>
1171	</DD>
1172	</DL>
1173	<HR>
1174
1175	<A NAME="setVerbose(boolean)"><!-- --></A><H3>
1176	setVerbose</H3>
1177	<PRE>
1178	public void <B>setVerbose</B>(boolean verbose)</PRE>
1179	<DL>
1180	<DD>Sets the <CODE>verbose</CODE> attribute to the given value.
1181	<P>
1182	<DD><DL>
1183	<DT><B>Parameters:</B><DD><CODE>verbose</CODE> - whether to display all files as it checks them out. By
1184	default it is false, so the program only displays the total number
1185	of files unless you override this default.<DT><B>See Also:</B><DD><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/scm/AntStarTeamCheckOut.html#getVerbose()"><CODE>getVerbose()</CODE></A></DL>
1186	</DD>
1187	</DL>
1188	<HR>
1189
1190	<A NAME="getVerbose()"><!-- --></A><H3>
1191	getVerbose</H3>
1192	<PRE>
1193	public boolean <B>getVerbose</B>()</PRE>
1194	<DL>
1195	<DD>Gets the <CODE>verbose</CODE> attribute.
1196	<P>
1197	<DD><DL>
1198
1199	<DT><B>Returns:</B><DD>whether to display all files as it checks them out.<DT><B>See Also:</B><DD><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/scm/AntStarTeamCheckOut.html#setVerbose(boolean)"><CODE>setVerbose(boolean verbose)</CODE></A></DL>
1200	</DD>
1201	</DL>
1202	<HR>
1203
1204	<A NAME="setIncludes(java.lang.String)"><!-- --></A><H3>
1205	setIncludes</H3>
1206	<PRE>
1207	public void <B>setIncludes</B>(java.lang.String includes)</PRE>
1208	<DL>
1209	<DD>Sets the include filter. When filtering files, AntStarTeamCheckOut uses
1210	an unmodified version of <CODE>DirectoryScanner</CODE>'s <CODE>match</CODE>
1211	method, so here are the patterns straight from the Ant source code:
1212	<BR>
1213	<BR>
1214	Matches a string against a pattern. The pattern contains two special
1215	characters: <BR>
1216	'*' which means zero or more characters, <BR>
1217	'?' which means one and only one character. <BR>
1218	<BR>
1219	Separate multiple inlcude filters by <I>spaces</I> , not commas as Ant
1220	uses. For example, if you want to check out all .java and .class\
1221	files, you would put the following line in your program:
1222	<CODE>setIncludes(".java .class");</CODE>
1223	Finally, note that filters have no effect on the <B>directories</B>
1224	that are scanned; you could not check out files from directories with
1225	names beginning only with "build," for instance. Of course, you could
1226	limit AntStarTeamCheckOut to a particular folder and its subfolders
1227	with the <CODE>setFolderName(String folderName)</CODE> command. <BR>
1228	<BR>
1229	Treatment of overlapping inlcudes and excludes: To give a simplistic
1230	example suppose that you set your include filter to ".htm .html" and
1231	your exclude filter to "index.*". What happens to index.html?
1232	AntStarTeamCheckOut will not check out index.html, as it matches an
1233	exclude filter ("index.*"), even though it matches the include filter,
1234	as well. <BR>
1235	<BR>
1236	Please also read the following sections before using filters:
1237	<P>
1238	<DD><DL>
1239	<DT><B>Parameters:</B><DD><CODE>includes</CODE> - A string of filter patterns to include. Separate the
1240	patterns by spaces.<DT><B>See Also:</B><DD><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/scm/AntStarTeamCheckOut.html#getIncludes()"><CODE>getIncludes()</CODE></A>,
1241	<A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/scm/AntStarTeamCheckOut.html#setExcludes(java.lang.String)"><CODE>setExcludes(String excludes)</CODE></A>,
1242	<A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/scm/AntStarTeamCheckOut.html#getExcludes()"><CODE>getExcludes()</CODE></A></DL>
1243	</DD>
1244	</DL>
1245	<HR>
1246
1247	<A NAME="getIncludes()"><!-- --></A><H3>
1248	getIncludes</H3>
1249	<PRE>
1250	public java.lang.String <B>getIncludes</B>()</PRE>
1251	<DL>
1252	<DD>Gets the patterns from the include filter. Rather that duplicate the
1253	details of AntStarTeanCheckOut's filtering here, refer to these links:
1254	<P>
1255	<DD><DL>
1256
1257	<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/scm/AntStarTeamCheckOut.html#setIncludes(java.lang.String)"><CODE>setIncludes(String includes)</CODE></A>,
1258	<A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/scm/AntStarTeamCheckOut.html#setExcludes(java.lang.String)"><CODE>setExcludes(String excludes)</CODE></A>,
1259	<A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/scm/AntStarTeamCheckOut.html#getExcludes()"><CODE>getExcludes()</CODE></A></DL>
1260	</DD>
1261	</DL>
1262	<HR>
1263
1264	<A NAME="setExcludes(java.lang.String)"><!-- --></A><H3>
1265	setExcludes</H3>
1266	<PRE>
1267	public void <B>setExcludes</B>(java.lang.String excludes)</PRE>
1268	<DL>
1269	<DD>Sets the exclude filter. When filtering files, AntStarTeamCheckOut uses
1270	an unmodified version of <CODE>DirectoryScanner</CODE>'s <CODE>match</CODE>
1271	method, so here are the patterns straight from the Ant source code:
1272	<BR>
1273	<BR>
1274	Matches a string against a pattern. The pattern contains two special
1275	characters: <BR>
1276	'*' which means zero or more characters, <BR>
1277	'?' which means one and only one character. <BR>
1278	<BR>
1279	Separate multiple exlcude filters by <I>spaces</I> , not commas as Ant
1280	uses. For example, if you want to check out all files except .XML and
1281	.HTML files, you would put the following line in your program:
1282	<CODE>setExcludes(".XML .HTML");</CODE>
1283	Finally, note that filters have no effect on the <B>directories</B>
1284	that are scanned; you could not skip over all files in directories
1285	whose names begin with "project," for instance. <BR>
1286	<BR>
1287	Treatment of overlapping inlcudes and excludes: To give a simplistic
1288	example suppose that you set your include filter to ".htm .html" and
1289	your exclude filter to "index.*". What happens to index.html?
1290	AntStarTeamCheckOut will not check out index.html, as it matches an
1291	exclude filter ("index.*"), even though it matches the include filter,
1292	as well. <BR>
1293	<BR>
1294	Please also read the following sections before using filters:
1295	<P>
1296	<DD><DL>
1297	<DT><B>Parameters:</B><DD><CODE>excludes</CODE> - A string of filter patterns to exclude. Separate the
1298	patterns by spaces.<DT><B>See Also:</B><DD><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/scm/AntStarTeamCheckOut.html#setIncludes(java.lang.String)"><CODE>setIncludes(String includes)</CODE></A>,
1299	<A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/scm/AntStarTeamCheckOut.html#getIncludes()"><CODE>getIncludes()</CODE></A>,
1300	<A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/scm/AntStarTeamCheckOut.html#getExcludes()"><CODE>getExcludes()</CODE></A></DL>
1301	</DD>
1302	</DL>
1303	<HR>
1304
1305	<A NAME="getExcludes()"><!-- --></A><H3>
1306	getExcludes</H3>
1307	<PRE>
1308	public java.lang.String <B>getExcludes</B>()</PRE>
1309	<DL>
1310	<DD>Gets the patterns from the exclude filter. Rather that duplicate the
1311	details of AntStarTeanCheckOut's filtering here, refer to these links:
1312	<P>
1313	<DD><DL>
1314
1315	<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/scm/AntStarTeamCheckOut.html#setExcludes(java.lang.String)"><CODE>setExcludes(String excludes)</CODE></A>,
1316	<A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/scm/AntStarTeamCheckOut.html#setIncludes(java.lang.String)"><CODE>setIncludes(String includes)</CODE></A>,
1317	<A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/scm/AntStarTeamCheckOut.html#getIncludes()"><CODE>getIncludes()</CODE></A></DL>
1318	</DD>
1319	</DL>
1320	<HR>
1321
1322	<A NAME="getTargetFolderAbsolute()"><!-- --></A><H3>
1323	getTargetFolderAbsolute</H3>
1324	<PRE>
1325	public boolean <B>getTargetFolderAbsolute</B>()</PRE>
1326	<DL>
1327	<DD>returns whether the StarTeam default path is factored into calculated
1328	target path locations (false) or whether targetFolder is an absolute
1329	mapping to the root folder named by folderName
1330	<P>
1331	<DD><DL>
1332
1333	<DT><B>Returns:</B><DD>returns true if absolute mapping is used, false if it is not
1334	used.<DT><B>See Also:</B><DD><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/scm/AntStarTeamCheckOut.html#setTargetFolderAbsolute(boolean)"><CODE>setTargetFolderAbsolute(boolean)</CODE></A></DL>
1335	</DD>
1336	</DL>
1337	<HR>
1338
1339	<A NAME="setTargetFolderAbsolute(boolean)"><!-- --></A><H3>
1340	setTargetFolderAbsolute</H3>
1341	<PRE>
1342	public void <B>setTargetFolderAbsolute</B>(boolean targetFolderAbsolute)</PRE>
1343	<DL>
1344	<DD>sets the property that indicates whether or not the Star Team "default
1345	folder" is to be used when calculation paths for items on the target
1346	(false) or if targetFolder is an absolute mapping to the root folder
1347	named by foldername.
1348	<P>
1349	<DD><DL>
1350	<DT><B>Parameters:</B><DD><CODE>targetFolderAbsolute</CODE> - <tt>true</tt> if the absolute mapping is to
1351	be used. <tt>false</tt> (the default) if the "default folder" is
1352	to be factored in.<DT><B>See Also:</B><DD><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/scm/AntStarTeamCheckOut.html#getTargetFolderAbsolute()"><CODE>getTargetFolderAbsolute()</CODE></A></DL>
1353	</DD>
1354	</DL>
1355	<!-- ========= END OF CLASS DATA ========= -->
1356	<HR>
1357
1358
1359	<!-- ======= START OF BOTTOM NAVBAR ====== -->
1360	<A NAME="navbar_bottom"><!-- --></A>
1361	<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
1362	<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
1363	<TR>
1364	<TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
1365	<A NAME="navbar_bottom_firstrow"><!-- --></A>
1366	<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
1367	<TR ALIGN="center" VALIGN="top">
1368	<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
1369	<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
1370	<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev">  <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
1371	<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
1372	<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
1373	<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
1374	<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
1375	</TR>
1376	</TABLE>
1377	</TD>
1378	<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
1379	</EM>
1380	</TD>
1381	</TR>
1382
1383	<TR>
1384	<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
1385	PREV CLASS
1386	NEXT CLASS</FONT></TD>
1387	<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
1388	<A HREF="../../../../../../../index.html" target="_top"><B>FRAMES</B></A>
1389	<A HREF="AntStarTeamCheckOut.html" target="_top"><B>NO FRAMES</B></A>
1390	<SCRIPT type="text/javascript">
1391	<!--
1392	if(window==top) {
1393	document.writeln('<A HREF="../../../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
1394	}
1395	//-->
1396	</SCRIPT>
1397	<NOSCRIPT>
1398	<A HREF="../../../../../../../allclasses-noframe.html"><B>All Classes</B></A>
1399	</NOSCRIPT>
1400
1401	</FONT></TD>
1402	</TR>
1403	<TR>
1404	<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
1405	SUMMARY: NESTED \| <A HREF="#field_summary">FIELD</A> \| <A HREF="#constructor_summary">CONSTR</A> \| <A HREF="#method_summary">METHOD</A></FONT></TD>
1406	<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
1407	DETAIL: <A HREF="#field_detail">FIELD</A> \| <A HREF="#constructor_detail">CONSTR</A> \| <A HREF="#method_detail">METHOD</A></FONT></TD>
1408	</TR>
1409	</TABLE>
1410	<A NAME="skip-navbar_bottom"></A>
1411	<!-- ======== END OF BOTTOM NAVBAR ======= -->
1412
1413	<HR>
1414	Copyright Â© 2000-2007 Apache Software Foundation. All Rights Reserved.
1415	</BODY>
1416	</HTML>

Note: See TracBrowser for help on using the repository browser.

Download in other formats: