Context Navigation

← Previous Revision
Latest Revision
Next Revision →
Blame
Revision Log

source: other-projects/trunk/gs3-release-maker/apache-ant-1.6.5/build/javadocs/org/apache/tools/ant/taskdefs/AbstractCvsTask.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: 50.4 KB

Line
1	<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
2	<!--NewPage-->
3	<HTML>
4	<HEAD>
5	<!-- Generated by javadoc (build 1.4.2_13) on Mon Oct 01 14:33:17 NZST 2007 -->
6	<TITLE>
7	AbstractCvsTask (Apache Ant API)
8	</TITLE>
9
10	<META NAME="keywords" CONTENT="org.apache.tools.ant.taskdefs.AbstractCvsTask 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="AbstractCvsTask (Apache Ant API)";
18	}
19	</SCRIPT>
20
21	</HEAD>
22
23	<BODY BGCOLOR="white" onload="windowTitle();">
24
25
26	<!-- ========= START OF TOP NAVBAR ======= -->
27	<A NAME="navbar_top"><!-- --></A>
28	<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
29	<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
30	<TR>
31	<TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
32	<A NAME="navbar_top_firstrow"><!-- --></A>
33	<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
34	<TR ALIGN="center" VALIGN="top">
35	<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
36	<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
37	<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev">  <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
38	<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
39	<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
40	<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
41	<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
42	</TR>
43	</TABLE>
44	</TD>
45	<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
46	</EM>
47	</TD>
48	</TR>
49
50	<TR>
51	<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
52	PREV CLASS
53	<A HREF="../../../../../org/apache/tools/ant/taskdefs/Ant.html" title="class in org.apache.tools.ant.taskdefs"><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="AbstractCvsTask.html" target="_top"><B>NO FRAMES</B></A>
57	<SCRIPT type="text/javascript">
58	<!--
59	if(window==top) {
60	document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
61	}
62	//-->
63	</SCRIPT>
64	<NOSCRIPT>
65	<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
66	</NOSCRIPT>
67
68	</FONT></TD>
69	</TR>
70	<TR>
71	<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
72	SUMMARY: NESTED \| <A HREF="#field_summary">FIELD</A> \| <A HREF="#constructor_summary">CONSTR</A> \| <A HREF="#method_summary">METHOD</A></FONT></TD>
73	<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
74	DETAIL: <A HREF="#field_detail">FIELD</A> \| <A HREF="#constructor_detail">CONSTR</A> \| <A HREF="#method_detail">METHOD</A></FONT></TD>
75	</TR>
76	</TABLE>
77	<A NAME="skip-navbar_top"></A>
78	<!-- ========= END OF TOP NAVBAR ========= -->
79
80	<HR>
81	<!-- ======== START OF CLASS DATA ======== -->
82	<H2>
83	<FONT SIZE="-1">
84	org.apache.tools.ant.taskdefs</FONT>
85	<BR>
86	Class AbstractCvsTask</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.AbstractCvsTask</B>
92	</PRE>
93	<DL>
94	<DT><B>Direct Known Subclasses:</B> <DD><A HREF="../../../../../org/apache/tools/ant/taskdefs/cvslib/ChangeLogTask.html" title="class in org.apache.tools.ant.taskdefs.cvslib">ChangeLogTask</A>, <A HREF="../../../../../org/apache/tools/ant/taskdefs/Cvs.html" title="class in org.apache.tools.ant.taskdefs">Cvs</A>, <A HREF="../../../../../org/apache/tools/ant/taskdefs/cvslib/CvsTagDiff.html" title="class in org.apache.tools.ant.taskdefs.cvslib">CvsTagDiff</A>, <A HREF="../../../../../org/apache/tools/ant/taskdefs/cvslib/CvsVersion.html" title="class in org.apache.tools.ant.taskdefs.cvslib">CvsVersion</A></DD>
95	</DL>
96	<HR>
97	<DL>
98	<DT>public abstract class <B>AbstractCvsTask</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	original Cvs.java 1.20
102
103	NOTE: This implementation has been moved here from Cvs.java with
104	the addition of some accessors for extensibility. Another task
105	can extend this with some customized output processing.
106	<P>
107
108	<P>
109	<DL>
110	<DT><B>Since:</B></DT>
111	<DD>Ant 1.5</DD>
112	</DL>
113	<HR>
114
115	<P>
116	<!-- ======== NESTED CLASS SUMMARY ======== -->
117
118
119	<!-- =========== FIELD SUMMARY =========== -->
120
121	<A NAME="field_summary"><!-- --></A>
122	<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
123	<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
124	<TD COLSPAN=2><FONT SIZE="+2">
125	<B>Field Summary</B></FONT></TD>
126	</TR>
127	<TR BGCOLOR="white" CLASS="TableRowColor">
128	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
129	<CODE>static int</CODE></FONT></TD>
130	<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/AbstractCvsTask.html#DEFAULT_COMPRESSION_LEVEL">DEFAULT_COMPRESSION_LEVEL</A></B></CODE>
131
132	<BR>
133	Default compression level to use, if compression is enabled via
134	setCompression( true ).</TD>
135	</TR>
136	</TABLE>
137	<A NAME="fields_inherited_from_class_org.apache.tools.ant.Task"><!-- --></A>
138	<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
139	<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
140	<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>
141	</TR>
142	<TR BGCOLOR="white" CLASS="TableRowColor">
143	<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>
144	</TR>
145	</TABLE>
146	<A NAME="fields_inherited_from_class_org.apache.tools.ant.ProjectComponent"><!-- --></A>
147	<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
148	<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
149	<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>
150	</TR>
151	<TR BGCOLOR="white" CLASS="TableRowColor">
152	<TD><CODE><A HREF="../../../../../org/apache/tools/ant/ProjectComponent.html#project">project</A></CODE></TD>
153	</TR>
154	</TABLE>
155
156	<!-- ======== CONSTRUCTOR SUMMARY ======== -->
157
158	<A NAME="constructor_summary"><!-- --></A>
159	<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
160	<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
161	<TD COLSPAN=2><FONT SIZE="+2">
162	<B>Constructor Summary</B></FONT></TD>
163	</TR>
164	<TR BGCOLOR="white" CLASS="TableRowColor">
165	<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/AbstractCvsTask.html#AbstractCvsTask()">AbstractCvsTask</A></B>()</CODE>
166
167	<BR>
168	empty no-arg constructor</TD>
169	</TR>
170	</TABLE>
171
172	<!-- ========== METHOD SUMMARY =========== -->
173
174	<A NAME="method_summary"><!-- --></A>
175	<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
176	<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
177	<TD COLSPAN=2><FONT SIZE="+2">
178	<B>Method Summary</B></FONT></TD>
179	</TR>
180	<TR BGCOLOR="white" CLASS="TableRowColor">
181	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
182	<CODE> void</CODE></FONT></TD>
183	<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/AbstractCvsTask.html#addCommandArgument(org.apache.tools.ant.types.Commandline, java.lang.String)">addCommandArgument</A></B>(<A HREF="../../../../../org/apache/tools/ant/types/Commandline.html" title="class in org.apache.tools.ant.types">Commandline</A> c,
184	java.lang.String arg)</CODE>
185
186	<BR>
187	This method adds a command line argument to an external command.</TD>
188	</TR>
189	<TR BGCOLOR="white" CLASS="TableRowColor">
190	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
191	<CODE> void</CODE></FONT></TD>
192	<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/AbstractCvsTask.html#addCommandArgument(java.lang.String)">addCommandArgument</A></B>(java.lang.String arg)</CODE>
193
194	<BR>
195	This needs to be public to allow configuration
196	of commands externally.</TD>
197	</TR>
198	<TR BGCOLOR="white" CLASS="TableRowColor">
199	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
200	<CODE> void</CODE></FONT></TD>
201	<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/AbstractCvsTask.html#addConfiguredCommandline(org.apache.tools.ant.types.Commandline)">addConfiguredCommandline</A></B>(<A HREF="../../../../../org/apache/tools/ant/types/Commandline.html" title="class in org.apache.tools.ant.types">Commandline</A> c)</CODE>
202
203	<BR>
204	Adds direct command-line to execute.</TD>
205	</TR>
206	<TR BGCOLOR="white" CLASS="TableRowColor">
207	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
208	<CODE> void</CODE></FONT></TD>
209	<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/AbstractCvsTask.html#addConfiguredCommandline(org.apache.tools.ant.types.Commandline, boolean)">addConfiguredCommandline</A></B>(<A HREF="../../../../../org/apache/tools/ant/types/Commandline.html" title="class in org.apache.tools.ant.types">Commandline</A> c,
210	boolean insertAtStart)</CODE>
211
212	<BR>
213	Configures and adds the given Commandline.</TD>
214	</TR>
215	<TR BGCOLOR="white" CLASS="TableRowColor">
216	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
217	<CODE>protected  void</CODE></FONT></TD>
218	<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/AbstractCvsTask.html#configureCommandline(org.apache.tools.ant.types.Commandline)">configureCommandline</A></B>(<A HREF="../../../../../org/apache/tools/ant/types/Commandline.html" title="class in org.apache.tools.ant.types">Commandline</A> c)</CODE>
219
220	<BR>
221	Configure a commandline element for things like cvsRoot, quiet, etc.</TD>
222	</TR>
223	<TR BGCOLOR="white" CLASS="TableRowColor">
224	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
225	<CODE> void</CODE></FONT></TD>
226	<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/AbstractCvsTask.html#execute()">execute</A></B>()</CODE>
227
228	<BR>
229	do the work</TD>
230	</TR>
231	<TR BGCOLOR="white" CLASS="TableRowColor">
232	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
233	<CODE> java.lang.String</CODE></FONT></TD>
234	<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/AbstractCvsTask.html#getCommand()">getCommand</A></B>()</CODE>
235
236	<BR>
237	accessor to a command line as string
238
239	This should be deprecated
240	AntoineLL July 23d 2003</TD>
241	</TR>
242	<TR BGCOLOR="white" CLASS="TableRowColor">
243	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
244	<CODE> java.lang.String</CODE></FONT></TD>
245	<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/AbstractCvsTask.html#getCvsRoot()">getCvsRoot</A></B>()</CODE>
246
247	<BR>
248	access the CVSROOT variable</TD>
249	</TR>
250	<TR BGCOLOR="white" CLASS="TableRowColor">
251	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
252	<CODE> java.lang.String</CODE></FONT></TD>
253	<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/AbstractCvsTask.html#getCvsRsh()">getCvsRsh</A></B>()</CODE>
254
255	<BR>
256	access the CVS_RSH variable</TD>
257	</TR>
258	<TR BGCOLOR="white" CLASS="TableRowColor">
259	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
260	<CODE> java.io.File</CODE></FONT></TD>
261	<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/AbstractCvsTask.html#getDest()">getDest</A></B>()</CODE>
262
263	<BR>
264	get the file where the checked out files should be placed</TD>
265	</TR>
266	<TR BGCOLOR="white" CLASS="TableRowColor">
267	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
268	<CODE>protected  java.io.OutputStream</CODE></FONT></TD>
269	<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/AbstractCvsTask.html#getErrorStream()">getErrorStream</A></B>()</CODE>
270
271	<BR>
272	access the stream to which the stderr from cvs should go
273	if this stream has already been set, it will be returned
274	if the stream has not yet been set, if the attribute error
275	has been set, the output stream will go to the file denoted by the error attribute
276	otherwise the stderr output will go to ant's logging system</TD>
277	</TR>
278	<TR BGCOLOR="white" CLASS="TableRowColor">
279	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
280	<CODE>protected  <A HREF="../../../../../org/apache/tools/ant/taskdefs/ExecuteStreamHandler.html" title="interface in org.apache.tools.ant.taskdefs">ExecuteStreamHandler</A></CODE></FONT></TD>
281	<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/AbstractCvsTask.html#getExecuteStreamHandler()">getExecuteStreamHandler</A></B>()</CODE>
282
283	<BR>
284	find the handler and instantiate it if it does not exist yet</TD>
285	</TR>
286	<TR BGCOLOR="white" CLASS="TableRowColor">
287	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
288	<CODE>protected  java.io.OutputStream</CODE></FONT></TD>
289	<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/AbstractCvsTask.html#getOutputStream()">getOutputStream</A></B>()</CODE>
290
291	<BR>
292	access the stream to which the stdout from cvs should go
293	if this stream has already been set, it will be returned
294	if the stream has not yet been set, if the attribute output
295	has been set, the output stream will go to the output file
296	otherwise the output will go to ant's logging system</TD>
297	</TR>
298	<TR BGCOLOR="white" CLASS="TableRowColor">
299	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
300	<CODE> java.lang.String</CODE></FONT></TD>
301	<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/AbstractCvsTask.html#getPackage()">getPackage</A></B>()</CODE>
302
303	<BR>
304	access the package or module to operate upon</TD>
305	</TR>
306	<TR BGCOLOR="white" CLASS="TableRowColor">
307	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
308	<CODE> java.io.File</CODE></FONT></TD>
309	<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/AbstractCvsTask.html#getPassFile()">getPassFile</A></B>()</CODE>
310
311	<BR>
312	find the password file</TD>
313	</TR>
314	<TR BGCOLOR="white" CLASS="TableRowColor">
315	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
316	<CODE> int</CODE></FONT></TD>
317	<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/AbstractCvsTask.html#getPort()">getPort</A></B>()</CODE>
318
319	<BR>
320	access the port of CVS</TD>
321	</TR>
322	<TR BGCOLOR="white" CLASS="TableRowColor">
323	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
324	<CODE> java.lang.String</CODE></FONT></TD>
325	<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/AbstractCvsTask.html#getTag()">getTag</A></B>()</CODE>
326
327	<BR>
328	tag or branch</TD>
329	</TR>
330	<TR BGCOLOR="white" CLASS="TableRowColor">
331	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
332	<CODE>protected  void</CODE></FONT></TD>
333	<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/AbstractCvsTask.html#removeCommandline(org.apache.tools.ant.types.Commandline)">removeCommandline</A></B>(<A HREF="../../../../../org/apache/tools/ant/types/Commandline.html" title="class in org.apache.tools.ant.types">Commandline</A> c)</CODE>
334
335	<BR>
336	remove a particular command from a vector of command lines</TD>
337	</TR>
338	<TR BGCOLOR="white" CLASS="TableRowColor">
339	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
340	<CODE>protected  void</CODE></FONT></TD>
341	<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/AbstractCvsTask.html#runCommand(org.apache.tools.ant.types.Commandline)">runCommand</A></B>(<A HREF="../../../../../org/apache/tools/ant/types/Commandline.html" title="class in org.apache.tools.ant.types">Commandline</A> toExecute)</CODE>
342
343	<BR>
344	Sets up the environment for toExecute and then runs it.</TD>
345	</TR>
346	<TR BGCOLOR="white" CLASS="TableRowColor">
347	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
348	<CODE> void</CODE></FONT></TD>
349	<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/AbstractCvsTask.html#setAppend(boolean)">setAppend</A></B>(boolean value)</CODE>
350
351	<BR>
352	Whether to append output/error when redirecting to a file.</TD>
353	</TR>
354	<TR BGCOLOR="white" CLASS="TableRowColor">
355	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
356	<CODE> void</CODE></FONT></TD>
357	<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/AbstractCvsTask.html#setCommand(java.lang.String)">setCommand</A></B>(java.lang.String c)</CODE>
358
359	<BR>
360	The CVS command to execute.</TD>
361	</TR>
362	<TR BGCOLOR="white" CLASS="TableRowColor">
363	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
364	<CODE> void</CODE></FONT></TD>
365	<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/AbstractCvsTask.html#setCompression(boolean)">setCompression</A></B>(boolean usecomp)</CODE>
366
367	<BR>
368	If true, this is the same as compressionlevel="3".</TD>
369	</TR>
370	<TR BGCOLOR="white" CLASS="TableRowColor">
371	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
372	<CODE> void</CODE></FONT></TD>
373	<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/AbstractCvsTask.html#setCompressionLevel(int)">setCompressionLevel</A></B>(int level)</CODE>
374
375	<BR>
376	If set to a value 1-9 it adds -zN to the cvs command line, else
377	it disables compression.</TD>
378	</TR>
379	<TR BGCOLOR="white" CLASS="TableRowColor">
380	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
381	<CODE> void</CODE></FONT></TD>
382	<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/AbstractCvsTask.html#setCvsRoot(java.lang.String)">setCvsRoot</A></B>(java.lang.String root)</CODE>
383
384	<BR>
385	The CVSROOT variable.</TD>
386	</TR>
387	<TR BGCOLOR="white" CLASS="TableRowColor">
388	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
389	<CODE> void</CODE></FONT></TD>
390	<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/AbstractCvsTask.html#setCvsRsh(java.lang.String)">setCvsRsh</A></B>(java.lang.String rsh)</CODE>
391
392	<BR>
393	The CVS_RSH variable.</TD>
394	</TR>
395	<TR BGCOLOR="white" CLASS="TableRowColor">
396	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
397	<CODE> void</CODE></FONT></TD>
398	<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/AbstractCvsTask.html#setDate(java.lang.String)">setDate</A></B>(java.lang.String p)</CODE>
399
400	<BR>
401	Use the most recent revision no later than the given date.</TD>
402	</TR>
403	<TR BGCOLOR="white" CLASS="TableRowColor">
404	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
405	<CODE> void</CODE></FONT></TD>
406	<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/AbstractCvsTask.html#setDest(java.io.File)">setDest</A></B>(java.io.File dest)</CODE>
407
408	<BR>
409	The directory where the checked out files should be placed.</TD>
410	</TR>
411	<TR BGCOLOR="white" CLASS="TableRowColor">
412	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
413	<CODE> void</CODE></FONT></TD>
414	<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/AbstractCvsTask.html#setError(java.io.File)">setError</A></B>(java.io.File error)</CODE>
415
416	<BR>
417	The file to direct standard error from the command.</TD>
418	</TR>
419	<TR BGCOLOR="white" CLASS="TableRowColor">
420	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
421	<CODE>protected  void</CODE></FONT></TD>
422	<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/AbstractCvsTask.html#setErrorStream(java.io.OutputStream)">setErrorStream</A></B>(java.io.OutputStream errorStream)</CODE>
423
424	<BR>
425	sets a stream to which the stderr from the cvs exe should go</TD>
426	</TR>
427	<TR BGCOLOR="white" CLASS="TableRowColor">
428	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
429	<CODE> void</CODE></FONT></TD>
430	<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/AbstractCvsTask.html#setExecuteStreamHandler(org.apache.tools.ant.taskdefs.ExecuteStreamHandler)">setExecuteStreamHandler</A></B>(<A HREF="../../../../../org/apache/tools/ant/taskdefs/ExecuteStreamHandler.html" title="interface in org.apache.tools.ant.taskdefs">ExecuteStreamHandler</A> handler)</CODE>
431
432	<BR>
433	sets the handler</TD>
434	</TR>
435	<TR BGCOLOR="white" CLASS="TableRowColor">
436	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
437	<CODE> void</CODE></FONT></TD>
438	<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/AbstractCvsTask.html#setFailOnError(boolean)">setFailOnError</A></B>(boolean failOnError)</CODE>
439
440	<BR>
441	Stop the build process if the command exits with
442	a return code other than 0.</TD>
443	</TR>
444	<TR BGCOLOR="white" CLASS="TableRowColor">
445	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
446	<CODE> void</CODE></FONT></TD>
447	<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/AbstractCvsTask.html#setNoexec(boolean)">setNoexec</A></B>(boolean ne)</CODE>
448
449	<BR>
450	If true, report only and don't change any files.</TD>
451	</TR>
452	<TR BGCOLOR="white" CLASS="TableRowColor">
453	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
454	<CODE> void</CODE></FONT></TD>
455	<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/AbstractCvsTask.html#setOutput(java.io.File)">setOutput</A></B>(java.io.File output)</CODE>
456
457	<BR>
458	The file to direct standard output from the command.</TD>
459	</TR>
460	<TR BGCOLOR="white" CLASS="TableRowColor">
461	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
462	<CODE>protected  void</CODE></FONT></TD>
463	<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/AbstractCvsTask.html#setOutputStream(java.io.OutputStream)">setOutputStream</A></B>(java.io.OutputStream outputStream)</CODE>
464
465	<BR>
466	sets a stream to which the output from the cvs executable should be sent</TD>
467	</TR>
468	<TR BGCOLOR="white" CLASS="TableRowColor">
469	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
470	<CODE> void</CODE></FONT></TD>
471	<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/AbstractCvsTask.html#setPackage(java.lang.String)">setPackage</A></B>(java.lang.String p)</CODE>
472
473	<BR>
474	The package/module to operate upon.</TD>
475	</TR>
476	<TR BGCOLOR="white" CLASS="TableRowColor">
477	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
478	<CODE> void</CODE></FONT></TD>
479	<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/AbstractCvsTask.html#setPassfile(java.io.File)">setPassfile</A></B>(java.io.File passFile)</CODE>
480
481	<BR>
482	Password file to read passwords from.</TD>
483	</TR>
484	<TR BGCOLOR="white" CLASS="TableRowColor">
485	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
486	<CODE> void</CODE></FONT></TD>
487	<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/AbstractCvsTask.html#setPort(int)">setPort</A></B>(int port)</CODE>
488
489	<BR>
490	Port used by CVS to communicate with the server.</TD>
491	</TR>
492	<TR BGCOLOR="white" CLASS="TableRowColor">
493	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
494	<CODE> void</CODE></FONT></TD>
495	<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/AbstractCvsTask.html#setQuiet(boolean)">setQuiet</A></B>(boolean q)</CODE>
496
497	<BR>
498	If true, suppress informational messages.</TD>
499	</TR>
500	<TR BGCOLOR="white" CLASS="TableRowColor">
501	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
502	<CODE> void</CODE></FONT></TD>
503	<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/AbstractCvsTask.html#setReallyquiet(boolean)">setReallyquiet</A></B>(boolean q)</CODE>
504
505	<BR>
506	If true, suppress all messages.</TD>
507	</TR>
508	<TR BGCOLOR="white" CLASS="TableRowColor">
509	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
510	<CODE> void</CODE></FONT></TD>
511	<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/AbstractCvsTask.html#setTag(java.lang.String)">setTag</A></B>(java.lang.String p)</CODE>
512
513	<BR>
514	The tag of the package/module to operate upon.</TD>
515	</TR>
516	</TABLE>
517	<A NAME="methods_inherited_from_class_org.apache.tools.ant.Task"><!-- --></A>
518	<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
519	<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
520	<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>
521	</TR>
522	<TR BGCOLOR="white" CLASS="TableRowColor">
523	<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>
524	</TR>
525	</TABLE>
526	<A NAME="methods_inherited_from_class_org.apache.tools.ant.ProjectComponent"><!-- --></A>
527	<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
528	<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
529	<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>
530	</TR>
531	<TR BGCOLOR="white" CLASS="TableRowColor">
532	<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>
533	</TR>
534	</TABLE>
535	<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
536	<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
537	<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
538	<TD><B>Methods inherited from class java.lang.Object</B></TD>
539	</TR>
540	<TR BGCOLOR="white" CLASS="TableRowColor">
541	<TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
542	</TR>
543	</TABLE>
544
545	<P>
546
547	<!-- ============ FIELD DETAIL =========== -->
548
549	<A NAME="field_detail"><!-- --></A>
550	<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
551	<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
552	<TD COLSPAN=1><FONT SIZE="+2">
553	<B>Field Detail</B></FONT></TD>
554	</TR>
555	</TABLE>
556
557	<A NAME="DEFAULT_COMPRESSION_LEVEL"><!-- --></A><H3>
558	DEFAULT_COMPRESSION_LEVEL</H3>
559	<PRE>
560	public static final int <B>DEFAULT_COMPRESSION_LEVEL</B></PRE>
561	<DL>
562	<DD>Default compression level to use, if compression is enabled via
563	setCompression( true ).
564	<P>
565	<DL>
566	<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.tools.ant.taskdefs.AbstractCvsTask.DEFAULT_COMPRESSION_LEVEL">Constant Field Values</A></DL>
567	</DL>
568
569	<!-- ========= CONSTRUCTOR DETAIL ======== -->
570
571	<A NAME="constructor_detail"><!-- --></A>
572	<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
573	<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
574	<TD COLSPAN=1><FONT SIZE="+2">
575	<B>Constructor Detail</B></FONT></TD>
576	</TR>
577	</TABLE>
578
579	<A NAME="AbstractCvsTask()"><!-- --></A><H3>
580	AbstractCvsTask</H3>
581	<PRE>
582	public <B>AbstractCvsTask</B>()</PRE>
583	<DL>
584	<DD>empty no-arg constructor
585	<P>
586	</DL>
587
588	<!-- ============ METHOD DETAIL ========== -->
589
590	<A NAME="method_detail"><!-- --></A>
591	<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
592	<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
593	<TD COLSPAN=1><FONT SIZE="+2">
594	<B>Method Detail</B></FONT></TD>
595	</TR>
596	</TABLE>
597
598	<A NAME="setExecuteStreamHandler(org.apache.tools.ant.taskdefs.ExecuteStreamHandler)"><!-- --></A><H3>
599	setExecuteStreamHandler</H3>
600	<PRE>
601	public void <B>setExecuteStreamHandler</B>(<A HREF="../../../../../org/apache/tools/ant/taskdefs/ExecuteStreamHandler.html" title="interface in org.apache.tools.ant.taskdefs">ExecuteStreamHandler</A> handler)</PRE>
602	<DL>
603	<DD>sets the handler
604	<P>
605	<DD><DL>
606	<DT><B>Parameters:</B><DD><CODE>handler</CODE> - a handler able of processing the output and error streams from the cvs exe</DL>
607	</DD>
608	</DL>
609	<HR>
610
611	<A NAME="getExecuteStreamHandler()"><!-- --></A><H3>
612	getExecuteStreamHandler</H3>
613	<PRE>
614	protected <A HREF="../../../../../org/apache/tools/ant/taskdefs/ExecuteStreamHandler.html" title="interface in org.apache.tools.ant.taskdefs">ExecuteStreamHandler</A> <B>getExecuteStreamHandler</B>()</PRE>
615	<DL>
616	<DD>find the handler and instantiate it if it does not exist yet
617	<P>
618	<DD><DL>
619
620	<DT><B>Returns:</B><DD>handler for output and error streams</DL>
621	</DD>
622	</DL>
623	<HR>
624
625	<A NAME="setOutputStream(java.io.OutputStream)"><!-- --></A><H3>
626	setOutputStream</H3>
627	<PRE>
628	protected void <B>setOutputStream</B>(java.io.OutputStream outputStream)</PRE>
629	<DL>
630	<DD>sets a stream to which the output from the cvs executable should be sent
631	<P>
632	<DD><DL>
633	<DT><B>Parameters:</B><DD><CODE>outputStream</CODE> - stream to which the stdout from cvs should go</DL>
634	</DD>
635	</DL>
636	<HR>
637
638	<A NAME="getOutputStream()"><!-- --></A><H3>
639	getOutputStream</H3>
640	<PRE>
641	protected java.io.OutputStream <B>getOutputStream</B>()</PRE>
642	<DL>
643	<DD>access the stream to which the stdout from cvs should go
644	if this stream has already been set, it will be returned
645	if the stream has not yet been set, if the attribute output
646	has been set, the output stream will go to the output file
647	otherwise the output will go to ant's logging system
648	<P>
649	<DD><DL>
650
651	<DT><B>Returns:</B><DD>output stream to which cvs' stdout should go to</DL>
652	</DD>
653	</DL>
654	<HR>
655
656	<A NAME="setErrorStream(java.io.OutputStream)"><!-- --></A><H3>
657	setErrorStream</H3>
658	<PRE>
659	protected void <B>setErrorStream</B>(java.io.OutputStream errorStream)</PRE>
660	<DL>
661	<DD>sets a stream to which the stderr from the cvs exe should go
662	<P>
663	<DD><DL>
664	<DT><B>Parameters:</B><DD><CODE>errorStream</CODE> - an output stream willing to process stderr</DL>
665	</DD>
666	</DL>
667	<HR>
668
669	<A NAME="getErrorStream()"><!-- --></A><H3>
670	getErrorStream</H3>
671	<PRE>
672	protected java.io.OutputStream <B>getErrorStream</B>()</PRE>
673	<DL>
674	<DD>access the stream to which the stderr from cvs should go
675	if this stream has already been set, it will be returned
676	if the stream has not yet been set, if the attribute error
677	has been set, the output stream will go to the file denoted by the error attribute
678	otherwise the stderr output will go to ant's logging system
679	<P>
680	<DD><DL>
681
682	<DT><B>Returns:</B><DD>output stream to which cvs' stderr should go to</DL>
683	</DD>
684	</DL>
685	<HR>
686
687	<A NAME="runCommand(org.apache.tools.ant.types.Commandline)"><!-- --></A><H3>
688	runCommand</H3>
689	<PRE>
690	protected void <B>runCommand</B>(<A HREF="../../../../../org/apache/tools/ant/types/Commandline.html" title="class in org.apache.tools.ant.types">Commandline</A> toExecute)
691	throws <A HREF="../../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</A></PRE>
692	<DL>
693	<DD>Sets up the environment for toExecute and then runs it.
694	<P>
695	<DD><DL>
696	<DT><B>Parameters:</B><DD><CODE>toExecute</CODE> - the command line to execute
697	<DT><B>Throws:</B>
698	<DD><CODE><A HREF="../../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</A></CODE> - if failonError is set to true and the cvs command fails</DL>
699	</DD>
700	</DL>
701	<HR>
702
703	<A NAME="execute()"><!-- --></A><H3>
704	execute</H3>
705	<PRE>
706	public void <B>execute</B>()
707	throws <A HREF="../../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</A></PRE>
708	<DL>
709	<DD>do the work
710	<P>
711	<DD><DL>
712	<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>
713	</DD>
714	<DD><DL>
715
716	<DT><B>Throws:</B>
717	<DD><CODE><A HREF="../../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</A></CODE> - if failonerror is set to true and the cvs command fails.</DL>
718	</DD>
719	</DL>
720	<HR>
721
722	<A NAME="setCvsRoot(java.lang.String)"><!-- --></A><H3>
723	setCvsRoot</H3>
724	<PRE>
725	public void <B>setCvsRoot</B>(java.lang.String root)</PRE>
726	<DL>
727	<DD>The CVSROOT variable.
728	<P>
729	<DD><DL>
730	<DT><B>Parameters:</B><DD><CODE>root</CODE> - the CVSROOT variable</DL>
731	</DD>
732	</DL>
733	<HR>
734
735	<A NAME="getCvsRoot()"><!-- --></A><H3>
736	getCvsRoot</H3>
737	<PRE>
738	public java.lang.String <B>getCvsRoot</B>()</PRE>
739	<DL>
740	<DD>access the CVSROOT variable
741	<P>
742	<DD><DL>
743
744	<DT><B>Returns:</B><DD>CVSROOT</DL>
745	</DD>
746	</DL>
747	<HR>
748
749	<A NAME="setCvsRsh(java.lang.String)"><!-- --></A><H3>
750	setCvsRsh</H3>
751	<PRE>
752	public void <B>setCvsRsh</B>(java.lang.String rsh)</PRE>
753	<DL>
754	<DD>The CVS_RSH variable.
755	<P>
756	<DD><DL>
757	<DT><B>Parameters:</B><DD><CODE>rsh</CODE> - the CVS_RSH variable</DL>
758	</DD>
759	</DL>
760	<HR>
761
762	<A NAME="getCvsRsh()"><!-- --></A><H3>
763	getCvsRsh</H3>
764	<PRE>
765	public java.lang.String <B>getCvsRsh</B>()</PRE>
766	<DL>
767	<DD>access the CVS_RSH variable
768	<P>
769	<DD><DL>
770
771	<DT><B>Returns:</B><DD>the CVS_RSH variable</DL>
772	</DD>
773	</DL>
774	<HR>
775
776	<A NAME="setPort(int)"><!-- --></A><H3>
777	setPort</H3>
778	<PRE>
779	public void <B>setPort</B>(int port)</PRE>
780	<DL>
781	<DD>Port used by CVS to communicate with the server.
782	<P>
783	<DD><DL>
784	<DT><B>Parameters:</B><DD><CODE>port</CODE> - port of CVS</DL>
785	</DD>
786	</DL>
787	<HR>
788
789	<A NAME="getPort()"><!-- --></A><H3>
790	getPort</H3>
791	<PRE>
792	public int <B>getPort</B>()</PRE>
793	<DL>
794	<DD>access the port of CVS
795	<P>
796	<DD><DL>
797
798	<DT><B>Returns:</B><DD>the port of CVS</DL>
799	</DD>
800	</DL>
801	<HR>
802
803	<A NAME="setPassfile(java.io.File)"><!-- --></A><H3>
804	setPassfile</H3>
805	<PRE>
806	public void <B>setPassfile</B>(java.io.File passFile)</PRE>
807	<DL>
808	<DD>Password file to read passwords from.
809	<P>
810	<DD><DL>
811	<DT><B>Parameters:</B><DD><CODE>passFile</CODE> - password file to read passwords from</DL>
812	</DD>
813	</DL>
814	<HR>
815
816	<A NAME="getPassFile()"><!-- --></A><H3>
817	getPassFile</H3>
818	<PRE>
819	public java.io.File <B>getPassFile</B>()</PRE>
820	<DL>
821	<DD>find the password file
822	<P>
823	<DD><DL>
824
825	<DT><B>Returns:</B><DD>password file</DL>
826	</DD>
827	</DL>
828	<HR>
829
830	<A NAME="setDest(java.io.File)"><!-- --></A><H3>
831	setDest</H3>
832	<PRE>
833	public void <B>setDest</B>(java.io.File dest)</PRE>
834	<DL>
835	<DD>The directory where the checked out files should be placed.
836
837	<p>Note that this is different from CVS's -d command line
838	switch as Ant will never shorten pathnames to avoid empty
839	directories.</p>
840	<P>
841	<DD><DL>
842	<DT><B>Parameters:</B><DD><CODE>dest</CODE> - directory where the checked out files should be placed</DL>
843	</DD>
844	</DL>
845	<HR>
846
847	<A NAME="getDest()"><!-- --></A><H3>
848	getDest</H3>
849	<PRE>
850	public java.io.File <B>getDest</B>()</PRE>
851	<DL>
852	<DD>get the file where the checked out files should be placed
853	<P>
854	<DD><DL>
855
856	<DT><B>Returns:</B><DD>directory where the checked out files should be placed</DL>
857	</DD>
858	</DL>
859	<HR>
860
861	<A NAME="setPackage(java.lang.String)"><!-- --></A><H3>
862	setPackage</H3>
863	<PRE>
864	public void <B>setPackage</B>(java.lang.String p)</PRE>
865	<DL>
866	<DD>The package/module to operate upon.
867	<P>
868	<DD><DL>
869	<DT><B>Parameters:</B><DD><CODE>p</CODE> - package or module to operate upon</DL>
870	</DD>
871	</DL>
872	<HR>
873
874	<A NAME="getPackage()"><!-- --></A><H3>
875	getPackage</H3>
876	<PRE>
877	public java.lang.String <B>getPackage</B>()</PRE>
878	<DL>
879	<DD>access the package or module to operate upon
880	<P>
881	<DD><DL>
882
883	<DT><B>Returns:</B><DD>package/module</DL>
884	</DD>
885	</DL>
886	<HR>
887
888	<A NAME="getTag()"><!-- --></A><H3>
889	getTag</H3>
890	<PRE>
891	public java.lang.String <B>getTag</B>()</PRE>
892	<DL>
893	<DD>tag or branch
894	<P>
895	<DD><DL>
896
897	<DT><B>Returns:</B><DD>tag or branch<DT><B>Since:</B></DT>
898	<DD>ant 1.6.1</DD>
899	</DL>
900	</DD>
901	</DL>
902	<HR>
903
904	<A NAME="setTag(java.lang.String)"><!-- --></A><H3>
905	setTag</H3>
906	<PRE>
907	public void <B>setTag</B>(java.lang.String p)</PRE>
908	<DL>
909	<DD>The tag of the package/module to operate upon.
910	<P>
911	<DD><DL>
912	<DT><B>Parameters:</B><DD><CODE>p</CODE> - tag</DL>
913	</DD>
914	</DL>
915	<HR>
916
917	<A NAME="addCommandArgument(java.lang.String)"><!-- --></A><H3>
918	addCommandArgument</H3>
919	<PRE>
920	public void <B>addCommandArgument</B>(java.lang.String arg)</PRE>
921	<DL>
922	<DD>This needs to be public to allow configuration
923	of commands externally.
924	<P>
925	<DD><DL>
926	<DT><B>Parameters:</B><DD><CODE>arg</CODE> - command argument</DL>
927	</DD>
928	</DL>
929	<HR>
930
931	<A NAME="addCommandArgument(org.apache.tools.ant.types.Commandline, java.lang.String)"><!-- --></A><H3>
932	addCommandArgument</H3>
933	<PRE>
934	public void <B>addCommandArgument</B>(<A HREF="../../../../../org/apache/tools/ant/types/Commandline.html" title="class in org.apache.tools.ant.types">Commandline</A> c,
935	java.lang.String arg)</PRE>
936	<DL>
937	<DD>This method adds a command line argument to an external command.
938
939	I do not understand what this method does in this class ???
940	particularly not why it is public ????
941	AntoineLL July 23d 2003
942	<P>
943	<DD><DL>
944	<DT><B>Parameters:</B><DD><CODE>c</CODE> - command line to which one argument should be added<DD><CODE>arg</CODE> - argument to add</DL>
945	</DD>
946	</DL>
947	<HR>
948
949	<A NAME="setDate(java.lang.String)"><!-- --></A><H3>
950	setDate</H3>
951	<PRE>
952	public void <B>setDate</B>(java.lang.String p)</PRE>
953	<DL>
954	<DD>Use the most recent revision no later than the given date.
955	<P>
956	<DD><DL>
957	<DT><B>Parameters:</B><DD><CODE>p</CODE> - a date as string in a format that the CVS executable can understand
958	see man cvs</DL>
959	</DD>
960	</DL>
961	<HR>
962
963	<A NAME="setCommand(java.lang.String)"><!-- --></A><H3>
964	setCommand</H3>
965	<PRE>
966	public void <B>setCommand</B>(java.lang.String c)</PRE>
967	<DL>
968	<DD>The CVS command to execute.
969
970	This should be deprecated, it is better to use the Commandline class ?
971	AntoineLL July 23d 2003
972	<P>
973	<DD><DL>
974	<DT><B>Parameters:</B><DD><CODE>c</CODE> - a command as string</DL>
975	</DD>
976	</DL>
977	<HR>
978
979	<A NAME="getCommand()"><!-- --></A><H3>
980	getCommand</H3>
981	<PRE>
982	public java.lang.String <B>getCommand</B>()</PRE>
983	<DL>
984	<DD>accessor to a command line as string
985
986	This should be deprecated
987	AntoineLL July 23d 2003
988	<P>
989	<DD><DL>
990
991	<DT><B>Returns:</B><DD>command line as string</DL>
992	</DD>
993	</DL>
994	<HR>
995
996	<A NAME="setQuiet(boolean)"><!-- --></A><H3>
997	setQuiet</H3>
998	<PRE>
999	public void <B>setQuiet</B>(boolean q)</PRE>
1000	<DL>
1001	<DD>If true, suppress informational messages.
1002	<P>
1003	<DD><DL>
1004	<DT><B>Parameters:</B><DD><CODE>q</CODE> - if true, suppress informational messages</DL>
1005	</DD>
1006	</DL>
1007	<HR>
1008
1009	<A NAME="setReallyquiet(boolean)"><!-- --></A><H3>
1010	setReallyquiet</H3>
1011	<PRE>
1012	public void <B>setReallyquiet</B>(boolean q)</PRE>
1013	<DL>
1014	<DD>If true, suppress all messages.
1015	<P>
1016	<DD><DL>
1017	<DT><B>Parameters:</B><DD><CODE>q</CODE> - if true, suppress all messages<DT><B>Since:</B></DT>
1018	<DD>Ant 1.6</DD>
1019	</DL>
1020	</DD>
1021	</DL>
1022	<HR>
1023
1024	<A NAME="setNoexec(boolean)"><!-- --></A><H3>
1025	setNoexec</H3>
1026	<PRE>
1027	public void <B>setNoexec</B>(boolean ne)</PRE>
1028	<DL>
1029	<DD>If true, report only and don't change any files.
1030	<P>
1031	<DD><DL>
1032	<DT><B>Parameters:</B><DD><CODE>ne</CODE> - if true, report only and do not change any files.</DL>
1033	</DD>
1034	</DL>
1035	<HR>
1036
1037	<A NAME="setOutput(java.io.File)"><!-- --></A><H3>
1038	setOutput</H3>
1039	<PRE>
1040	public void <B>setOutput</B>(java.io.File output)</PRE>
1041	<DL>
1042	<DD>The file to direct standard output from the command.
1043	<P>
1044	<DD><DL>
1045	<DT><B>Parameters:</B><DD><CODE>output</CODE> - a file to which stdout should go</DL>
1046	</DD>
1047	</DL>
1048	<HR>
1049
1050	<A NAME="setError(java.io.File)"><!-- --></A><H3>
1051	setError</H3>
1052	<PRE>
1053	public void <B>setError</B>(java.io.File error)</PRE>
1054	<DL>
1055	<DD>The file to direct standard error from the command.
1056	<P>
1057	<DD><DL>
1058	<DT><B>Parameters:</B><DD><CODE>error</CODE> - a file to which stderr should go</DL>
1059	</DD>
1060	</DL>
1061	<HR>
1062
1063	<A NAME="setAppend(boolean)"><!-- --></A><H3>
1064	setAppend</H3>
1065	<PRE>
1066	public void <B>setAppend</B>(boolean value)</PRE>
1067	<DL>
1068	<DD>Whether to append output/error when redirecting to a file.
1069	<P>
1070	<DD><DL>
1071	<DT><B>Parameters:</B><DD><CODE>value</CODE> - true indicated you want to append</DL>
1072	</DD>
1073	</DL>
1074	<HR>
1075
1076	<A NAME="setFailOnError(boolean)"><!-- --></A><H3>
1077	setFailOnError</H3>
1078	<PRE>
1079	public void <B>setFailOnError</B>(boolean failOnError)</PRE>
1080	<DL>
1081	<DD>Stop the build process if the command exits with
1082	a return code other than 0.
1083	Defaults to false.
1084	<P>
1085	<DD><DL>
1086	<DT><B>Parameters:</B><DD><CODE>failOnError</CODE> - stop the build process if the command exits with
1087	a return code other than 0</DL>
1088	</DD>
1089	</DL>
1090	<HR>
1091
1092	<A NAME="configureCommandline(org.apache.tools.ant.types.Commandline)"><!-- --></A><H3>
1093	configureCommandline</H3>
1094	<PRE>
1095	protected void <B>configureCommandline</B>(<A HREF="../../../../../org/apache/tools/ant/types/Commandline.html" title="class in org.apache.tools.ant.types">Commandline</A> c)</PRE>
1096	<DL>
1097	<DD>Configure a commandline element for things like cvsRoot, quiet, etc.
1098	<P>
1099	<DD><DL>
1100	<DT><B>Parameters:</B><DD><CODE>c</CODE> - the command line which will be configured
1101	if the commandline is initially null, the function is a noop
1102	otherwise the function append to the commandline arguments concerning
1103	<ul>
1104	<li>
1105	cvs package
1106	</li>
1107	<li>
1108	compression
1109	</li>
1110	<li>
1111	quiet or reallyquiet
1112	</li>
1113	<li>cvsroot</li>
1114	<li>noexec</li>
1115	</ul></DL>
1116	</DD>
1117	</DL>
1118	<HR>
1119
1120	<A NAME="removeCommandline(org.apache.tools.ant.types.Commandline)"><!-- --></A><H3>
1121	removeCommandline</H3>
1122	<PRE>
1123	protected void <B>removeCommandline</B>(<A HREF="../../../../../org/apache/tools/ant/types/Commandline.html" title="class in org.apache.tools.ant.types">Commandline</A> c)</PRE>
1124	<DL>
1125	<DD>remove a particular command from a vector of command lines
1126	<P>
1127	<DD><DL>
1128	<DT><B>Parameters:</B><DD><CODE>c</CODE> - command line which should be removed</DL>
1129	</DD>
1130	</DL>
1131	<HR>
1132
1133	<A NAME="addConfiguredCommandline(org.apache.tools.ant.types.Commandline)"><!-- --></A><H3>
1134	addConfiguredCommandline</H3>
1135	<PRE>
1136	public void <B>addConfiguredCommandline</B>(<A HREF="../../../../../org/apache/tools/ant/types/Commandline.html" title="class in org.apache.tools.ant.types">Commandline</A> c)</PRE>
1137	<DL>
1138	<DD>Adds direct command-line to execute.
1139	<P>
1140	<DD><DL>
1141	<DT><B>Parameters:</B><DD><CODE>c</CODE> - command line to execute</DL>
1142	</DD>
1143	</DL>
1144	<HR>
1145
1146	<A NAME="addConfiguredCommandline(org.apache.tools.ant.types.Commandline, boolean)"><!-- --></A><H3>
1147	addConfiguredCommandline</H3>
1148	<PRE>
1149	public void <B>addConfiguredCommandline</B>(<A HREF="../../../../../org/apache/tools/ant/types/Commandline.html" title="class in org.apache.tools.ant.types">Commandline</A> c,
1150	boolean insertAtStart)</PRE>
1151	<DL>
1152	<DD>Configures and adds the given Commandline.
1153	<P>
1154	<DD><DL>
1155	<DT><B>Parameters:</B><DD><CODE>c</CODE> - commandline to insert<DD><CODE>insertAtStart</CODE> - If true, c is
1156	inserted at the beginning of the vector of command lines</DL>
1157	</DD>
1158	</DL>
1159	<HR>
1160
1161	<A NAME="setCompressionLevel(int)"><!-- --></A><H3>
1162	setCompressionLevel</H3>
1163	<PRE>
1164	public void <B>setCompressionLevel</B>(int level)</PRE>
1165	<DL>
1166	<DD>If set to a value 1-9 it adds -zN to the cvs command line, else
1167	it disables compression.
1168	<P>
1169	<DD><DL>
1170	<DT><B>Parameters:</B><DD><CODE>level</CODE> - compression level 1 to 9</DL>
1171	</DD>
1172	</DL>
1173	<HR>
1174
1175	<A NAME="setCompression(boolean)"><!-- --></A><H3>
1176	setCompression</H3>
1177	<PRE>
1178	public void <B>setCompression</B>(boolean usecomp)</PRE>
1179	<DL>
1180	<DD>If true, this is the same as compressionlevel="3".
1181	<P>
1182	<DD><DL>
1183	<DT><B>Parameters:</B><DD><CODE>usecomp</CODE> - If true, turns on compression using default
1184	level, AbstractCvsTask.DEFAULT_COMPRESSION_LEVEL.</DL>
1185	</DD>
1186	</DL>
1187	<!-- ========= END OF CLASS DATA ========= -->
1188	<HR>
1189
1190
1191	<!-- ======= START OF BOTTOM NAVBAR ====== -->
1192	<A NAME="navbar_bottom"><!-- --></A>
1193	<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
1194	<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
1195	<TR>
1196	<TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
1197	<A NAME="navbar_bottom_firstrow"><!-- --></A>
1198	<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
1199	<TR ALIGN="center" VALIGN="top">
1200	<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
1201	<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
1202	<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev">  <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
1203	<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
1204	<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
1205	<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
1206	<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
1207	</TR>
1208	</TABLE>
1209	</TD>
1210	<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
1211	</EM>
1212	</TD>
1213	</TR>
1214
1215	<TR>
1216	<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
1217	PREV CLASS
1218	<A HREF="../../../../../org/apache/tools/ant/taskdefs/Ant.html" title="class in org.apache.tools.ant.taskdefs"><B>NEXT CLASS</B></A></FONT></TD>
1219	<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
1220	<A HREF="../../../../../index.html" target="_top"><B>FRAMES</B></A>
1221	<A HREF="AbstractCvsTask.html" target="_top"><B>NO FRAMES</B></A>
1222	<SCRIPT type="text/javascript">
1223	<!--
1224	if(window==top) {
1225	document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
1226	}
1227	//-->
1228	</SCRIPT>
1229	<NOSCRIPT>
1230	<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
1231	</NOSCRIPT>
1232
1233	</FONT></TD>
1234	</TR>
1235	<TR>
1236	<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
1237	SUMMARY: NESTED \| <A HREF="#field_summary">FIELD</A> \| <A HREF="#constructor_summary">CONSTR</A> \| <A HREF="#method_summary">METHOD</A></FONT></TD>
1238	<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
1239	DETAIL: <A HREF="#field_detail">FIELD</A> \| <A HREF="#constructor_detail">CONSTR</A> \| <A HREF="#method_detail">METHOD</A></FONT></TD>
1240	</TR>
1241	</TABLE>
1242	<A NAME="skip-navbar_bottom"></A>
1243	<!-- ======== END OF BOTTOM NAVBAR ======= -->
1244
1245	<HR>
1246	Copyright Â© 2000-2007 Apache Software Foundation. All Rights Reserved.
1247	</BODY>
1248	</HTML>

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

Download in other formats: