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>
|
---|
7 | StarTeamTask (Apache Ant API)
|
---|
8 | </TITLE>
|
---|
9 |
|
---|
10 | <META NAME="keywords" CONTENT="org.apache.tools.ant.taskdefs.optional.starteam.StarTeamTask 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="StarTeamTask (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 | <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/starteam/StarTeamList.html" title="class in org.apache.tools.ant.taskdefs.optional.starteam"><B>PREV CLASS</B></A>
|
---|
53 | <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/starteam/TreeBasedTask.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>
|
---|
56 | <A HREF="StarTeamTask.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="#fields_inherited_from_class_org.apache.tools.ant.Task">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: FIELD | <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.starteam</FONT>
|
---|
85 | <BR>
|
---|
86 | Class StarTeamTask</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.starteam.StarTeamTask</B>
|
---|
92 | </PRE>
|
---|
93 | <DL>
|
---|
94 | <DT><B>Direct Known Subclasses:</B> <DD><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/starteam/StarTeamLabel.html" title="class in org.apache.tools.ant.taskdefs.optional.starteam">StarTeamLabel</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/starteam/TreeBasedTask.html" title="class in org.apache.tools.ant.taskdefs.optional.starteam">TreeBasedTask</A></DD>
|
---|
95 | </DL>
|
---|
96 | <HR>
|
---|
97 | <DL>
|
---|
98 | <DT>public abstract class <B>StarTeamTask</B><DT>extends <A HREF="../../../../../../../org/apache/tools/ant/Task.html" title="class in org.apache.tools.ant">Task</A></DL>
|
---|
99 |
|
---|
100 | <P>
|
---|
101 | Common super class for all StarTeam tasks.
|
---|
102 | At this level of the hierarchy we are concerned only with obtaining a
|
---|
103 | connection to the StarTeam server. The subclass <code>TreeBasedTask</code>,
|
---|
104 | also abstract defines the tree-walking behavior common to many subtasks.
|
---|
105 | <P>
|
---|
106 |
|
---|
107 | <P>
|
---|
108 | <DL>
|
---|
109 | <DT><B>Version:</B></DT>
|
---|
110 | <DD>1.1</DD>
|
---|
111 | <DT><B>See Also:</B><DD><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/starteam/TreeBasedTask.html" title="class in org.apache.tools.ant.taskdefs.optional.starteam"><CODE>TreeBasedTask</CODE></A></DL>
|
---|
112 | <HR>
|
---|
113 |
|
---|
114 | <P>
|
---|
115 | <!-- ======== NESTED CLASS SUMMARY ======== -->
|
---|
116 |
|
---|
117 |
|
---|
118 | <!-- =========== FIELD SUMMARY =========== -->
|
---|
119 |
|
---|
120 | <A NAME="field_summary"><!-- --></A>
|
---|
121 | <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
---|
122 | <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
---|
123 | <TD COLSPAN=2><FONT SIZE="+2">
|
---|
124 | <B>Field Summary</B></FONT></TD>
|
---|
125 | </TR>
|
---|
126 | </TABLE>
|
---|
127 | <A NAME="fields_inherited_from_class_org.apache.tools.ant.Task"><!-- --></A>
|
---|
128 | <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
---|
129 | <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
|
---|
130 | <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>
|
---|
131 | </TR>
|
---|
132 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
133 | <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>
|
---|
134 | </TR>
|
---|
135 | </TABLE>
|
---|
136 | <A NAME="fields_inherited_from_class_org.apache.tools.ant.ProjectComponent"><!-- --></A>
|
---|
137 | <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
---|
138 | <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
|
---|
139 | <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>
|
---|
140 | </TR>
|
---|
141 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
142 | <TD><CODE><A HREF="../../../../../../../org/apache/tools/ant/ProjectComponent.html#project">project</A></CODE></TD>
|
---|
143 | </TR>
|
---|
144 | </TABLE>
|
---|
145 |
|
---|
146 | <!-- ======== CONSTRUCTOR SUMMARY ======== -->
|
---|
147 |
|
---|
148 | <A NAME="constructor_summary"><!-- --></A>
|
---|
149 | <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
---|
150 | <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
---|
151 | <TD COLSPAN=2><FONT SIZE="+2">
|
---|
152 | <B>Constructor Summary</B></FONT></TD>
|
---|
153 | </TR>
|
---|
154 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
155 | <TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/starteam/StarTeamTask.html#StarTeamTask()">StarTeamTask</A></B>()</CODE>
|
---|
156 |
|
---|
157 | <BR>
|
---|
158 | </TD>
|
---|
159 | </TR>
|
---|
160 | </TABLE>
|
---|
161 |
|
---|
162 | <!-- ========== METHOD SUMMARY =========== -->
|
---|
163 |
|
---|
164 | <A NAME="method_summary"><!-- --></A>
|
---|
165 | <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
---|
166 | <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
---|
167 | <TD COLSPAN=2><FONT SIZE="+2">
|
---|
168 | <B>Method Summary</B></FONT></TD>
|
---|
169 | </TR>
|
---|
170 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
171 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
---|
172 | <CODE>protected abstract View</CODE></FONT></TD>
|
---|
173 | <TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/starteam/StarTeamTask.html#createSnapshotView(View)">createSnapshotView</A></B>(View rawview)</CODE>
|
---|
174 |
|
---|
175 | <BR>
|
---|
176 | Derived classes must override <code>createSnapshotView</code>
|
---|
177 | defining the kind of configured view appropriate to its task.</TD>
|
---|
178 | </TR>
|
---|
179 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
180 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
---|
181 | <CODE>protected void</CODE></FONT></TD>
|
---|
182 | <TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/starteam/StarTeamTask.html#disconnectFromServer()">disconnectFromServer</A></B>()</CODE>
|
---|
183 |
|
---|
184 | <BR>
|
---|
185 | disconnects from the StarTeam server.</TD>
|
---|
186 | </TR>
|
---|
187 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
188 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
---|
189 | <CODE> java.lang.String</CODE></FONT></TD>
|
---|
190 | <TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/starteam/StarTeamTask.html#getPassword()">getPassword</A></B>()</CODE>
|
---|
191 |
|
---|
192 | <BR>
|
---|
193 | returns the password used for login</TD>
|
---|
194 | </TR>
|
---|
195 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
196 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
---|
197 | <CODE> java.lang.String</CODE></FONT></TD>
|
---|
198 | <TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/starteam/StarTeamTask.html#getProjectname()">getProjectname</A></B>()</CODE>
|
---|
199 |
|
---|
200 | <BR>
|
---|
201 | returns the name of the StarTeam project to be acted on</TD>
|
---|
202 | </TR>
|
---|
203 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
204 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
---|
205 | <CODE>protected Server</CODE></FONT></TD>
|
---|
206 | <TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/starteam/StarTeamTask.html#getServer()">getServer</A></B>()</CODE>
|
---|
207 |
|
---|
208 | <BR>
|
---|
209 | returns a reference to the server which may be used for informational
|
---|
210 | purposes by subclasses.</TD>
|
---|
211 | </TR>
|
---|
212 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
213 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
---|
214 | <CODE> java.lang.String</CODE></FONT></TD>
|
---|
215 | <TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/starteam/StarTeamTask.html#getServername()">getServername</A></B>()</CODE>
|
---|
216 |
|
---|
217 | <BR>
|
---|
218 | returns the name of the StarTeamServer</TD>
|
---|
219 | </TR>
|
---|
220 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
221 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
---|
222 | <CODE> java.lang.String</CODE></FONT></TD>
|
---|
223 | <TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/starteam/StarTeamTask.html#getServerport()">getServerport</A></B>()</CODE>
|
---|
224 |
|
---|
225 | <BR>
|
---|
226 | returns the port number of the StarTeam connection</TD>
|
---|
227 | </TR>
|
---|
228 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
229 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
---|
230 | <CODE>protected TypeNames</CODE></FONT></TD>
|
---|
231 | <TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/starteam/StarTeamTask.html#getTypeNames()">getTypeNames</A></B>()</CODE>
|
---|
232 |
|
---|
233 | <BR>
|
---|
234 | returns a list of TypeNames known to the server.</TD>
|
---|
235 | </TR>
|
---|
236 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
237 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
---|
238 | <CODE> java.lang.String</CODE></FONT></TD>
|
---|
239 | <TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/starteam/StarTeamTask.html#getURL()">getURL</A></B>()</CODE>
|
---|
240 |
|
---|
241 | <BR>
|
---|
242 | a convenience method which returns the whole StarTeam
|
---|
243 | connection information as a single URL string of</TD>
|
---|
244 | </TR>
|
---|
245 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
246 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
---|
247 | <CODE> java.lang.String</CODE></FONT></TD>
|
---|
248 | <TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/starteam/StarTeamTask.html#getUserName()">getUserName</A></B>()</CODE>
|
---|
249 |
|
---|
250 | <BR>
|
---|
251 | returns the name of the StarTeam user</TD>
|
---|
252 | </TR>
|
---|
253 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
254 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
---|
255 | <CODE>protected java.lang.String</CODE></FONT></TD>
|
---|
256 | <TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/starteam/StarTeamTask.html#getUserName(int)">getUserName</A></B>(int userID)</CODE>
|
---|
257 |
|
---|
258 | <BR>
|
---|
259 | Returns the name of the user with the supplied ID or a blank string
|
---|
260 | if user not found.</TD>
|
---|
261 | </TR>
|
---|
262 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
263 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
---|
264 | <CODE> java.lang.String</CODE></FONT></TD>
|
---|
265 | <TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/starteam/StarTeamTask.html#getViewname()">getViewname</A></B>()</CODE>
|
---|
266 |
|
---|
267 | <BR>
|
---|
268 | returns the name of the StarTeam view to be acted on</TD>
|
---|
269 | </TR>
|
---|
270 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
271 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
---|
272 | <CODE>protected java.lang.String</CODE></FONT></TD>
|
---|
273 | <TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/starteam/StarTeamTask.html#getViewURL()">getViewURL</A></B>()</CODE>
|
---|
274 |
|
---|
275 | <BR>
|
---|
276 | returns an URL string useful for interacting with many StarTeamFinder
|
---|
277 | methods.</TD>
|
---|
278 | </TR>
|
---|
279 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
280 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
---|
281 | <CODE>protected View</CODE></FONT></TD>
|
---|
282 | <TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/starteam/StarTeamTask.html#openView()">openView</A></B>()</CODE>
|
---|
283 |
|
---|
284 | <BR>
|
---|
285 | All subclasses will call on this method to open the view needed for
|
---|
286 | processing.</TD>
|
---|
287 | </TR>
|
---|
288 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
289 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
---|
290 | <CODE> void</CODE></FONT></TD>
|
---|
291 | <TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/starteam/StarTeamTask.html#setPassword(java.lang.String)">setPassword</A></B>(java.lang.String password)</CODE>
|
---|
292 |
|
---|
293 | <BR>
|
---|
294 | set the password to be used for login; required.</TD>
|
---|
295 | </TR>
|
---|
296 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
297 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
---|
298 | <CODE> void</CODE></FONT></TD>
|
---|
299 | <TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/starteam/StarTeamTask.html#setProjectname(java.lang.String)">setProjectname</A></B>(java.lang.String projectname)</CODE>
|
---|
300 |
|
---|
301 | <BR>
|
---|
302 | set the name of the StarTeam project to be acted on;
|
---|
303 | required if <tt>URL</tt> is not set.</TD>
|
---|
304 | </TR>
|
---|
305 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
306 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
---|
307 | <CODE> void</CODE></FONT></TD>
|
---|
308 | <TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/starteam/StarTeamTask.html#setServername(java.lang.String)">setServername</A></B>(java.lang.String servername)</CODE>
|
---|
309 |
|
---|
310 | <BR>
|
---|
311 | Set the name of StarTeamServer;
|
---|
312 | required if <tt>URL</tt> is not set.</TD>
|
---|
313 | </TR>
|
---|
314 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
315 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
---|
316 | <CODE> void</CODE></FONT></TD>
|
---|
317 | <TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/starteam/StarTeamTask.html#setServerport(java.lang.String)">setServerport</A></B>(java.lang.String serverport)</CODE>
|
---|
318 |
|
---|
319 | <BR>
|
---|
320 | set the port number of the StarTeam connection;
|
---|
321 | required if <tt>URL</tt> is not set.</TD>
|
---|
322 | </TR>
|
---|
323 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
324 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
---|
325 | <CODE> void</CODE></FONT></TD>
|
---|
326 | <TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/starteam/StarTeamTask.html#setURL(java.lang.String)">setURL</A></B>(java.lang.String url)</CODE>
|
---|
327 |
|
---|
328 | <BR>
|
---|
329 | Set the server name, server port,
|
---|
330 | project name and project folder in one shot;
|
---|
331 | optional, but the server connection must be specified somehow.</TD>
|
---|
332 | </TR>
|
---|
333 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
334 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
---|
335 | <CODE> void</CODE></FONT></TD>
|
---|
336 | <TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/starteam/StarTeamTask.html#setUserName(java.lang.String)">setUserName</A></B>(java.lang.String userName)</CODE>
|
---|
337 |
|
---|
338 | <BR>
|
---|
339 | set the name of the StarTeam user, needed for the connection</TD>
|
---|
340 | </TR>
|
---|
341 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
342 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
---|
343 | <CODE> void</CODE></FONT></TD>
|
---|
344 | <TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/starteam/StarTeamTask.html#setViewname(java.lang.String)">setViewname</A></B>(java.lang.String viewname)</CODE>
|
---|
345 |
|
---|
346 | <BR>
|
---|
347 | set the name of the StarTeam view to be acted on;
|
---|
348 | required if <tt>URL</tt> is not set.</TD>
|
---|
349 | </TR>
|
---|
350 | </TABLE>
|
---|
351 | <A NAME="methods_inherited_from_class_org.apache.tools.ant.Task"><!-- --></A>
|
---|
352 | <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
---|
353 | <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
|
---|
354 | <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>
|
---|
355 | </TR>
|
---|
356 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
357 | <TD><CODE><A HREF="../../../../../../../org/apache/tools/ant/Task.html#execute()">execute</A>, <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>
|
---|
358 | </TR>
|
---|
359 | </TABLE>
|
---|
360 | <A NAME="methods_inherited_from_class_org.apache.tools.ant.ProjectComponent"><!-- --></A>
|
---|
361 | <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
---|
362 | <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
|
---|
363 | <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>
|
---|
364 | </TR>
|
---|
365 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
366 | <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>
|
---|
367 | </TR>
|
---|
368 | </TABLE>
|
---|
369 | <A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
|
---|
370 | <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
---|
371 | <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
|
---|
372 | <TD><B>Methods inherited from class java.lang.Object</B></TD>
|
---|
373 | </TR>
|
---|
374 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
375 | <TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
|
---|
376 | </TR>
|
---|
377 | </TABLE>
|
---|
378 |
|
---|
379 | <P>
|
---|
380 |
|
---|
381 | <!-- ============ FIELD DETAIL =========== -->
|
---|
382 |
|
---|
383 |
|
---|
384 | <!-- ========= CONSTRUCTOR DETAIL ======== -->
|
---|
385 |
|
---|
386 | <A NAME="constructor_detail"><!-- --></A>
|
---|
387 | <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
---|
388 | <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
---|
389 | <TD COLSPAN=1><FONT SIZE="+2">
|
---|
390 | <B>Constructor Detail</B></FONT></TD>
|
---|
391 | </TR>
|
---|
392 | </TABLE>
|
---|
393 |
|
---|
394 | <A NAME="StarTeamTask()"><!-- --></A><H3>
|
---|
395 | StarTeamTask</H3>
|
---|
396 | <PRE>
|
---|
397 | public <B>StarTeamTask</B>()</PRE>
|
---|
398 | <DL>
|
---|
399 | </DL>
|
---|
400 |
|
---|
401 | <!-- ============ METHOD DETAIL ========== -->
|
---|
402 |
|
---|
403 | <A NAME="method_detail"><!-- --></A>
|
---|
404 | <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
---|
405 | <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
---|
406 | <TD COLSPAN=1><FONT SIZE="+2">
|
---|
407 | <B>Method Detail</B></FONT></TD>
|
---|
408 | </TR>
|
---|
409 | </TABLE>
|
---|
410 |
|
---|
411 | <A NAME="setServername(java.lang.String)"><!-- --></A><H3>
|
---|
412 | setServername</H3>
|
---|
413 | <PRE>
|
---|
414 | public final void <B>setServername</B>(java.lang.String servername)</PRE>
|
---|
415 | <DL>
|
---|
416 | <DD>Set the name of StarTeamServer;
|
---|
417 | required if <tt>URL</tt> is not set.
|
---|
418 | <P>
|
---|
419 | <DD><DL>
|
---|
420 | <DT><B>Parameters:</B><DD><CODE>servername</CODE> - a <code>String</code> value<DT><B>See Also:</B><DD><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/starteam/StarTeamTask.html#setURL(java.lang.String)"><CODE>setURL(String)</CODE></A></DL>
|
---|
421 | </DD>
|
---|
422 | </DL>
|
---|
423 | <HR>
|
---|
424 |
|
---|
425 | <A NAME="getServername()"><!-- --></A><H3>
|
---|
426 | getServername</H3>
|
---|
427 | <PRE>
|
---|
428 | public final java.lang.String <B>getServername</B>()</PRE>
|
---|
429 | <DL>
|
---|
430 | <DD>returns the name of the StarTeamServer
|
---|
431 | <P>
|
---|
432 | <DD><DL>
|
---|
433 |
|
---|
434 | <DT><B>Returns:</B><DD>the name of the StarTeam server<DT><B>See Also:</B><DD><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/starteam/StarTeamTask.html#getURL()"><CODE>getURL()</CODE></A></DL>
|
---|
435 | </DD>
|
---|
436 | </DL>
|
---|
437 | <HR>
|
---|
438 |
|
---|
439 | <A NAME="setServerport(java.lang.String)"><!-- --></A><H3>
|
---|
440 | setServerport</H3>
|
---|
441 | <PRE>
|
---|
442 | public final void <B>setServerport</B>(java.lang.String serverport)</PRE>
|
---|
443 | <DL>
|
---|
444 | <DD>set the port number of the StarTeam connection;
|
---|
445 | required if <tt>URL</tt> is not set.
|
---|
446 | <P>
|
---|
447 | <DD><DL>
|
---|
448 | <DT><B>Parameters:</B><DD><CODE>serverport</CODE> - port number to be set<DT><B>See Also:</B><DD><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/starteam/StarTeamTask.html#setURL(java.lang.String)"><CODE>setURL(String)</CODE></A></DL>
|
---|
449 | </DD>
|
---|
450 | </DL>
|
---|
451 | <HR>
|
---|
452 |
|
---|
453 | <A NAME="getServerport()"><!-- --></A><H3>
|
---|
454 | getServerport</H3>
|
---|
455 | <PRE>
|
---|
456 | public final java.lang.String <B>getServerport</B>()</PRE>
|
---|
457 | <DL>
|
---|
458 | <DD>returns the port number of the StarTeam connection
|
---|
459 | <P>
|
---|
460 | <DD><DL>
|
---|
461 |
|
---|
462 | <DT><B>Returns:</B><DD>the port number of the StarTeam connection<DT><B>See Also:</B><DD><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/starteam/StarTeamTask.html#getURL()"><CODE>getURL()</CODE></A></DL>
|
---|
463 | </DD>
|
---|
464 | </DL>
|
---|
465 | <HR>
|
---|
466 |
|
---|
467 | <A NAME="setProjectname(java.lang.String)"><!-- --></A><H3>
|
---|
468 | setProjectname</H3>
|
---|
469 | <PRE>
|
---|
470 | public final void <B>setProjectname</B>(java.lang.String projectname)</PRE>
|
---|
471 | <DL>
|
---|
472 | <DD>set the name of the StarTeam project to be acted on;
|
---|
473 | required if <tt>URL</tt> is not set.
|
---|
474 | <P>
|
---|
475 | <DD><DL>
|
---|
476 | <DT><B>Parameters:</B><DD><CODE>projectname</CODE> - the name of the StarTeam project to be acted on<DT><B>See Also:</B><DD><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/starteam/StarTeamTask.html#setURL(java.lang.String)"><CODE>setURL(String)</CODE></A></DL>
|
---|
477 | </DD>
|
---|
478 | </DL>
|
---|
479 | <HR>
|
---|
480 |
|
---|
481 | <A NAME="getProjectname()"><!-- --></A><H3>
|
---|
482 | getProjectname</H3>
|
---|
483 | <PRE>
|
---|
484 | public final java.lang.String <B>getProjectname</B>()</PRE>
|
---|
485 | <DL>
|
---|
486 | <DD>returns the name of the StarTeam project to be acted on
|
---|
487 | <P>
|
---|
488 | <DD><DL>
|
---|
489 |
|
---|
490 | <DT><B>Returns:</B><DD>the name of the StarTeam project to be acted on<DT><B>See Also:</B><DD><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/starteam/StarTeamTask.html#getURL()"><CODE>getURL()</CODE></A></DL>
|
---|
491 | </DD>
|
---|
492 | </DL>
|
---|
493 | <HR>
|
---|
494 |
|
---|
495 | <A NAME="setViewname(java.lang.String)"><!-- --></A><H3>
|
---|
496 | setViewname</H3>
|
---|
497 | <PRE>
|
---|
498 | public final void <B>setViewname</B>(java.lang.String viewname)</PRE>
|
---|
499 | <DL>
|
---|
500 | <DD>set the name of the StarTeam view to be acted on;
|
---|
501 | required if <tt>URL</tt> is not set.
|
---|
502 | <P>
|
---|
503 | <DD><DL>
|
---|
504 | <DT><B>Parameters:</B><DD><CODE>viewname</CODE> - the name of the StarTeam view to be acted on<DT><B>See Also:</B><DD><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/starteam/StarTeamTask.html#setURL(java.lang.String)"><CODE>setURL(String)</CODE></A></DL>
|
---|
505 | </DD>
|
---|
506 | </DL>
|
---|
507 | <HR>
|
---|
508 |
|
---|
509 | <A NAME="getViewname()"><!-- --></A><H3>
|
---|
510 | getViewname</H3>
|
---|
511 | <PRE>
|
---|
512 | public final java.lang.String <B>getViewname</B>()</PRE>
|
---|
513 | <DL>
|
---|
514 | <DD>returns the name of the StarTeam view to be acted on
|
---|
515 | <P>
|
---|
516 | <DD><DL>
|
---|
517 |
|
---|
518 | <DT><B>Returns:</B><DD>the name of the StarTeam view to be acted on<DT><B>See Also:</B><DD><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/starteam/StarTeamTask.html#getURL()"><CODE>getURL()</CODE></A></DL>
|
---|
519 | </DD>
|
---|
520 | </DL>
|
---|
521 | <HR>
|
---|
522 |
|
---|
523 | <A NAME="setURL(java.lang.String)"><!-- --></A><H3>
|
---|
524 | setURL</H3>
|
---|
525 | <PRE>
|
---|
526 | public final void <B>setURL</B>(java.lang.String url)</PRE>
|
---|
527 | <DL>
|
---|
528 | <DD>Set the server name, server port,
|
---|
529 | project name and project folder in one shot;
|
---|
530 | optional, but the server connection must be specified somehow.
|
---|
531 | <P>
|
---|
532 | <DD><DL>
|
---|
533 | <DT><B>Parameters:</B><DD><CODE>url</CODE> - a <code>String</code> of the form
|
---|
534 | "servername:portnum/project/view"<DT><B>See Also:</B><DD><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/starteam/StarTeamTask.html#setServername(java.lang.String)"><CODE>setServername(String)</CODE></A>,
|
---|
535 | <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/starteam/StarTeamTask.html#setServerport(java.lang.String)"><CODE>setServerport(String)</CODE></A>,
|
---|
536 | <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/starteam/StarTeamTask.html#setProjectname(java.lang.String)"><CODE>setProjectname(String)</CODE></A>,
|
---|
537 | <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/starteam/StarTeamTask.html#setViewname(java.lang.String)"><CODE>setViewname(String)</CODE></A></DL>
|
---|
538 | </DD>
|
---|
539 | </DL>
|
---|
540 | <HR>
|
---|
541 |
|
---|
542 | <A NAME="getURL()"><!-- --></A><H3>
|
---|
543 | getURL</H3>
|
---|
544 | <PRE>
|
---|
545 | public final java.lang.String <B>getURL</B>()</PRE>
|
---|
546 | <DL>
|
---|
547 | <DD>a convenience method which returns the whole StarTeam
|
---|
548 | connection information as a single URL string of
|
---|
549 | <P>
|
---|
550 | <DD><DL>
|
---|
551 |
|
---|
552 | <DT><B>Returns:</B><DD>a <code>String</code> of the form
|
---|
553 | "servername:portnum/project/view"<DT><B>See Also:</B><DD><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/starteam/StarTeamTask.html#getServername()"><CODE>getServername()</CODE></A>,
|
---|
554 | <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/starteam/StarTeamTask.html#getServerport()"><CODE>getServerport()</CODE></A>,
|
---|
555 | <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/starteam/StarTeamTask.html#getProjectname()"><CODE>getProjectname()</CODE></A>,
|
---|
556 | <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/starteam/StarTeamTask.html#getViewname()"><CODE>getViewname()</CODE></A></DL>
|
---|
557 | </DD>
|
---|
558 | </DL>
|
---|
559 | <HR>
|
---|
560 |
|
---|
561 | <A NAME="getViewURL()"><!-- --></A><H3>
|
---|
562 | getViewURL</H3>
|
---|
563 | <PRE>
|
---|
564 | protected final java.lang.String <B>getViewURL</B>()</PRE>
|
---|
565 | <DL>
|
---|
566 | <DD>returns an URL string useful for interacting with many StarTeamFinder
|
---|
567 | methods.
|
---|
568 | <P>
|
---|
569 | <DD><DL>
|
---|
570 |
|
---|
571 | <DT><B>Returns:</B><DD>the URL string for this task.</DL>
|
---|
572 | </DD>
|
---|
573 | </DL>
|
---|
574 | <HR>
|
---|
575 |
|
---|
576 | <A NAME="setUserName(java.lang.String)"><!-- --></A><H3>
|
---|
577 | setUserName</H3>
|
---|
578 | <PRE>
|
---|
579 | public final void <B>setUserName</B>(java.lang.String userName)</PRE>
|
---|
580 | <DL>
|
---|
581 | <DD>set the name of the StarTeam user, needed for the connection
|
---|
582 | <P>
|
---|
583 | <DD><DL>
|
---|
584 | <DT><B>Parameters:</B><DD><CODE>userName</CODE> - name of the user to be logged in</DL>
|
---|
585 | </DD>
|
---|
586 | </DL>
|
---|
587 | <HR>
|
---|
588 |
|
---|
589 | <A NAME="getUserName()"><!-- --></A><H3>
|
---|
590 | getUserName</H3>
|
---|
591 | <PRE>
|
---|
592 | public final java.lang.String <B>getUserName</B>()</PRE>
|
---|
593 | <DL>
|
---|
594 | <DD>returns the name of the StarTeam user
|
---|
595 | <P>
|
---|
596 | <DD><DL>
|
---|
597 |
|
---|
598 | <DT><B>Returns:</B><DD>the name of the StarTeam user</DL>
|
---|
599 | </DD>
|
---|
600 | </DL>
|
---|
601 | <HR>
|
---|
602 |
|
---|
603 | <A NAME="setPassword(java.lang.String)"><!-- --></A><H3>
|
---|
604 | setPassword</H3>
|
---|
605 | <PRE>
|
---|
606 | public final void <B>setPassword</B>(java.lang.String password)</PRE>
|
---|
607 | <DL>
|
---|
608 | <DD>set the password to be used for login; required.
|
---|
609 | <P>
|
---|
610 | <DD><DL>
|
---|
611 | <DT><B>Parameters:</B><DD><CODE>password</CODE> - the password to be used for login</DL>
|
---|
612 | </DD>
|
---|
613 | </DL>
|
---|
614 | <HR>
|
---|
615 |
|
---|
616 | <A NAME="getPassword()"><!-- --></A><H3>
|
---|
617 | getPassword</H3>
|
---|
618 | <PRE>
|
---|
619 | public final java.lang.String <B>getPassword</B>()</PRE>
|
---|
620 | <DL>
|
---|
621 | <DD>returns the password used for login
|
---|
622 | <P>
|
---|
623 | <DD><DL>
|
---|
624 |
|
---|
625 | <DT><B>Returns:</B><DD>the password used for login</DL>
|
---|
626 | </DD>
|
---|
627 | </DL>
|
---|
628 | <HR>
|
---|
629 |
|
---|
630 | <A NAME="getServer()"><!-- --></A><H3>
|
---|
631 | getServer</H3>
|
---|
632 | <PRE>
|
---|
633 | protected final Server <B>getServer</B>()</PRE>
|
---|
634 | <DL>
|
---|
635 | <DD>returns a reference to the server which may be used for informational
|
---|
636 | purposes by subclasses.
|
---|
637 | <P>
|
---|
638 | <DD><DL>
|
---|
639 |
|
---|
640 | <DT><B>Returns:</B><DD>a reference to the server</DL>
|
---|
641 | </DD>
|
---|
642 | </DL>
|
---|
643 | <HR>
|
---|
644 |
|
---|
645 | <A NAME="disconnectFromServer()"><!-- --></A><H3>
|
---|
646 | disconnectFromServer</H3>
|
---|
647 | <PRE>
|
---|
648 | protected final void <B>disconnectFromServer</B>()</PRE>
|
---|
649 | <DL>
|
---|
650 | <DD>disconnects from the StarTeam server. Should be called from the
|
---|
651 | finally clause of every StarTeamTask-based execute method.
|
---|
652 | <P>
|
---|
653 | <DD><DL>
|
---|
654 | </DL>
|
---|
655 | </DD>
|
---|
656 | </DL>
|
---|
657 | <HR>
|
---|
658 |
|
---|
659 | <A NAME="getTypeNames()"><!-- --></A><H3>
|
---|
660 | getTypeNames</H3>
|
---|
661 | <PRE>
|
---|
662 | protected final TypeNames <B>getTypeNames</B>()</PRE>
|
---|
663 | <DL>
|
---|
664 | <DD>returns a list of TypeNames known to the server.
|
---|
665 | <P>
|
---|
666 | <DD><DL>
|
---|
667 |
|
---|
668 | <DT><B>Returns:</B><DD>a reference to the server's TypeNames</DL>
|
---|
669 | </DD>
|
---|
670 | </DL>
|
---|
671 | <HR>
|
---|
672 |
|
---|
673 | <A NAME="createSnapshotView(View)"><!-- --></A><H3>
|
---|
674 | createSnapshotView</H3>
|
---|
675 | <PRE>
|
---|
676 | protected abstract View <B>createSnapshotView</B>(View rawview)
|
---|
677 | throws <A HREF="../../../../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</A></PRE>
|
---|
678 | <DL>
|
---|
679 | <DD>Derived classes must override <code>createSnapshotView</code>
|
---|
680 | defining the kind of configured view appropriate to its task.
|
---|
681 | <P>
|
---|
682 | <DD><DL>
|
---|
683 | <DT><B>Parameters:</B><DD><CODE>rawview</CODE> - the unconfigured <code>View</code>
|
---|
684 | <DT><B>Returns:</B><DD>the snapshot <code>View</code> appropriately configured.
|
---|
685 | <DT><B>Throws:</B>
|
---|
686 | <DD><CODE><A HREF="../../../../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</A></CODE></DL>
|
---|
687 | </DD>
|
---|
688 | </DL>
|
---|
689 | <HR>
|
---|
690 |
|
---|
691 | <A NAME="openView()"><!-- --></A><H3>
|
---|
692 | openView</H3>
|
---|
693 | <PRE>
|
---|
694 | protected View <B>openView</B>()
|
---|
695 | throws <A HREF="../../../../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</A></PRE>
|
---|
696 | <DL>
|
---|
697 | <DD>All subclasses will call on this method to open the view needed for
|
---|
698 | processing. This method also saves a reference to the
|
---|
699 | <code>Server</code> that may be accessed for information at various
|
---|
700 | points in the process.
|
---|
701 | <P>
|
---|
702 | <DD><DL>
|
---|
703 |
|
---|
704 | <DT><B>Returns:</B><DD>the <code>View</code> that will be used for processing.
|
---|
705 | <DT><B>Throws:</B>
|
---|
706 | <DD><CODE><A HREF="../../../../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</A></CODE><DT><B>See Also:</B><DD><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/starteam/StarTeamTask.html#createSnapshotView(View)"><CODE>createSnapshotView(View)</CODE></A>,
|
---|
707 | <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/starteam/StarTeamTask.html#getServer()"><CODE>getServer()</CODE></A></DL>
|
---|
708 | </DD>
|
---|
709 | </DL>
|
---|
710 | <HR>
|
---|
711 |
|
---|
712 | <A NAME="getUserName(int)"><!-- --></A><H3>
|
---|
713 | getUserName</H3>
|
---|
714 | <PRE>
|
---|
715 | protected final java.lang.String <B>getUserName</B>(int userID)</PRE>
|
---|
716 | <DL>
|
---|
717 | <DD>Returns the name of the user with the supplied ID or a blank string
|
---|
718 | if user not found.
|
---|
719 | <P>
|
---|
720 | <DD><DL>
|
---|
721 | <DT><B>Parameters:</B><DD><CODE>userID</CODE> - a user's ID
|
---|
722 | <DT><B>Returns:</B><DD>the name of the user with ID userID</DL>
|
---|
723 | </DD>
|
---|
724 | </DL>
|
---|
725 | <!-- ========= END OF CLASS DATA ========= -->
|
---|
726 | <HR>
|
---|
727 |
|
---|
728 |
|
---|
729 | <!-- ======= START OF BOTTOM NAVBAR ====== -->
|
---|
730 | <A NAME="navbar_bottom"><!-- --></A>
|
---|
731 | <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
|
---|
732 | <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
|
---|
733 | <TR>
|
---|
734 | <TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
|
---|
735 | <A NAME="navbar_bottom_firstrow"><!-- --></A>
|
---|
736 | <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
|
---|
737 | <TR ALIGN="center" VALIGN="top">
|
---|
738 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
|
---|
739 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
|
---|
740 | <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
|
---|
741 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
|
---|
742 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
|
---|
743 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
|
---|
744 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
|
---|
745 | </TR>
|
---|
746 | </TABLE>
|
---|
747 | </TD>
|
---|
748 | <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
|
---|
749 | </EM>
|
---|
750 | </TD>
|
---|
751 | </TR>
|
---|
752 |
|
---|
753 | <TR>
|
---|
754 | <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
---|
755 | <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/starteam/StarTeamList.html" title="class in org.apache.tools.ant.taskdefs.optional.starteam"><B>PREV CLASS</B></A>
|
---|
756 | <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/starteam/TreeBasedTask.html" title="class in org.apache.tools.ant.taskdefs.optional.starteam"><B>NEXT CLASS</B></A></FONT></TD>
|
---|
757 | <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
---|
758 | <A HREF="../../../../../../../index.html" target="_top"><B>FRAMES</B></A>
|
---|
759 | <A HREF="StarTeamTask.html" target="_top"><B>NO FRAMES</B></A>
|
---|
760 | <SCRIPT type="text/javascript">
|
---|
761 | <!--
|
---|
762 | if(window==top) {
|
---|
763 | document.writeln('<A HREF="../../../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
|
---|
764 | }
|
---|
765 | //-->
|
---|
766 | </SCRIPT>
|
---|
767 | <NOSCRIPT>
|
---|
768 | <A HREF="../../../../../../../allclasses-noframe.html"><B>All Classes</B></A>
|
---|
769 | </NOSCRIPT>
|
---|
770 |
|
---|
771 | </FONT></TD>
|
---|
772 | </TR>
|
---|
773 | <TR>
|
---|
774 | <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
---|
775 | SUMMARY: NESTED | <A HREF="#fields_inherited_from_class_org.apache.tools.ant.Task">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
|
---|
776 | <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
---|
777 | DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
|
---|
778 | </TR>
|
---|
779 | </TABLE>
|
---|
780 | <A NAME="skip-navbar_bottom"></A>
|
---|
781 | <!-- ======== END OF BOTTOM NAVBAR ======= -->
|
---|
782 |
|
---|
783 | <HR>
|
---|
784 | Copyright © 2000-2007 Apache Software Foundation. All Rights Reserved.
|
---|
785 | </BODY>
|
---|
786 | </HTML>
|
---|