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

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

initial import of LiRK3
File size: 26.8 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>
7StarTeamLabel (Apache Ant API)
8</TITLE>
9
10<META NAME="keywords" CONTENT="org.apache.tools.ant.taskdefs.optional.starteam.StarTeamLabel 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="StarTeamLabel (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/StarTeamCheckout.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/StarTeamList.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="StarTeamLabel.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;<A HREF="#fields_inherited_from_class_org.apache.tools.ant.Task">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
73<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
74DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
75</TR>
76</TABLE>
77<A NAME="skip-navbar_top"></A>
78<!-- ========= END OF TOP NAVBAR ========= -->
79
80<HR>
81<!-- ======== START OF CLASS DATA ======== -->
82<H2>
83<FONT SIZE="-1">
84org.apache.tools.ant.taskdefs.optional.starteam</FONT>
85<BR>
86Class StarTeamLabel</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.StarTeamLabel</B>
93</PRE>
94<HR>
95<DL>
96<DT>public class <B>StarTeamLabel</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>
97
98<P>
99Creates a view label in StarTeam at the specified view.
100
101 Ant Usage:
102 <pre>
103 &lt;taskdef name="stlabel"
104 classname="org.apache.tools.ant.taskdefs.optional.starteam.StarTeamLabel"/&lt;
105 &lt;stlabel
106 label="1.0" lastbuild="20011514100000" description="Successful Build"
107 username="BuildMaster" password="ant"
108 starteamurl="server:port/project/view"/&gt;
109 </pre>
110<P>
111
112<P>
113<DL>
114<DT><B>See Also:</B><DD><A HREF="http://www.starbase.com/">StarBase Web Site</A></DL>
115<HR>
116
117<P>
118<!-- ======== NESTED CLASS SUMMARY ======== -->
119
120
121<!-- =========== FIELD SUMMARY =========== -->
122
123<A NAME="field_summary"><!-- --></A>
124<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
125<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
126<TD COLSPAN=2><FONT SIZE="+2">
127<B>Field Summary</B></FONT></TD>
128</TR>
129</TABLE>
130&nbsp;<A NAME="fields_inherited_from_class_org.apache.tools.ant.Task"><!-- --></A>
131<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
132<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
133<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>
134</TR>
135<TR BGCOLOR="white" CLASS="TableRowColor">
136<TD><CODE><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>
137</TR>
138</TABLE>
139&nbsp;<A NAME="fields_inherited_from_class_org.apache.tools.ant.ProjectComponent"><!-- --></A>
140<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
141<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
142<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>
143</TR>
144<TR BGCOLOR="white" CLASS="TableRowColor">
145<TD><CODE><A HREF="../../../../../../../org/apache/tools/ant/ProjectComponent.html#project">project</A></CODE></TD>
146</TR>
147</TABLE>
148&nbsp;
149<!-- ======== CONSTRUCTOR SUMMARY ======== -->
150
151<A NAME="constructor_summary"><!-- --></A>
152<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
153<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
154<TD COLSPAN=2><FONT SIZE="+2">
155<B>Constructor Summary</B></FONT></TD>
156</TR>
157<TR BGCOLOR="white" CLASS="TableRowColor">
158<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/starteam/StarTeamLabel.html#StarTeamLabel()">StarTeamLabel</A></B>()</CODE>
159
160<BR>
161&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
162</TR>
163</TABLE>
164&nbsp;
165<!-- ========== METHOD SUMMARY =========== -->
166
167<A NAME="method_summary"><!-- --></A>
168<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
169<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
170<TD COLSPAN=2><FONT SIZE="+2">
171<B>Method Summary</B></FONT></TD>
172</TR>
173<TR BGCOLOR="white" CLASS="TableRowColor">
174<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
175<CODE>protected &nbsp;View</CODE></FONT></TD>
176<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/starteam/StarTeamLabel.html#createSnapshotView(View)">createSnapshotView</A></B>(View&nbsp;raw)</CODE>
177
178<BR>
179&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Override of base-class abstract function creates an
180 appropriately configured view.</TD>
181</TR>
182<TR BGCOLOR="white" CLASS="TableRowColor">
183<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
184<CODE>&nbsp;void</CODE></FONT></TD>
185<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/starteam/StarTeamLabel.html#execute()">execute</A></B>()</CODE>
186
187<BR>
188&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;This method does the work of creating the new view and checking it into
189 Starteam.</TD>
190</TR>
191<TR BGCOLOR="white" CLASS="TableRowColor">
192<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
193<CODE>&nbsp;void</CODE></FONT></TD>
194<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/starteam/StarTeamLabel.html#setBuildLabel(boolean)">setBuildLabel</A></B>(boolean&nbsp;buildlabel)</CODE>
195
196<BR>
197&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;set the type of label based on the supplied value - if true, this
198 label will be a revision label, if false, a build label.</TD>
199</TR>
200<TR BGCOLOR="white" CLASS="TableRowColor">
201<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
202<CODE>&nbsp;void</CODE></FONT></TD>
203<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/starteam/StarTeamLabel.html#setDescription(java.lang.String)">setDescription</A></B>(java.lang.String&nbsp;description)</CODE>
204
205<BR>
206&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Description of the label to be stored in the StarTeam project.</TD>
207</TR>
208<TR BGCOLOR="white" CLASS="TableRowColor">
209<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
210<CODE>&nbsp;void</CODE></FONT></TD>
211<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/starteam/StarTeamLabel.html#setLabel(java.lang.String)">setLabel</A></B>(java.lang.String&nbsp;label)</CODE>
212
213<BR>
214&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The name to be given to the label; required.</TD>
215</TR>
216<TR BGCOLOR="white" CLASS="TableRowColor">
217<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
218<CODE>&nbsp;void</CODE></FONT></TD>
219<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/starteam/StarTeamLabel.html#setLastBuild(java.lang.String)">setLastBuild</A></B>(java.lang.String&nbsp;lastbuild)</CODE>
220
221<BR>
222&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The timestamp of the build that will be stored with the label; required.</TD>
223</TR>
224<TR BGCOLOR="white" CLASS="TableRowColor">
225<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
226<CODE>&nbsp;void</CODE></FONT></TD>
227<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/starteam/StarTeamLabel.html#setRevisionLabel(boolean)">setRevisionLabel</A></B>(boolean&nbsp;revisionlabel)</CODE>
228
229<BR>
230&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;set the type of label based on the supplied value - if true, this
231 label will be a revision label, if false, a build label.</TD>
232</TR>
233</TABLE>
234&nbsp;<A NAME="methods_inherited_from_class_org.apache.tools.ant.taskdefs.optional.starteam.StarTeamTask"><!-- --></A>
235<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
236<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
237<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>
238</TR>
239<TR BGCOLOR="white" CLASS="TableRowColor">
240<TD><CODE><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/starteam/StarTeamTask.html#disconnectFromServer()">disconnectFromServer</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/starteam/StarTeamTask.html#getPassword()">getPassword</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/starteam/StarTeamTask.html#getProjectname()">getProjectname</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/starteam/StarTeamTask.html#getServer()">getServer</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/starteam/StarTeamTask.html#getServername()">getServername</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/starteam/StarTeamTask.html#getServerport()">getServerport</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/starteam/StarTeamTask.html#getTypeNames()">getTypeNames</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/starteam/StarTeamTask.html#getURL()">getURL</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/starteam/StarTeamTask.html#getUserName()">getUserName</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/starteam/StarTeamTask.html#getUserName(int)">getUserName</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/starteam/StarTeamTask.html#getViewname()">getViewname</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/starteam/StarTeamTask.html#getViewURL()">getViewURL</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/starteam/StarTeamTask.html#openView()">openView</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/starteam/StarTeamTask.html#setPassword(java.lang.String)">setPassword</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/starteam/StarTeamTask.html#setProjectname(java.lang.String)">setProjectname</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/starteam/StarTeamTask.html#setServername(java.lang.String)">setServername</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/starteam/StarTeamTask.html#setServerport(java.lang.String)">setServerport</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/starteam/StarTeamTask.html#setURL(java.lang.String)">setURL</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/starteam/StarTeamTask.html#setUserName(java.lang.String)">setUserName</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/starteam/StarTeamTask.html#setViewname(java.lang.String)">setViewname</A></CODE></TD>
241</TR>
242</TABLE>
243&nbsp;<A NAME="methods_inherited_from_class_org.apache.tools.ant.Task"><!-- --></A>
244<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
245<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
246<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>
247</TR>
248<TR BGCOLOR="white" CLASS="TableRowColor">
249<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#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>
250</TR>
251</TABLE>
252&nbsp;<A NAME="methods_inherited_from_class_org.apache.tools.ant.ProjectComponent"><!-- --></A>
253<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
254<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
255<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>
256</TR>
257<TR BGCOLOR="white" CLASS="TableRowColor">
258<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>
259</TR>
260</TABLE>
261&nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
262<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
263<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
264<TD><B>Methods inherited from class java.lang.Object</B></TD>
265</TR>
266<TR BGCOLOR="white" CLASS="TableRowColor">
267<TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
268</TR>
269</TABLE>
270&nbsp;
271<P>
272
273<!-- ============ FIELD DETAIL =========== -->
274
275
276<!-- ========= CONSTRUCTOR DETAIL ======== -->
277
278<A NAME="constructor_detail"><!-- --></A>
279<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
280<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
281<TD COLSPAN=1><FONT SIZE="+2">
282<B>Constructor Detail</B></FONT></TD>
283</TR>
284</TABLE>
285
286<A NAME="StarTeamLabel()"><!-- --></A><H3>
287StarTeamLabel</H3>
288<PRE>
289public <B>StarTeamLabel</B>()</PRE>
290<DL>
291</DL>
292
293<!-- ============ METHOD DETAIL ========== -->
294
295<A NAME="method_detail"><!-- --></A>
296<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
297<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
298<TD COLSPAN=1><FONT SIZE="+2">
299<B>Method Detail</B></FONT></TD>
300</TR>
301</TABLE>
302
303<A NAME="setLabel(java.lang.String)"><!-- --></A><H3>
304setLabel</H3>
305<PRE>
306public void <B>setLabel</B>(java.lang.String&nbsp;label)</PRE>
307<DL>
308<DD>The name to be given to the label; required.
309<P>
310<DD><DL>
311</DL>
312</DD>
313</DL>
314<HR>
315
316<A NAME="setDescription(java.lang.String)"><!-- --></A><H3>
317setDescription</H3>
318<PRE>
319public void <B>setDescription</B>(java.lang.String&nbsp;description)</PRE>
320<DL>
321<DD>Description of the label to be stored in the StarTeam project.
322<P>
323<DD><DL>
324<DT><B>Overrides:</B><DD><CODE><A HREF="../../../../../../../org/apache/tools/ant/Task.html#setDescription(java.lang.String)">setDescription</A></CODE> in class <CODE><A HREF="../../../../../../../org/apache/tools/ant/Task.html" title="class in org.apache.tools.ant">Task</A></CODE></DL>
325</DD>
326<DD><DL>
327<DT><B>Parameters:</B><DD><CODE>description</CODE> - Description of the current action.
328 May be <code>null</code>, indicating that no description is
329 available.</DL>
330</DD>
331</DL>
332<HR>
333
334<A NAME="setBuildLabel(boolean)"><!-- --></A><H3>
335setBuildLabel</H3>
336<PRE>
337public void <B>setBuildLabel</B>(boolean&nbsp;buildlabel)</PRE>
338<DL>
339<DD>set the type of label based on the supplied value - if true, this
340 label will be a revision label, if false, a build label.
341<P>
342<DD><DL>
343<DT><B>Parameters:</B><DD><CODE>buildlabel</CODE> - If true this will be a revision label; if false,
344 a build label</DL>
345</DD>
346</DL>
347<HR>
348
349<A NAME="setRevisionLabel(boolean)"><!-- --></A><H3>
350setRevisionLabel</H3>
351<PRE>
352public void <B>setRevisionLabel</B>(boolean&nbsp;revisionlabel)</PRE>
353<DL>
354<DD>set the type of label based on the supplied value - if true, this
355 label will be a revision label, if false, a build label.
356<P>
357<DD><DL>
358<DT><B>Parameters:</B><DD><CODE>revisionlabel</CODE> - If true this will be a revision label; if false,
359 a build label</DL>
360</DD>
361</DL>
362<HR>
363
364<A NAME="setLastBuild(java.lang.String)"><!-- --></A><H3>
365setLastBuild</H3>
366<PRE>
367public void <B>setLastBuild</B>(java.lang.String&nbsp;lastbuild)
368 throws <A HREF="../../../../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</A></PRE>
369<DL>
370<DD>The timestamp of the build that will be stored with the label; required.
371 Must be formatted <code>yyyyMMddHHmmss</code>
372<P>
373<DD><DL>
374
375<DT><B>Throws:</B>
376<DD><CODE><A HREF="../../../../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</A></CODE></DL>
377</DD>
378</DL>
379<HR>
380
381<A NAME="execute()"><!-- --></A><H3>
382execute</H3>
383<PRE>
384public void <B>execute</B>()
385 throws <A HREF="../../../../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</A></PRE>
386<DL>
387<DD>This method does the work of creating the new view and checking it into
388 Starteam.
389<P>
390<DD><DL>
391<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>
392</DD>
393<DD><DL>
394
395<DT><B>Throws:</B>
396<DD><CODE><A HREF="../../../../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</A></CODE> - if something goes wrong with the build</DL>
397</DD>
398</DL>
399<HR>
400
401<A NAME="createSnapshotView(View)"><!-- --></A><H3>
402createSnapshotView</H3>
403<PRE>
404protected View <B>createSnapshotView</B>(View&nbsp;raw)</PRE>
405<DL>
406<DD>Override of base-class abstract function creates an
407 appropriately configured view. For labels this a view
408 configured as of this.lastBuild.
409<P>
410<DD><DL>
411<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/starteam/StarTeamTask.html#createSnapshotView(View)">createSnapshotView</A></CODE> in class <CODE><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/starteam/StarTeamTask.html" title="class in org.apache.tools.ant.taskdefs.optional.starteam">StarTeamTask</A></CODE></DL>
412</DD>
413<DD><DL>
414<DT><B>Parameters:</B><DD><CODE>raw</CODE> - the unconfigured <code>View</code>
415<DT><B>Returns:</B><DD>the snapshot <code>View</code> appropriately configured.</DL>
416</DD>
417</DL>
418<!-- ========= END OF CLASS DATA ========= -->
419<HR>
420
421
422<!-- ======= START OF BOTTOM NAVBAR ====== -->
423<A NAME="navbar_bottom"><!-- --></A>
424<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
425<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
426<TR>
427<TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
428<A NAME="navbar_bottom_firstrow"><!-- --></A>
429<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
430 <TR ALIGN="center" VALIGN="top">
431 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
432 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
433 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
434 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
435 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
436 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
437 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
438 </TR>
439</TABLE>
440</TD>
441<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
442</EM>
443</TD>
444</TR>
445
446<TR>
447<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
448&nbsp;<A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/starteam/StarTeamCheckout.html" title="class in org.apache.tools.ant.taskdefs.optional.starteam"><B>PREV CLASS</B></A>&nbsp;
449&nbsp;<A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/starteam/StarTeamList.html" title="class in org.apache.tools.ant.taskdefs.optional.starteam"><B>NEXT CLASS</B></A></FONT></TD>
450<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
451 <A HREF="../../../../../../../index.html" target="_top"><B>FRAMES</B></A> &nbsp;
452&nbsp;<A HREF="StarTeamLabel.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
453&nbsp;<SCRIPT type="text/javascript">
454 <!--
455 if(window==top) {
456 document.writeln('<A HREF="../../../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
457 }
458 //-->
459</SCRIPT>
460<NOSCRIPT>
461 <A HREF="../../../../../../../allclasses-noframe.html"><B>All Classes</B></A>
462</NOSCRIPT>
463
464</FONT></TD>
465</TR>
466<TR>
467<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
468 SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;<A HREF="#fields_inherited_from_class_org.apache.tools.ant.Task">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
469<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
470DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
471</TR>
472</TABLE>
473<A NAME="skip-navbar_bottom"></A>
474<!-- ======== END OF BOTTOM NAVBAR ======= -->
475
476<HR>
477Copyright © 2000-2007 Apache Software Foundation. All Rights Reserved.
478</BODY>
479</HTML>
Note: See TracBrowser for help on using the repository browser.