source: other-projects/trunk/gs3-release-maker/apache-ant-1.6.5/build/javadocs/org/apache/tools/ant/taskdefs/optional/clearcase/CCCheckout.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: 43.7 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:24 NZST 2007 -->
6<TITLE>
7CCCheckout (Apache Ant API)
8</TITLE>
9
10<META NAME="keywords" CONTENT="org.apache.tools.ant.taskdefs.optional.clearcase.CCCheckout 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="CCCheckout (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/clearcase/CCCheckin.html" title="class in org.apache.tools.ant.taskdefs.optional.clearcase"><B>PREV CLASS</B></A>&nbsp;
53&nbsp;<A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/clearcase/CCLock.html" title="class in org.apache.tools.ant.taskdefs.optional.clearcase"><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="CCCheckout.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="#field_summary">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
73<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
74DETAIL:&nbsp;<A HREF="#field_detail">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
75</TR>
76</TABLE>
77<A NAME="skip-navbar_top"></A>
78<!-- ========= END OF TOP NAVBAR ========= -->
79
80<HR>
81<!-- ======== START OF CLASS DATA ======== -->
82<H2>
83<FONT SIZE="-1">
84org.apache.tools.ant.taskdefs.optional.clearcase</FONT>
85<BR>
86Class CCCheckout</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/clearcase/ClearCase.html" title="class in org.apache.tools.ant.taskdefs.optional.clearcase">org.apache.tools.ant.taskdefs.optional.clearcase.ClearCase</A>
92 <IMG SRC="../../../../../../../resources/inherit.gif" ALT="extended by"><B>org.apache.tools.ant.taskdefs.optional.clearcase.CCCheckout</B>
93</PRE>
94<HR>
95<DL>
96<DT>public class <B>CCCheckout</B><DT>extends <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/clearcase/ClearCase.html" title="class in org.apache.tools.ant.taskdefs.optional.clearcase">ClearCase</A></DL>
97
98<P>
99Performs ClearCase checkout.
100
101 <p>
102 The following attributes are interpreted:
103 <table border="1">
104 <tr>
105 <th>Attribute</th>
106 <th>Values</th>
107 <th>Required</th>
108 </tr>
109 <tr>
110 <td>viewpath</td>
111 <td>Path to the ClearCase view file or directory that the command will operate on</td>
112 <td>No</td>
113 <tr>
114 <tr>
115 <td>reserved</td>
116 <td>Specifies whether to check out the file as reserved or not</td>
117 <td>Yes</td>
118 <tr>
119 <tr>
120 <td>out</td>
121 <td>Creates a writable file under a different filename</td>
122 <td>No</td>
123 <tr>
124 <tr>
125 <td>nodata</td>
126 <td>Checks out the file but does not create an editable file containing its data</td>
127 <td>No</td>
128 <tr>
129 <tr>
130 <td>branch</td>
131 <td>Specify a branch to check out the file to</td>
132 <td>No</td>
133 <tr>
134 <tr>
135 <td>version</td>
136 <td>Allows checkout of a version other than main latest</td>
137 <td>No</td>
138 <tr>
139 <tr>
140 <td>nowarn</td>
141 <td>Suppress warning messages</td>
142 <td>No</td>
143 <tr>
144 <tr>
145 <td>comment</td>
146 <td>Specify a comment. Only one of comment or cfile may be used.</td>
147 <td>No</td>
148 <tr>
149 <tr>
150 <td>commentfile</td>
151 <td>Specify a file containing a comment. Only one of comment or cfile may be used.</td>
152 <td>No</td>
153 <tr>
154 <tr>
155 <td>notco</td>
156 <td>Fail if it's already checked out to the current view. Set to false to ignore it.</td>
157 <td>No</td>
158 <tr>
159 <tr>
160 <td>failonerr</td>
161 <td>Throw an exception if the command fails. Default is true</td>
162 <td>No</td>
163 <tr>
164 </table>
165<P>
166
167<P>
168<HR>
169
170<P>
171<!-- ======== NESTED CLASS SUMMARY ======== -->
172
173
174<!-- =========== FIELD SUMMARY =========== -->
175
176<A NAME="field_summary"><!-- --></A>
177<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
178<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
179<TD COLSPAN=2><FONT SIZE="+2">
180<B>Field Summary</B></FONT></TD>
181</TR>
182<TR BGCOLOR="white" CLASS="TableRowColor">
183<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
184<CODE>static&nbsp;java.lang.String</CODE></FONT></TD>
185<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/clearcase/CCCheckout.html#FLAG_BRANCH">FLAG_BRANCH</A></B></CODE>
186
187<BR>
188&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;-branch flag -- checks out the file on a specified branch</TD>
189</TR>
190<TR BGCOLOR="white" CLASS="TableRowColor">
191<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
192<CODE>static&nbsp;java.lang.String</CODE></FONT></TD>
193<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/clearcase/CCCheckout.html#FLAG_COMMENT">FLAG_COMMENT</A></B></CODE>
194
195<BR>
196&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;-c flag -- comment to attach to the file</TD>
197</TR>
198<TR BGCOLOR="white" CLASS="TableRowColor">
199<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
200<CODE>static&nbsp;java.lang.String</CODE></FONT></TD>
201<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/clearcase/CCCheckout.html#FLAG_COMMENTFILE">FLAG_COMMENTFILE</A></B></CODE>
202
203<BR>
204&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;-cfile flag -- file containing a comment to attach to the file</TD>
205</TR>
206<TR BGCOLOR="white" CLASS="TableRowColor">
207<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
208<CODE>static&nbsp;java.lang.String</CODE></FONT></TD>
209<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/clearcase/CCCheckout.html#FLAG_NOCOMMENT">FLAG_NOCOMMENT</A></B></CODE>
210
211<BR>
212&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;-nc flag -- no comment is specified</TD>
213</TR>
214<TR BGCOLOR="white" CLASS="TableRowColor">
215<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
216<CODE>static&nbsp;java.lang.String</CODE></FONT></TD>
217<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/clearcase/CCCheckout.html#FLAG_NODATA">FLAG_NODATA</A></B></CODE>
218
219<BR>
220&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;-ndata flag -- checks out the file but does not create an editable file containing its data</TD>
221</TR>
222<TR BGCOLOR="white" CLASS="TableRowColor">
223<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
224<CODE>static&nbsp;java.lang.String</CODE></FONT></TD>
225<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/clearcase/CCCheckout.html#FLAG_NOWARN">FLAG_NOWARN</A></B></CODE>
226
227<BR>
228&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;-nwarn flag -- suppresses warning messages</TD>
229</TR>
230<TR BGCOLOR="white" CLASS="TableRowColor">
231<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
232<CODE>static&nbsp;java.lang.String</CODE></FONT></TD>
233<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/clearcase/CCCheckout.html#FLAG_OUT">FLAG_OUT</A></B></CODE>
234
235<BR>
236&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;-out flag -- create a writable file under a different filename</TD>
237</TR>
238<TR BGCOLOR="white" CLASS="TableRowColor">
239<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
240<CODE>static&nbsp;java.lang.String</CODE></FONT></TD>
241<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/clearcase/CCCheckout.html#FLAG_RESERVED">FLAG_RESERVED</A></B></CODE>
242
243<BR>
244&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;-reserved flag -- check out the file as reserved</TD>
245</TR>
246<TR BGCOLOR="white" CLASS="TableRowColor">
247<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
248<CODE>static&nbsp;java.lang.String</CODE></FONT></TD>
249<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/clearcase/CCCheckout.html#FLAG_UNRESERVED">FLAG_UNRESERVED</A></B></CODE>
250
251<BR>
252&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;-reserved flag -- check out the file as unreserved</TD>
253</TR>
254<TR BGCOLOR="white" CLASS="TableRowColor">
255<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
256<CODE>static&nbsp;java.lang.String</CODE></FONT></TD>
257<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/clearcase/CCCheckout.html#FLAG_VERSION">FLAG_VERSION</A></B></CODE>
258
259<BR>
260&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;-version flag -- allows checkout of a version that is not main latest</TD>
261</TR>
262</TABLE>
263&nbsp;<A NAME="fields_inherited_from_class_org.apache.tools.ant.taskdefs.optional.clearcase.ClearCase"><!-- --></A>
264<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
265<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
266<TD><B>Fields inherited from class org.apache.tools.ant.taskdefs.optional.clearcase.<A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/clearcase/ClearCase.html" title="class in org.apache.tools.ant.taskdefs.optional.clearcase">ClearCase</A></B></TD>
267</TR>
268<TR BGCOLOR="white" CLASS="TableRowColor">
269<TD><CODE><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/clearcase/ClearCase.html#COMMAND_CHECKIN">COMMAND_CHECKIN</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/clearcase/ClearCase.html#COMMAND_CHECKOUT">COMMAND_CHECKOUT</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/clearcase/ClearCase.html#COMMAND_LOCK">COMMAND_LOCK</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/clearcase/ClearCase.html#COMMAND_LSCO">COMMAND_LSCO</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/clearcase/ClearCase.html#COMMAND_MKATTR">COMMAND_MKATTR</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/clearcase/ClearCase.html#COMMAND_MKBL">COMMAND_MKBL</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/clearcase/ClearCase.html#COMMAND_MKDIR">COMMAND_MKDIR</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/clearcase/ClearCase.html#COMMAND_MKELEM">COMMAND_MKELEM</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/clearcase/ClearCase.html#COMMAND_MKLABEL">COMMAND_MKLABEL</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/clearcase/ClearCase.html#COMMAND_MKLBTYPE">COMMAND_MKLBTYPE</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/clearcase/ClearCase.html#COMMAND_RMTYPE">COMMAND_RMTYPE</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/clearcase/ClearCase.html#COMMAND_UNCHECKOUT">COMMAND_UNCHECKOUT</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/clearcase/ClearCase.html#COMMAND_UNLOCK">COMMAND_UNLOCK</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/clearcase/ClearCase.html#COMMAND_UPDATE">COMMAND_UPDATE</A></CODE></TD>
270</TR>
271</TABLE>
272&nbsp;<A NAME="fields_inherited_from_class_org.apache.tools.ant.Task"><!-- --></A>
273<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
274<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
275<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>
276</TR>
277<TR BGCOLOR="white" CLASS="TableRowColor">
278<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>
279</TR>
280</TABLE>
281&nbsp;<A NAME="fields_inherited_from_class_org.apache.tools.ant.ProjectComponent"><!-- --></A>
282<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
283<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
284<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>
285</TR>
286<TR BGCOLOR="white" CLASS="TableRowColor">
287<TD><CODE><A HREF="../../../../../../../org/apache/tools/ant/ProjectComponent.html#project">project</A></CODE></TD>
288</TR>
289</TABLE>
290&nbsp;
291<!-- ======== CONSTRUCTOR SUMMARY ======== -->
292
293<A NAME="constructor_summary"><!-- --></A>
294<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
295<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
296<TD COLSPAN=2><FONT SIZE="+2">
297<B>Constructor Summary</B></FONT></TD>
298</TR>
299<TR BGCOLOR="white" CLASS="TableRowColor">
300<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/clearcase/CCCheckout.html#CCCheckout()">CCCheckout</A></B>()</CODE>
301
302<BR>
303&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
304</TR>
305</TABLE>
306&nbsp;
307<!-- ========== METHOD SUMMARY =========== -->
308
309<A NAME="method_summary"><!-- --></A>
310<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
311<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
312<TD COLSPAN=2><FONT SIZE="+2">
313<B>Method Summary</B></FONT></TD>
314</TR>
315<TR BGCOLOR="white" CLASS="TableRowColor">
316<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
317<CODE>&nbsp;void</CODE></FONT></TD>
318<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/clearcase/CCCheckout.html#execute()">execute</A></B>()</CODE>
319
320<BR>
321&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Executes the task.</TD>
322</TR>
323<TR BGCOLOR="white" CLASS="TableRowColor">
324<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
325<CODE>&nbsp;java.lang.String</CODE></FONT></TD>
326<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/clearcase/CCCheckout.html#getBranch()">getBranch</A></B>()</CODE>
327
328<BR>
329&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get branch name</TD>
330</TR>
331<TR BGCOLOR="white" CLASS="TableRowColor">
332<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
333<CODE>&nbsp;java.lang.String</CODE></FONT></TD>
334<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/clearcase/CCCheckout.html#getComment()">getComment</A></B>()</CODE>
335
336<BR>
337&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get comment string</TD>
338</TR>
339<TR BGCOLOR="white" CLASS="TableRowColor">
340<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
341<CODE>&nbsp;java.lang.String</CODE></FONT></TD>
342<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/clearcase/CCCheckout.html#getCommentFile()">getCommentFile</A></B>()</CODE>
343
344<BR>
345&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get comment file</TD>
346</TR>
347<TR BGCOLOR="white" CLASS="TableRowColor">
348<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
349<CODE>&nbsp;boolean</CODE></FONT></TD>
350<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/clearcase/CCCheckout.html#getNoData()">getNoData</A></B>()</CODE>
351
352<BR>
353&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get nodata flag status</TD>
354</TR>
355<TR BGCOLOR="white" CLASS="TableRowColor">
356<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
357<CODE>&nbsp;boolean</CODE></FONT></TD>
358<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/clearcase/CCCheckout.html#getNotco()">getNotco</A></B>()</CODE>
359
360<BR>
361&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get notco flag status</TD>
362</TR>
363<TR BGCOLOR="white" CLASS="TableRowColor">
364<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
365<CODE>&nbsp;boolean</CODE></FONT></TD>
366<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/clearcase/CCCheckout.html#getNoWarn()">getNoWarn</A></B>()</CODE>
367
368<BR>
369&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get nowarn flag status</TD>
370</TR>
371<TR BGCOLOR="white" CLASS="TableRowColor">
372<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
373<CODE>&nbsp;java.lang.String</CODE></FONT></TD>
374<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/clearcase/CCCheckout.html#getOut()">getOut</A></B>()</CODE>
375
376<BR>
377&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get out file</TD>
378</TR>
379<TR BGCOLOR="white" CLASS="TableRowColor">
380<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
381<CODE>&nbsp;boolean</CODE></FONT></TD>
382<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/clearcase/CCCheckout.html#getReserved()">getReserved</A></B>()</CODE>
383
384<BR>
385&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get reserved flag status</TD>
386</TR>
387<TR BGCOLOR="white" CLASS="TableRowColor">
388<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
389<CODE>&nbsp;boolean</CODE></FONT></TD>
390<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/clearcase/CCCheckout.html#getVersion()">getVersion</A></B>()</CODE>
391
392<BR>
393&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get version flag status</TD>
394</TR>
395<TR BGCOLOR="white" CLASS="TableRowColor">
396<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
397<CODE>&nbsp;void</CODE></FONT></TD>
398<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/clearcase/CCCheckout.html#setBranch(java.lang.String)">setBranch</A></B>(java.lang.String&nbsp;branch)</CODE>
399
400<BR>
401&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Specify a branch to check out the file to.</TD>
402</TR>
403<TR BGCOLOR="white" CLASS="TableRowColor">
404<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
405<CODE>&nbsp;void</CODE></FONT></TD>
406<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/clearcase/CCCheckout.html#setComment(java.lang.String)">setComment</A></B>(java.lang.String&nbsp;comment)</CODE>
407
408<BR>
409&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Sets the comment string.</TD>
410</TR>
411<TR BGCOLOR="white" CLASS="TableRowColor">
412<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
413<CODE>&nbsp;void</CODE></FONT></TD>
414<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/clearcase/CCCheckout.html#setCommentFile(java.lang.String)">setCommentFile</A></B>(java.lang.String&nbsp;cfile)</CODE>
415
416<BR>
417&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Specifies a file containing a comment.</TD>
418</TR>
419<TR BGCOLOR="white" CLASS="TableRowColor">
420<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
421<CODE>&nbsp;void</CODE></FONT></TD>
422<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/clearcase/CCCheckout.html#setNoData(boolean)">setNoData</A></B>(boolean&nbsp;ndata)</CODE>
423
424<BR>
425&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;If true, checks out the file but does not create an
426 editable file containing its data.</TD>
427</TR>
428<TR BGCOLOR="white" CLASS="TableRowColor">
429<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
430<CODE>&nbsp;void</CODE></FONT></TD>
431<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/clearcase/CCCheckout.html#setNotco(boolean)">setNotco</A></B>(boolean&nbsp;notco)</CODE>
432
433<BR>
434&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;If true, checkout fails if the element is already checked out to the current view.</TD>
435</TR>
436<TR BGCOLOR="white" CLASS="TableRowColor">
437<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
438<CODE>&nbsp;void</CODE></FONT></TD>
439<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/clearcase/CCCheckout.html#setNoWarn(boolean)">setNoWarn</A></B>(boolean&nbsp;nwarn)</CODE>
440
441<BR>
442&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;If true, warning messages are suppressed.</TD>
443</TR>
444<TR BGCOLOR="white" CLASS="TableRowColor">
445<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
446<CODE>&nbsp;void</CODE></FONT></TD>
447<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/clearcase/CCCheckout.html#setOut(java.lang.String)">setOut</A></B>(java.lang.String&nbsp;outf)</CODE>
448
449<BR>
450&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Creates a writable file under a different filename.</TD>
451</TR>
452<TR BGCOLOR="white" CLASS="TableRowColor">
453<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
454<CODE>&nbsp;void</CODE></FONT></TD>
455<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/clearcase/CCCheckout.html#setReserved(boolean)">setReserved</A></B>(boolean&nbsp;reserved)</CODE>
456
457<BR>
458&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;If true, checks out the file as reserved.</TD>
459</TR>
460<TR BGCOLOR="white" CLASS="TableRowColor">
461<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
462<CODE>&nbsp;void</CODE></FONT></TD>
463<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/clearcase/CCCheckout.html#setVersion(boolean)">setVersion</A></B>(boolean&nbsp;version)</CODE>
464
465<BR>
466&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;If true, allows checkout of a version other than main latest.</TD>
467</TR>
468</TABLE>
469&nbsp;<A NAME="methods_inherited_from_class_org.apache.tools.ant.taskdefs.optional.clearcase.ClearCase"><!-- --></A>
470<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
471<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
472<TD><B>Methods inherited from class org.apache.tools.ant.taskdefs.optional.clearcase.<A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/clearcase/ClearCase.html" title="class in org.apache.tools.ant.taskdefs.optional.clearcase">ClearCase</A></B></TD>
473</TR>
474<TR BGCOLOR="white" CLASS="TableRowColor">
475<TD><CODE><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/clearcase/ClearCase.html#getClearToolCommand()">getClearToolCommand</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/clearcase/ClearCase.html#getFailOnErr()">getFailOnErr</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/clearcase/ClearCase.html#getObjSelect()">getObjSelect</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/clearcase/ClearCase.html#getViewPath()">getViewPath</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/clearcase/ClearCase.html#getViewPathBasename()">getViewPathBasename</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/clearcase/ClearCase.html#run(org.apache.tools.ant.types.Commandline)">run</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/clearcase/ClearCase.html#runS(org.apache.tools.ant.types.Commandline)">runS</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/clearcase/ClearCase.html#setClearToolDir(java.lang.String)">setClearToolDir</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/clearcase/ClearCase.html#setFailOnErr(boolean)">setFailOnErr</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/clearcase/ClearCase.html#setObjSelect(java.lang.String)">setObjSelect</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/clearcase/ClearCase.html#setViewPath(java.lang.String)">setViewPath</A></CODE></TD>
476</TR>
477</TABLE>
478&nbsp;<A NAME="methods_inherited_from_class_org.apache.tools.ant.Task"><!-- --></A>
479<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
480<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
481<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>
482</TR>
483<TR BGCOLOR="white" CLASS="TableRowColor">
484<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>
485</TR>
486</TABLE>
487&nbsp;<A NAME="methods_inherited_from_class_org.apache.tools.ant.ProjectComponent"><!-- --></A>
488<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
489<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
490<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>
491</TR>
492<TR BGCOLOR="white" CLASS="TableRowColor">
493<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>
494</TR>
495</TABLE>
496&nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
497<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
498<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
499<TD><B>Methods inherited from class java.lang.Object</B></TD>
500</TR>
501<TR BGCOLOR="white" CLASS="TableRowColor">
502<TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
503</TR>
504</TABLE>
505&nbsp;
506<P>
507
508<!-- ============ FIELD DETAIL =========== -->
509
510<A NAME="field_detail"><!-- --></A>
511<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
512<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
513<TD COLSPAN=1><FONT SIZE="+2">
514<B>Field Detail</B></FONT></TD>
515</TR>
516</TABLE>
517
518<A NAME="FLAG_RESERVED"><!-- --></A><H3>
519FLAG_RESERVED</H3>
520<PRE>
521public static final java.lang.String <B>FLAG_RESERVED</B></PRE>
522<DL>
523<DD>-reserved flag -- check out the file as reserved
524<P>
525<DL>
526<DT><B>See Also:</B><DD><A HREF="../../../../../../../constant-values.html#org.apache.tools.ant.taskdefs.optional.clearcase.CCCheckout.FLAG_RESERVED">Constant Field Values</A></DL>
527</DL>
528<HR>
529
530<A NAME="FLAG_UNRESERVED"><!-- --></A><H3>
531FLAG_UNRESERVED</H3>
532<PRE>
533public static final java.lang.String <B>FLAG_UNRESERVED</B></PRE>
534<DL>
535<DD>-reserved flag -- check out the file as unreserved
536<P>
537<DL>
538<DT><B>See Also:</B><DD><A HREF="../../../../../../../constant-values.html#org.apache.tools.ant.taskdefs.optional.clearcase.CCCheckout.FLAG_UNRESERVED">Constant Field Values</A></DL>
539</DL>
540<HR>
541
542<A NAME="FLAG_OUT"><!-- --></A><H3>
543FLAG_OUT</H3>
544<PRE>
545public static final java.lang.String <B>FLAG_OUT</B></PRE>
546<DL>
547<DD>-out flag -- create a writable file under a different filename
548<P>
549<DL>
550<DT><B>See Also:</B><DD><A HREF="../../../../../../../constant-values.html#org.apache.tools.ant.taskdefs.optional.clearcase.CCCheckout.FLAG_OUT">Constant Field Values</A></DL>
551</DL>
552<HR>
553
554<A NAME="FLAG_NODATA"><!-- --></A><H3>
555FLAG_NODATA</H3>
556<PRE>
557public static final java.lang.String <B>FLAG_NODATA</B></PRE>
558<DL>
559<DD>-ndata flag -- checks out the file but does not create an editable file containing its data
560<P>
561<DL>
562<DT><B>See Also:</B><DD><A HREF="../../../../../../../constant-values.html#org.apache.tools.ant.taskdefs.optional.clearcase.CCCheckout.FLAG_NODATA">Constant Field Values</A></DL>
563</DL>
564<HR>
565
566<A NAME="FLAG_BRANCH"><!-- --></A><H3>
567FLAG_BRANCH</H3>
568<PRE>
569public static final java.lang.String <B>FLAG_BRANCH</B></PRE>
570<DL>
571<DD>-branch flag -- checks out the file on a specified branch
572<P>
573<DL>
574<DT><B>See Also:</B><DD><A HREF="../../../../../../../constant-values.html#org.apache.tools.ant.taskdefs.optional.clearcase.CCCheckout.FLAG_BRANCH">Constant Field Values</A></DL>
575</DL>
576<HR>
577
578<A NAME="FLAG_VERSION"><!-- --></A><H3>
579FLAG_VERSION</H3>
580<PRE>
581public static final java.lang.String <B>FLAG_VERSION</B></PRE>
582<DL>
583<DD>-version flag -- allows checkout of a version that is not main latest
584<P>
585<DL>
586<DT><B>See Also:</B><DD><A HREF="../../../../../../../constant-values.html#org.apache.tools.ant.taskdefs.optional.clearcase.CCCheckout.FLAG_VERSION">Constant Field Values</A></DL>
587</DL>
588<HR>
589
590<A NAME="FLAG_NOWARN"><!-- --></A><H3>
591FLAG_NOWARN</H3>
592<PRE>
593public static final java.lang.String <B>FLAG_NOWARN</B></PRE>
594<DL>
595<DD>-nwarn flag -- suppresses warning messages
596<P>
597<DL>
598<DT><B>See Also:</B><DD><A HREF="../../../../../../../constant-values.html#org.apache.tools.ant.taskdefs.optional.clearcase.CCCheckout.FLAG_NOWARN">Constant Field Values</A></DL>
599</DL>
600<HR>
601
602<A NAME="FLAG_COMMENT"><!-- --></A><H3>
603FLAG_COMMENT</H3>
604<PRE>
605public static final java.lang.String <B>FLAG_COMMENT</B></PRE>
606<DL>
607<DD>-c flag -- comment to attach to the file
608<P>
609<DL>
610<DT><B>See Also:</B><DD><A HREF="../../../../../../../constant-values.html#org.apache.tools.ant.taskdefs.optional.clearcase.CCCheckout.FLAG_COMMENT">Constant Field Values</A></DL>
611</DL>
612<HR>
613
614<A NAME="FLAG_COMMENTFILE"><!-- --></A><H3>
615FLAG_COMMENTFILE</H3>
616<PRE>
617public static final java.lang.String <B>FLAG_COMMENTFILE</B></PRE>
618<DL>
619<DD>-cfile flag -- file containing a comment to attach to the file
620<P>
621<DL>
622<DT><B>See Also:</B><DD><A HREF="../../../../../../../constant-values.html#org.apache.tools.ant.taskdefs.optional.clearcase.CCCheckout.FLAG_COMMENTFILE">Constant Field Values</A></DL>
623</DL>
624<HR>
625
626<A NAME="FLAG_NOCOMMENT"><!-- --></A><H3>
627FLAG_NOCOMMENT</H3>
628<PRE>
629public static final java.lang.String <B>FLAG_NOCOMMENT</B></PRE>
630<DL>
631<DD>-nc flag -- no comment is specified
632<P>
633<DL>
634<DT><B>See Also:</B><DD><A HREF="../../../../../../../constant-values.html#org.apache.tools.ant.taskdefs.optional.clearcase.CCCheckout.FLAG_NOCOMMENT">Constant Field Values</A></DL>
635</DL>
636
637<!-- ========= CONSTRUCTOR DETAIL ======== -->
638
639<A NAME="constructor_detail"><!-- --></A>
640<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
641<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
642<TD COLSPAN=1><FONT SIZE="+2">
643<B>Constructor Detail</B></FONT></TD>
644</TR>
645</TABLE>
646
647<A NAME="CCCheckout()"><!-- --></A><H3>
648CCCheckout</H3>
649<PRE>
650public <B>CCCheckout</B>()</PRE>
651<DL>
652</DL>
653
654<!-- ============ METHOD DETAIL ========== -->
655
656<A NAME="method_detail"><!-- --></A>
657<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
658<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
659<TD COLSPAN=1><FONT SIZE="+2">
660<B>Method Detail</B></FONT></TD>
661</TR>
662</TABLE>
663
664<A NAME="execute()"><!-- --></A><H3>
665execute</H3>
666<PRE>
667public void <B>execute</B>()
668 throws <A HREF="../../../../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</A></PRE>
669<DL>
670<DD>Executes the task.
671 <p>
672 Builds a command line to execute cleartool and then calls Exec's run method
673 to execute the command line.
674<P>
675<DD><DL>
676<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>
677</DD>
678<DD><DL>
679
680<DT><B>Throws:</B>
681<DD><CODE><A HREF="../../../../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</A></CODE> - if the command fails and failonerr is set to true</DL>
682</DD>
683</DL>
684<HR>
685
686<A NAME="setReserved(boolean)"><!-- --></A><H3>
687setReserved</H3>
688<PRE>
689public void <B>setReserved</B>(boolean&nbsp;reserved)</PRE>
690<DL>
691<DD>If true, checks out the file as reserved.
692<P>
693<DD><DL>
694<DT><B>Parameters:</B><DD><CODE>reserved</CODE> - the status to set the flag to</DL>
695</DD>
696</DL>
697<HR>
698
699<A NAME="getReserved()"><!-- --></A><H3>
700getReserved</H3>
701<PRE>
702public boolean <B>getReserved</B>()</PRE>
703<DL>
704<DD>Get reserved flag status
705<P>
706<DD><DL>
707
708<DT><B>Returns:</B><DD>boolean containing status of reserved flag</DL>
709</DD>
710</DL>
711<HR>
712
713<A NAME="setNotco(boolean)"><!-- --></A><H3>
714setNotco</H3>
715<PRE>
716public void <B>setNotco</B>(boolean&nbsp;notco)</PRE>
717<DL>
718<DD>If true, checkout fails if the element is already checked out to the current view.
719<P>
720<DD><DL>
721<DT><B>Parameters:</B><DD><CODE>notco</CODE> - the status to set the flag to<DT><B>Since:</B></DT>
722 <DD>ant 1.6.1</DD>
723</DL>
724</DD>
725</DL>
726<HR>
727
728<A NAME="getNotco()"><!-- --></A><H3>
729getNotco</H3>
730<PRE>
731public boolean <B>getNotco</B>()</PRE>
732<DL>
733<DD>Get notco flag status
734<P>
735<DD><DL>
736
737<DT><B>Returns:</B><DD>boolean containing status of notco flag<DT><B>Since:</B></DT>
738 <DD>ant 1.6.1</DD>
739</DL>
740</DD>
741</DL>
742<HR>
743
744<A NAME="setOut(java.lang.String)"><!-- --></A><H3>
745setOut</H3>
746<PRE>
747public void <B>setOut</B>(java.lang.String&nbsp;outf)</PRE>
748<DL>
749<DD>Creates a writable file under a different filename.
750<P>
751<DD><DL>
752<DT><B>Parameters:</B><DD><CODE>outf</CODE> - the path to the out file</DL>
753</DD>
754</DL>
755<HR>
756
757<A NAME="getOut()"><!-- --></A><H3>
758getOut</H3>
759<PRE>
760public java.lang.String <B>getOut</B>()</PRE>
761<DL>
762<DD>Get out file
763<P>
764<DD><DL>
765
766<DT><B>Returns:</B><DD>String containing the path to the out file</DL>
767</DD>
768</DL>
769<HR>
770
771<A NAME="setNoData(boolean)"><!-- --></A><H3>
772setNoData</H3>
773<PRE>
774public void <B>setNoData</B>(boolean&nbsp;ndata)</PRE>
775<DL>
776<DD>If true, checks out the file but does not create an
777 editable file containing its data.
778<P>
779<DD><DL>
780<DT><B>Parameters:</B><DD><CODE>ndata</CODE> - the status to set the flag to</DL>
781</DD>
782</DL>
783<HR>
784
785<A NAME="getNoData()"><!-- --></A><H3>
786getNoData</H3>
787<PRE>
788public boolean <B>getNoData</B>()</PRE>
789<DL>
790<DD>Get nodata flag status
791<P>
792<DD><DL>
793
794<DT><B>Returns:</B><DD>boolean containing status of ndata flag</DL>
795</DD>
796</DL>
797<HR>
798
799<A NAME="setBranch(java.lang.String)"><!-- --></A><H3>
800setBranch</H3>
801<PRE>
802public void <B>setBranch</B>(java.lang.String&nbsp;branch)</PRE>
803<DL>
804<DD>Specify a branch to check out the file to.
805<P>
806<DD><DL>
807<DT><B>Parameters:</B><DD><CODE>branch</CODE> - the name of the branch</DL>
808</DD>
809</DL>
810<HR>
811
812<A NAME="getBranch()"><!-- --></A><H3>
813getBranch</H3>
814<PRE>
815public java.lang.String <B>getBranch</B>()</PRE>
816<DL>
817<DD>Get branch name
818<P>
819<DD><DL>
820
821<DT><B>Returns:</B><DD>String containing the name of the branch</DL>
822</DD>
823</DL>
824<HR>
825
826<A NAME="setVersion(boolean)"><!-- --></A><H3>
827setVersion</H3>
828<PRE>
829public void <B>setVersion</B>(boolean&nbsp;version)</PRE>
830<DL>
831<DD>If true, allows checkout of a version other than main latest.
832<P>
833<DD><DL>
834<DT><B>Parameters:</B><DD><CODE>version</CODE> - the status to set the flag to</DL>
835</DD>
836</DL>
837<HR>
838
839<A NAME="getVersion()"><!-- --></A><H3>
840getVersion</H3>
841<PRE>
842public boolean <B>getVersion</B>()</PRE>
843<DL>
844<DD>Get version flag status
845<P>
846<DD><DL>
847
848<DT><B>Returns:</B><DD>boolean containing status of version flag</DL>
849</DD>
850</DL>
851<HR>
852
853<A NAME="setNoWarn(boolean)"><!-- --></A><H3>
854setNoWarn</H3>
855<PRE>
856public void <B>setNoWarn</B>(boolean&nbsp;nwarn)</PRE>
857<DL>
858<DD>If true, warning messages are suppressed.
859<P>
860<DD><DL>
861<DT><B>Parameters:</B><DD><CODE>nwarn</CODE> - the status to set the flag to</DL>
862</DD>
863</DL>
864<HR>
865
866<A NAME="getNoWarn()"><!-- --></A><H3>
867getNoWarn</H3>
868<PRE>
869public boolean <B>getNoWarn</B>()</PRE>
870<DL>
871<DD>Get nowarn flag status
872<P>
873<DD><DL>
874
875<DT><B>Returns:</B><DD>boolean containing status of nwarn flag</DL>
876</DD>
877</DL>
878<HR>
879
880<A NAME="setComment(java.lang.String)"><!-- --></A><H3>
881setComment</H3>
882<PRE>
883public void <B>setComment</B>(java.lang.String&nbsp;comment)</PRE>
884<DL>
885<DD>Sets the comment string.
886<P>
887<DD><DL>
888<DT><B>Parameters:</B><DD><CODE>comment</CODE> - the comment string</DL>
889</DD>
890</DL>
891<HR>
892
893<A NAME="getComment()"><!-- --></A><H3>
894getComment</H3>
895<PRE>
896public java.lang.String <B>getComment</B>()</PRE>
897<DL>
898<DD>Get comment string
899<P>
900<DD><DL>
901
902<DT><B>Returns:</B><DD>String containing the comment</DL>
903</DD>
904</DL>
905<HR>
906
907<A NAME="setCommentFile(java.lang.String)"><!-- --></A><H3>
908setCommentFile</H3>
909<PRE>
910public void <B>setCommentFile</B>(java.lang.String&nbsp;cfile)</PRE>
911<DL>
912<DD>Specifies a file containing a comment.
913<P>
914<DD><DL>
915<DT><B>Parameters:</B><DD><CODE>cfile</CODE> - the path to the comment file</DL>
916</DD>
917</DL>
918<HR>
919
920<A NAME="getCommentFile()"><!-- --></A><H3>
921getCommentFile</H3>
922<PRE>
923public java.lang.String <B>getCommentFile</B>()</PRE>
924<DL>
925<DD>Get comment file
926<P>
927<DD><DL>
928
929<DT><B>Returns:</B><DD>String containing the path to the comment file</DL>
930</DD>
931</DL>
932<!-- ========= END OF CLASS DATA ========= -->
933<HR>
934
935
936<!-- ======= START OF BOTTOM NAVBAR ====== -->
937<A NAME="navbar_bottom"><!-- --></A>
938<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
939<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
940<TR>
941<TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
942<A NAME="navbar_bottom_firstrow"><!-- --></A>
943<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
944 <TR ALIGN="center" VALIGN="top">
945 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
946 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
947 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
948 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
949 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
950 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
951 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
952 </TR>
953</TABLE>
954</TD>
955<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
956</EM>
957</TD>
958</TR>
959
960<TR>
961<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
962&nbsp;<A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/clearcase/CCCheckin.html" title="class in org.apache.tools.ant.taskdefs.optional.clearcase"><B>PREV CLASS</B></A>&nbsp;
963&nbsp;<A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/clearcase/CCLock.html" title="class in org.apache.tools.ant.taskdefs.optional.clearcase"><B>NEXT CLASS</B></A></FONT></TD>
964<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
965 <A HREF="../../../../../../../index.html" target="_top"><B>FRAMES</B></A> &nbsp;
966&nbsp;<A HREF="CCCheckout.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
967&nbsp;<SCRIPT type="text/javascript">
968 <!--
969 if(window==top) {
970 document.writeln('<A HREF="../../../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
971 }
972 //-->
973</SCRIPT>
974<NOSCRIPT>
975 <A HREF="../../../../../../../allclasses-noframe.html"><B>All Classes</B></A>
976</NOSCRIPT>
977
978</FONT></TD>
979</TR>
980<TR>
981<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
982 SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;<A HREF="#field_summary">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
983<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
984DETAIL:&nbsp;<A HREF="#field_detail">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
985</TR>
986</TABLE>
987<A NAME="skip-navbar_bottom"></A>
988<!-- ======== END OF BOTTOM NAVBAR ======= -->
989
990<HR>
991Copyright © 2000-2007 Apache Software Foundation. All Rights Reserved.
992</BODY>
993</HTML>
Note: See TracBrowser for help on using the repository browser.