Context Navigation

← Previous Revision
Latest Revision
Next Revision →
Blame
Revision Log

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

Last change on this file since 14982 was 14982, checked in by oranfry, 16 years ago
initial import of LiRK3
File size: 41.5 KB

Line
1	<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
2	<!--NewPage-->
3	<HTML>
4	<HEAD>
5	<!-- Generated by javadoc (build 1.4.2_13) on Mon Oct 01 14:33:29 NZST 2007 -->
6	<TITLE>
7	Pvcs (Apache Ant API)
8	</TITLE>
9
10	<META NAME="keywords" CONTENT="org.apache.tools.ant.taskdefs.optional.pvcs.Pvcs 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="Pvcs (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/optional/pvcs/PvcsProject.html" title="class in org.apache.tools.ant.taskdefs.optional.pvcs"><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="Pvcs.html" target="_top"><B>NO FRAMES</B></A>
57	<SCRIPT type="text/javascript">
58	<!--
59	if(window==top) {
60	document.writeln('<A HREF="../../../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
61	}
62	//-->
63	</SCRIPT>
64	<NOSCRIPT>
65	<A HREF="../../../../../../../allclasses-noframe.html"><B>All Classes</B></A>
66	</NOSCRIPT>
67
68	</FONT></TD>
69	</TR>
70	<TR>
71	<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
72	SUMMARY: NESTED \| <A HREF="#fields_inherited_from_class_org.apache.tools.ant.Task">FIELD</A> \| <A HREF="#constructor_summary">CONSTR</A> \| <A HREF="#method_summary">METHOD</A></FONT></TD>
73	<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
74	DETAIL: FIELD \| <A HREF="#constructor_detail">CONSTR</A> \| <A HREF="#method_detail">METHOD</A></FONT></TD>
75	</TR>
76	</TABLE>
77	<A NAME="skip-navbar_top"></A>
78	<!-- ========= END OF TOP NAVBAR ========= -->
79
80	<HR>
81	<!-- ======== START OF CLASS DATA ======== -->
82	<H2>
83	<FONT SIZE="-1">
84	org.apache.tools.ant.taskdefs.optional.pvcs</FONT>
85	<BR>
86	Class Pvcs</H2>
87	<PRE>
88	java.lang.Object
89	<IMG SRC="../../../../../../../resources/inherit.gif" ALT="extended by"><A HREF="../../../../../../../org/apache/tools/ant/ProjectComponent.html" title="class in org.apache.tools.ant">org.apache.tools.ant.ProjectComponent</A>
90	<IMG SRC="../../../../../../../resources/inherit.gif" ALT="extended by"><A HREF="../../../../../../../org/apache/tools/ant/Task.html" title="class in org.apache.tools.ant">org.apache.tools.ant.Task</A>
91	<IMG SRC="../../../../../../../resources/inherit.gif" ALT="extended by"><B>org.apache.tools.ant.taskdefs.optional.pvcs.Pvcs</B>
92	</PRE>
93	<HR>
94	<DL>
95	<DT>public class <B>Pvcs</B><DT>extends <A HREF="../../../../../../../org/apache/tools/ant/Task.html" title="class in org.apache.tools.ant">Task</A></DL>
96
97	<P>
98	Extracts the latest edition of the source code from a PVCS repository.
99	PVCS is a version control system
100	developed by <a href="http://www.merant.com/products/pvcs">Merant</a>.
101	<br>
102	Before using this tag, the user running ant must have access to the commands
103	of PVCS (get and pcli) and must have access to the repository. Note that the way to specify
104	the repository is platform dependent so use property to specify location of repository.
105	<br>
106	This version has been tested agains PVCS version 6.5 and 6.6 under Windows and Solaris.
107
108
109	<b>19-04-2001</b> <p>The task now has a more robust
110	parser. It allows for platform independant file paths
111	and supports file names with <i>()</i>. Thanks to Erik Husby for
112	bringing the bug to my attention.
113
114	<b>27-04-2001</b> <p>UNC paths are now handled properly.
115	Fix provided by Don Jeffery. He also added an <i>UpdateOnly</i> flag
116	that, when true, conditions the PVCS get using the -U option to only
117	update those files that have a modification time (in PVCS) that is newer
118	than the existing workfile.
119
120	<b>25-10-2002</b> <p>Added a revision attribute that currently is a
121	synonym for label, but in a future release the behavior of the label
122	attribute will change to use the -v option of GET. See bug #13847 for
123	discussion.
124	<P>
125
126	<P>
127	<HR>
128
129	<P>
130	<!-- ======== NESTED CLASS SUMMARY ======== -->
131
132
133	<!-- =========== FIELD SUMMARY =========== -->
134
135	<A NAME="field_summary"><!-- --></A>
136	<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
137	<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
138	<TD COLSPAN=2><FONT SIZE="+2">
139	<B>Field Summary</B></FONT></TD>
140	</TR>
141	</TABLE>
142	<A NAME="fields_inherited_from_class_org.apache.tools.ant.Task"><!-- --></A>
143	<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
144	<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
145	<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>
146	</TR>
147	<TR BGCOLOR="white" CLASS="TableRowColor">
148	<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>
149	</TR>
150	</TABLE>
151	<A NAME="fields_inherited_from_class_org.apache.tools.ant.ProjectComponent"><!-- --></A>
152	<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
153	<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
154	<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>
155	</TR>
156	<TR BGCOLOR="white" CLASS="TableRowColor">
157	<TD><CODE><A HREF="../../../../../../../org/apache/tools/ant/ProjectComponent.html#project">project</A></CODE></TD>
158	</TR>
159	</TABLE>
160
161	<!-- ======== CONSTRUCTOR SUMMARY ======== -->
162
163	<A NAME="constructor_summary"><!-- --></A>
164	<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
165	<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
166	<TD COLSPAN=2><FONT SIZE="+2">
167	<B>Constructor Summary</B></FONT></TD>
168	</TR>
169	<TR BGCOLOR="white" CLASS="TableRowColor">
170	<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/pvcs/Pvcs.html#Pvcs()">Pvcs</A></B>()</CODE>
171
172	<BR>
173	Creates a Pvcs object</TD>
174	</TR>
175	</TABLE>
176
177	<!-- ========== METHOD SUMMARY =========== -->
178
179	<A NAME="method_summary"><!-- --></A>
180	<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
181	<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
182	<TD COLSPAN=2><FONT SIZE="+2">
183	<B>Method Summary</B></FONT></TD>
184	</TR>
185	<TR BGCOLOR="white" CLASS="TableRowColor">
186	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
187	<CODE> void</CODE></FONT></TD>
188	<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/pvcs/Pvcs.html#addPvcsproject(org.apache.tools.ant.taskdefs.optional.pvcs.PvcsProject)">addPvcsproject</A></B>(<A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/pvcs/PvcsProject.html" title="class in org.apache.tools.ant.taskdefs.optional.pvcs">PvcsProject</A> p)</CODE>
189
190	<BR>
191	Specify a project within the PVCS repository to extract files from.</TD>
192	</TR>
193	<TR BGCOLOR="white" CLASS="TableRowColor">
194	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
195	<CODE> void</CODE></FONT></TD>
196	<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/pvcs/Pvcs.html#execute()">execute</A></B>()</CODE>
197
198	<BR>
199	Called by the project to let the task do its work.</TD>
200	</TR>
201	<TR BGCOLOR="white" CLASS="TableRowColor">
202	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
203	<CODE> java.lang.String</CODE></FONT></TD>
204	<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/pvcs/Pvcs.html#getConfig()">getConfig</A></B>()</CODE>
205
206	<BR>
207	returns the path of the configuration file to be used</TD>
208	</TR>
209	<TR BGCOLOR="white" CLASS="TableRowColor">
210	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
211	<CODE> java.lang.String</CODE></FONT></TD>
212	<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/pvcs/Pvcs.html#getFilenameFormat()">getFilenameFormat</A></B>()</CODE>
213
214	<BR>
215	The filenameFormat attribute defines a MessageFormat string used
216	to parse the output of the pcli command.</TD>
217	</TR>
218	<TR BGCOLOR="white" CLASS="TableRowColor">
219	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
220	<CODE> java.lang.String</CODE></FONT></TD>
221	<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/pvcs/Pvcs.html#getForce()">getForce</A></B>()</CODE>
222
223	<BR>
224	Get value of force</TD>
225	</TR>
226	<TR BGCOLOR="white" CLASS="TableRowColor">
227	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
228	<CODE> boolean</CODE></FONT></TD>
229	<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/pvcs/Pvcs.html#getIgnoreReturnCode()">getIgnoreReturnCode</A></B>()</CODE>
230
231	<BR>
232	Get value of ignorereturncode</TD>
233	</TR>
234	<TR BGCOLOR="white" CLASS="TableRowColor">
235	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
236	<CODE> java.lang.String</CODE></FONT></TD>
237	<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/pvcs/Pvcs.html#getLabel()">getLabel</A></B>()</CODE>
238
239	<BR>
240	Get value of label</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/optional/pvcs/Pvcs.html#getLineStart()">getLineStart</A></B>()</CODE>
246
247	<BR>
248	The lineStart attribute is used to parse the output of the pcli
249	command.</TD>
250	</TR>
251	<TR BGCOLOR="white" CLASS="TableRowColor">
252	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
253	<CODE> java.lang.String</CODE></FONT></TD>
254	<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/pvcs/Pvcs.html#getPromotiongroup()">getPromotiongroup</A></B>()</CODE>
255
256	<BR>
257	Get value of promotiongroup</TD>
258	</TR>
259	<TR BGCOLOR="white" CLASS="TableRowColor">
260	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
261	<CODE> java.lang.String</CODE></FONT></TD>
262	<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/pvcs/Pvcs.html#getPvcsbin()">getPvcsbin</A></B>()</CODE>
263
264	<BR>
265	Get name of the PVCS bin directory</TD>
266	</TR>
267	<TR BGCOLOR="white" CLASS="TableRowColor">
268	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
269	<CODE> java.lang.String</CODE></FONT></TD>
270	<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/pvcs/Pvcs.html#getPvcsproject()">getPvcsproject</A></B>()</CODE>
271
272	<BR>
273	Get name of the project in the PVCS repository</TD>
274	</TR>
275	<TR BGCOLOR="white" CLASS="TableRowColor">
276	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
277	<CODE> java.util.Vector</CODE></FONT></TD>
278	<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/pvcs/Pvcs.html#getPvcsprojects()">getPvcsprojects</A></B>()</CODE>
279
280	<BR>
281	Get name of the project in the PVCS repository</TD>
282	</TR>
283	<TR BGCOLOR="white" CLASS="TableRowColor">
284	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
285	<CODE> java.lang.String</CODE></FONT></TD>
286	<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/pvcs/Pvcs.html#getRepository()">getRepository</A></B>()</CODE>
287
288	<BR>
289	Get network name of the PVCS repository</TD>
290	</TR>
291	<TR BGCOLOR="white" CLASS="TableRowColor">
292	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
293	<CODE> java.lang.String</CODE></FONT></TD>
294	<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/pvcs/Pvcs.html#getRevision()">getRevision</A></B>()</CODE>
295
296	<BR>
297	Get value of revision</TD>
298	</TR>
299	<TR BGCOLOR="white" CLASS="TableRowColor">
300	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
301	<CODE> boolean</CODE></FONT></TD>
302	<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/pvcs/Pvcs.html#getUpdateOnly()">getUpdateOnly</A></B>()</CODE>
303
304	<BR>
305	</TD>
306	</TR>
307	<TR BGCOLOR="white" CLASS="TableRowColor">
308	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
309	<CODE> java.lang.String</CODE></FONT></TD>
310	<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/pvcs/Pvcs.html#getUserId()">getUserId</A></B>()</CODE>
311
312	<BR>
313	</TD>
314	</TR>
315	<TR BGCOLOR="white" CLASS="TableRowColor">
316	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
317	<CODE> java.lang.String</CODE></FONT></TD>
318	<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/pvcs/Pvcs.html#getWorkspace()">getWorkspace</A></B>()</CODE>
319
320	<BR>
321	Get name of the workspace to store the retrieved files</TD>
322	</TR>
323	<TR BGCOLOR="white" CLASS="TableRowColor">
324	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
325	<CODE>protected  int</CODE></FONT></TD>
326	<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/pvcs/Pvcs.html#runCmd(org.apache.tools.ant.types.Commandline, org.apache.tools.ant.taskdefs.ExecuteStreamHandler)">runCmd</A></B>(<A HREF="../../../../../../../org/apache/tools/ant/types/Commandline.html" title="class in org.apache.tools.ant.types">Commandline</A> cmd,
327	<A HREF="../../../../../../../org/apache/tools/ant/taskdefs/ExecuteStreamHandler.html" title="interface in org.apache.tools.ant.taskdefs">ExecuteStreamHandler</A> out)</CODE>
328
329	<BR>
330	</TD>
331	</TR>
332	<TR BGCOLOR="white" CLASS="TableRowColor">
333	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
334	<CODE> void</CODE></FONT></TD>
335	<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/pvcs/Pvcs.html#setConfig(java.io.File)">setConfig</A></B>(java.io.File f)</CODE>
336
337	<BR>
338	Sets a configuration file other than the default to be used.</TD>
339	</TR>
340	<TR BGCOLOR="white" CLASS="TableRowColor">
341	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
342	<CODE> void</CODE></FONT></TD>
343	<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/pvcs/Pvcs.html#setFilenameFormat(java.lang.String)">setFilenameFormat</A></B>(java.lang.String f)</CODE>
344
345	<BR>
346	The format of the folder names; optional.</TD>
347	</TR>
348	<TR BGCOLOR="white" CLASS="TableRowColor">
349	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
350	<CODE> void</CODE></FONT></TD>
351	<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/pvcs/Pvcs.html#setForce(java.lang.String)">setForce</A></B>(java.lang.String f)</CODE>
352
353	<BR>
354	Specifies the value of the force argument; optional.</TD>
355	</TR>
356	<TR BGCOLOR="white" CLASS="TableRowColor">
357	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
358	<CODE> void</CODE></FONT></TD>
359	<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/pvcs/Pvcs.html#setIgnoreReturnCode(boolean)">setIgnoreReturnCode</A></B>(boolean b)</CODE>
360
361	<BR>
362	If set to true the return value from executing the pvcs
363	commands are ignored; optional, default false.</TD>
364	</TR>
365	<TR BGCOLOR="white" CLASS="TableRowColor">
366	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
367	<CODE> void</CODE></FONT></TD>
368	<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/pvcs/Pvcs.html#setLabel(java.lang.String)">setLabel</A></B>(java.lang.String l)</CODE>
369
370	<BR>
371	Only files marked with this label are extracted; optional.</TD>
372	</TR>
373	<TR BGCOLOR="white" CLASS="TableRowColor">
374	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
375	<CODE> void</CODE></FONT></TD>
376	<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/pvcs/Pvcs.html#setLineStart(java.lang.String)">setLineStart</A></B>(java.lang.String l)</CODE>
377
378	<BR>
379	What a valid return value from PVCS looks like
380	when it describes a file.</TD>
381	</TR>
382	<TR BGCOLOR="white" CLASS="TableRowColor">
383	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
384	<CODE> void</CODE></FONT></TD>
385	<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/pvcs/Pvcs.html#setPromotiongroup(java.lang.String)">setPromotiongroup</A></B>(java.lang.String w)</CODE>
386
387	<BR>
388	Specifies the name of the promotiongroup argument</TD>
389	</TR>
390	<TR BGCOLOR="white" CLASS="TableRowColor">
391	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
392	<CODE> void</CODE></FONT></TD>
393	<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/pvcs/Pvcs.html#setPvcsbin(java.lang.String)">setPvcsbin</A></B>(java.lang.String bin)</CODE>
394
395	<BR>
396	Specifies the location of the PVCS bin directory; optional if on the PATH.</TD>
397	</TR>
398	<TR BGCOLOR="white" CLASS="TableRowColor">
399	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
400	<CODE> void</CODE></FONT></TD>
401	<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/pvcs/Pvcs.html#setPvcsproject(java.lang.String)">setPvcsproject</A></B>(java.lang.String prj)</CODE>
402
403	<BR>
404	The project within the PVCS repository to extract files from;
405	optional, default "/"</TD>
406	</TR>
407	<TR BGCOLOR="white" CLASS="TableRowColor">
408	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
409	<CODE> void</CODE></FONT></TD>
410	<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/pvcs/Pvcs.html#setRepository(java.lang.String)">setRepository</A></B>(java.lang.String repo)</CODE>
411
412	<BR>
413	The network name of the PVCS repository; required.</TD>
414	</TR>
415	<TR BGCOLOR="white" CLASS="TableRowColor">
416	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
417	<CODE> void</CODE></FONT></TD>
418	<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/pvcs/Pvcs.html#setRevision(java.lang.String)">setRevision</A></B>(java.lang.String r)</CODE>
419
420	<BR>
421	Only files with this revision are extract; optional.</TD>
422	</TR>
423	<TR BGCOLOR="white" CLASS="TableRowColor">
424	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
425	<CODE> void</CODE></FONT></TD>
426	<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/pvcs/Pvcs.html#setUpdateOnly(boolean)">setUpdateOnly</A></B>(boolean l)</CODE>
427
428	<BR>
429	If set to <i>true</i> files are fetched only if
430	newer than existing local files; optional, default false.</TD>
431	</TR>
432	<TR BGCOLOR="white" CLASS="TableRowColor">
433	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
434	<CODE> void</CODE></FONT></TD>
435	<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/pvcs/Pvcs.html#setUserId(java.lang.String)">setUserId</A></B>(java.lang.String u)</CODE>
436
437	<BR>
438	User ID; unused.</TD>
439	</TR>
440	<TR BGCOLOR="white" CLASS="TableRowColor">
441	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
442	<CODE> void</CODE></FONT></TD>
443	<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/pvcs/Pvcs.html#setWorkspace(java.lang.String)">setWorkspace</A></B>(java.lang.String ws)</CODE>
444
445	<BR>
446	Workspace to use; optional.</TD>
447	</TR>
448	</TABLE>
449	<A NAME="methods_inherited_from_class_org.apache.tools.ant.Task"><!-- --></A>
450	<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
451	<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
452	<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>
453	</TR>
454	<TR BGCOLOR="white" CLASS="TableRowColor">
455	<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>
456	</TR>
457	</TABLE>
458	<A NAME="methods_inherited_from_class_org.apache.tools.ant.ProjectComponent"><!-- --></A>
459	<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
460	<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
461	<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>
462	</TR>
463	<TR BGCOLOR="white" CLASS="TableRowColor">
464	<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>
465	</TR>
466	</TABLE>
467	<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
468	<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
469	<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
470	<TD><B>Methods inherited from class java.lang.Object</B></TD>
471	</TR>
472	<TR BGCOLOR="white" CLASS="TableRowColor">
473	<TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
474	</TR>
475	</TABLE>
476
477	<P>
478
479	<!-- ============ FIELD DETAIL =========== -->
480
481
482	<!-- ========= CONSTRUCTOR DETAIL ======== -->
483
484	<A NAME="constructor_detail"><!-- --></A>
485	<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
486	<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
487	<TD COLSPAN=1><FONT SIZE="+2">
488	<B>Constructor Detail</B></FONT></TD>
489	</TR>
490	</TABLE>
491
492	<A NAME="Pvcs()"><!-- --></A><H3>
493	Pvcs</H3>
494	<PRE>
495	public <B>Pvcs</B>()</PRE>
496	<DL>
497	<DD>Creates a Pvcs object
498	<P>
499	</DL>
500
501	<!-- ============ METHOD DETAIL ========== -->
502
503	<A NAME="method_detail"><!-- --></A>
504	<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
505	<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
506	<TD COLSPAN=1><FONT SIZE="+2">
507	<B>Method Detail</B></FONT></TD>
508	</TR>
509	</TABLE>
510
511	<A NAME="runCmd(org.apache.tools.ant.types.Commandline, org.apache.tools.ant.taskdefs.ExecuteStreamHandler)"><!-- --></A><H3>
512	runCmd</H3>
513	<PRE>
514	protected int <B>runCmd</B>(<A HREF="../../../../../../../org/apache/tools/ant/types/Commandline.html" title="class in org.apache.tools.ant.types">Commandline</A> cmd,
515	<A HREF="../../../../../../../org/apache/tools/ant/taskdefs/ExecuteStreamHandler.html" title="interface in org.apache.tools.ant.taskdefs">ExecuteStreamHandler</A> out)</PRE>
516	<DL>
517	<DD><DL>
518	</DL>
519	</DD>
520	</DL>
521	<HR>
522
523	<A NAME="execute()"><!-- --></A><H3>
524	execute</H3>
525	<PRE>
526	public void <B>execute</B>()
527	throws <A HREF="../../../../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</A></PRE>
528	<DL>
529	<DD><B>Description copied from class: <CODE><A HREF="../../../../../../../org/apache/tools/ant/Task.html" title="class in org.apache.tools.ant">Task</A></CODE></B></DD>
530	<DD>Called by the project to let the task do its work. This method may be
531	called more than once, if the task is invoked more than once.
532	For example,
533	if target1 and target2 both depend on target3, then running
534	"ant target1 target2" will run all tasks in target3 twice.
535	<P>
536	<DD><DL>
537	<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>
538	</DD>
539	<DD><DL>
540
541	<DT><B>Throws:</B>
542	<DD><CODE><A HREF="../../../../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</A></CODE> - Something is stopping the build...</DL>
543	</DD>
544	</DL>
545	<HR>
546
547	<A NAME="getRepository()"><!-- --></A><H3>
548	getRepository</H3>
549	<PRE>
550	public java.lang.String <B>getRepository</B>()</PRE>
551	<DL>
552	<DD>Get network name of the PVCS repository
553	<P>
554	<DD><DL>
555
556	<DT><B>Returns:</B><DD>String</DL>
557	</DD>
558	</DL>
559	<HR>
560
561	<A NAME="getFilenameFormat()"><!-- --></A><H3>
562	getFilenameFormat</H3>
563	<PRE>
564	public java.lang.String <B>getFilenameFormat</B>()</PRE>
565	<DL>
566	<DD>The filenameFormat attribute defines a MessageFormat string used
567	to parse the output of the pcli command. It defaults to
568	<code>{0}-arc({1})</code>. Repositories where the archive
569	extension is not -arc should set this.
570	<P>
571	<DD><DL>
572	</DL>
573	</DD>
574	</DL>
575	<HR>
576
577	<A NAME="setFilenameFormat(java.lang.String)"><!-- --></A><H3>
578	setFilenameFormat</H3>
579	<PRE>
580	public void <B>setFilenameFormat</B>(java.lang.String f)</PRE>
581	<DL>
582	<DD>The format of the folder names; optional.
583	This must be in a format suitable for
584	<code>java.text.MessageFormat</code>.
585	Index 1 of the format will be used as the file name.
586	Defaults to <code>{0}-arc({1})</code>
587	<P>
588	<DD><DL>
589	</DL>
590	</DD>
591	</DL>
592	<HR>
593
594	<A NAME="getLineStart()"><!-- --></A><H3>
595	getLineStart</H3>
596	<PRE>
597	public java.lang.String <B>getLineStart</B>()</PRE>
598	<DL>
599	<DD>The lineStart attribute is used to parse the output of the pcli
600	command. It defaults to <code>"P:</code>. The parser already
601	knows about / and \\, this property is useful in cases where the
602	repository is accessed on a Windows platform via a drive letter
603	mapping.
604	<P>
605	<DD><DL>
606	</DL>
607	</DD>
608	</DL>
609	<HR>
610
611	<A NAME="setLineStart(java.lang.String)"><!-- --></A><H3>
612	setLineStart</H3>
613	<PRE>
614	public void <B>setLineStart</B>(java.lang.String l)</PRE>
615	<DL>
616	<DD>What a valid return value from PVCS looks like
617	when it describes a file. Defaults to <code>"P:</code>.
618	If you are not using an UNC name for your repository and the
619	drive letter <code>P</code> is incorrect for your setup, you may
620	need to change this value, UNC names will always be
621	accepted.
622	<P>
623	<DD><DL>
624	</DL>
625	</DD>
626	</DL>
627	<HR>
628
629	<A NAME="setRepository(java.lang.String)"><!-- --></A><H3>
630	setRepository</H3>
631	<PRE>
632	public void <B>setRepository</B>(java.lang.String repo)</PRE>
633	<DL>
634	<DD>The network name of the PVCS repository; required.
635	<P>
636	<DD><DL>
637	<DT><B>Parameters:</B><DD><CODE>repo</CODE> - String</DL>
638	</DD>
639	</DL>
640	<HR>
641
642	<A NAME="getPvcsproject()"><!-- --></A><H3>
643	getPvcsproject</H3>
644	<PRE>
645	public java.lang.String <B>getPvcsproject</B>()</PRE>
646	<DL>
647	<DD>Get name of the project in the PVCS repository
648	<P>
649	<DD><DL>
650
651	<DT><B>Returns:</B><DD>String</DL>
652	</DD>
653	</DL>
654	<HR>
655
656	<A NAME="setPvcsproject(java.lang.String)"><!-- --></A><H3>
657	setPvcsproject</H3>
658	<PRE>
659	public void <B>setPvcsproject</B>(java.lang.String prj)</PRE>
660	<DL>
661	<DD>The project within the PVCS repository to extract files from;
662	optional, default "/"
663	<P>
664	<DD><DL>
665	<DT><B>Parameters:</B><DD><CODE>prj</CODE> - String</DL>
666	</DD>
667	</DL>
668	<HR>
669
670	<A NAME="getPvcsprojects()"><!-- --></A><H3>
671	getPvcsprojects</H3>
672	<PRE>
673	public java.util.Vector <B>getPvcsprojects</B>()</PRE>
674	<DL>
675	<DD>Get name of the project in the PVCS repository
676	<P>
677	<DD><DL>
678
679	<DT><B>Returns:</B><DD>Vector</DL>
680	</DD>
681	</DL>
682	<HR>
683
684	<A NAME="getWorkspace()"><!-- --></A><H3>
685	getWorkspace</H3>
686	<PRE>
687	public java.lang.String <B>getWorkspace</B>()</PRE>
688	<DL>
689	<DD>Get name of the workspace to store the retrieved files
690	<P>
691	<DD><DL>
692
693	<DT><B>Returns:</B><DD>String</DL>
694	</DD>
695	</DL>
696	<HR>
697
698	<A NAME="setWorkspace(java.lang.String)"><!-- --></A><H3>
699	setWorkspace</H3>
700	<PRE>
701	public void <B>setWorkspace</B>(java.lang.String ws)</PRE>
702	<DL>
703	<DD>Workspace to use; optional.
704	By specifying a workspace, the files are extracted to that location.
705	A PVCS workspace is a name for a location of the workfiles and
706	isn't as such the location itself.
707	You define the location for a workspace using the PVCS GUI clients.
708	If this isn't specified the default workspace for the current user is used.
709	<P>
710	<DD><DL>
711	<DT><B>Parameters:</B><DD><CODE>ws</CODE> - String</DL>
712	</DD>
713	</DL>
714	<HR>
715
716	<A NAME="getPvcsbin()"><!-- --></A><H3>
717	getPvcsbin</H3>
718	<PRE>
719	public java.lang.String <B>getPvcsbin</B>()</PRE>
720	<DL>
721	<DD>Get name of the PVCS bin directory
722	<P>
723	<DD><DL>
724
725	<DT><B>Returns:</B><DD>String</DL>
726	</DD>
727	</DL>
728	<HR>
729
730	<A NAME="setPvcsbin(java.lang.String)"><!-- --></A><H3>
731	setPvcsbin</H3>
732	<PRE>
733	public void <B>setPvcsbin</B>(java.lang.String bin)</PRE>
734	<DL>
735	<DD>Specifies the location of the PVCS bin directory; optional if on the PATH.
736	On some systems the PVCS executables <i>pcli</i>
737	and <i>get</i> are not found in the PATH. In such cases this attribute
738	should be set to the bin directory of the PVCS installation containing
739	the executables mentioned before. If this attribute isn't specified the
740	tag expects the executables to be found using the PATH environment variable.
741	<P>
742	<DD><DL>
743	<DT><B>Parameters:</B><DD><CODE>bin</CODE> - PVCS bin directory<DT><B>To do:</B></DT>
744	<DD>use a File setter and resolve paths.</DD>
745	</DL>
746	</DD>
747	</DL>
748	<HR>
749
750	<A NAME="getForce()"><!-- --></A><H3>
751	getForce</H3>
752	<PRE>
753	public java.lang.String <B>getForce</B>()</PRE>
754	<DL>
755	<DD>Get value of force
756	<P>
757	<DD><DL>
758
759	<DT><B>Returns:</B><DD>String</DL>
760	</DD>
761	</DL>
762	<HR>
763
764	<A NAME="setForce(java.lang.String)"><!-- --></A><H3>
765	setForce</H3>
766	<PRE>
767	public void <B>setForce</B>(java.lang.String f)</PRE>
768	<DL>
769	<DD>Specifies the value of the force argument; optional.
770	If set to <i>yes</i> all files that exists and are
771	writable are overwritten. Default <i>no</i> causes the files
772	that are writable to be ignored. This stops the PVCS command
773	<i>get</i> to stop asking questions!
774	<P>
775	<DD><DL>
776	<DT><B>Parameters:</B><DD><CODE>f</CODE> - String (yes/no)<DT><B>To do:</B></DT>
777	<DD>make a boolean setter</DD>
778	</DL>
779	</DD>
780	</DL>
781	<HR>
782
783	<A NAME="getPromotiongroup()"><!-- --></A><H3>
784	getPromotiongroup</H3>
785	<PRE>
786	public java.lang.String <B>getPromotiongroup</B>()</PRE>
787	<DL>
788	<DD>Get value of promotiongroup
789	<P>
790	<DD><DL>
791
792	<DT><B>Returns:</B><DD>String</DL>
793	</DD>
794	</DL>
795	<HR>
796
797	<A NAME="setPromotiongroup(java.lang.String)"><!-- --></A><H3>
798	setPromotiongroup</H3>
799	<PRE>
800	public void <B>setPromotiongroup</B>(java.lang.String w)</PRE>
801	<DL>
802	<DD>Specifies the name of the promotiongroup argument
803	<P>
804	<DD><DL>
805	<DT><B>Parameters:</B><DD><CODE>w</CODE> - String</DL>
806	</DD>
807	</DL>
808	<HR>
809
810	<A NAME="getLabel()"><!-- --></A><H3>
811	getLabel</H3>
812	<PRE>
813	public java.lang.String <B>getLabel</B>()</PRE>
814	<DL>
815	<DD>Get value of label
816	<P>
817	<DD><DL>
818
819	<DT><B>Returns:</B><DD>String</DL>
820	</DD>
821	</DL>
822	<HR>
823
824	<A NAME="setLabel(java.lang.String)"><!-- --></A><H3>
825	setLabel</H3>
826	<PRE>
827	public void <B>setLabel</B>(java.lang.String l)</PRE>
828	<DL>
829	<DD>Only files marked with this label are extracted; optional.
830	<P>
831	<DD><DL>
832	<DT><B>Parameters:</B><DD><CODE>l</CODE> - String</DL>
833	</DD>
834	</DL>
835	<HR>
836
837	<A NAME="getRevision()"><!-- --></A><H3>
838	getRevision</H3>
839	<PRE>
840	public java.lang.String <B>getRevision</B>()</PRE>
841	<DL>
842	<DD>Get value of revision
843	<P>
844	<DD><DL>
845
846	<DT><B>Returns:</B><DD>String</DL>
847	</DD>
848	</DL>
849	<HR>
850
851	<A NAME="setRevision(java.lang.String)"><!-- --></A><H3>
852	setRevision</H3>
853	<PRE>
854	public void <B>setRevision</B>(java.lang.String r)</PRE>
855	<DL>
856	<DD>Only files with this revision are extract; optional.
857	<P>
858	<DD><DL>
859	<DT><B>Parameters:</B><DD><CODE>r</CODE> - String</DL>
860	</DD>
861	</DL>
862	<HR>
863
864	<A NAME="getIgnoreReturnCode()"><!-- --></A><H3>
865	getIgnoreReturnCode</H3>
866	<PRE>
867	public boolean <B>getIgnoreReturnCode</B>()</PRE>
868	<DL>
869	<DD>Get value of ignorereturncode
870	<P>
871	<DD><DL>
872
873	<DT><B>Returns:</B><DD>String</DL>
874	</DD>
875	</DL>
876	<HR>
877
878	<A NAME="setIgnoreReturnCode(boolean)"><!-- --></A><H3>
879	setIgnoreReturnCode</H3>
880	<PRE>
881	public void <B>setIgnoreReturnCode</B>(boolean b)</PRE>
882	<DL>
883	<DD>If set to true the return value from executing the pvcs
884	commands are ignored; optional, default false.
885	<P>
886	<DD><DL>
887	</DL>
888	</DD>
889	</DL>
890	<HR>
891
892	<A NAME="addPvcsproject(org.apache.tools.ant.taskdefs.optional.pvcs.PvcsProject)"><!-- --></A><H3>
893	addPvcsproject</H3>
894	<PRE>
895	public void <B>addPvcsproject</B>(<A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/pvcs/PvcsProject.html" title="class in org.apache.tools.ant.taskdefs.optional.pvcs">PvcsProject</A> p)</PRE>
896	<DL>
897	<DD>Specify a project within the PVCS repository to extract files from.
898	<P>
899	<DD><DL>
900	<DT><B>Parameters:</B><DD><CODE>p</CODE> - </DL>
901	</DD>
902	</DL>
903	<HR>
904
905	<A NAME="getUpdateOnly()"><!-- --></A><H3>
906	getUpdateOnly</H3>
907	<PRE>
908	public boolean <B>getUpdateOnly</B>()</PRE>
909	<DL>
910	<DD><DL>
911	</DL>
912	</DD>
913	</DL>
914	<HR>
915
916	<A NAME="setUpdateOnly(boolean)"><!-- --></A><H3>
917	setUpdateOnly</H3>
918	<PRE>
919	public void <B>setUpdateOnly</B>(boolean l)</PRE>
920	<DL>
921	<DD>If set to <i>true</i> files are fetched only if
922	newer than existing local files; optional, default false.
923	<P>
924	<DD><DL>
925	</DL>
926	</DD>
927	</DL>
928	<HR>
929
930	<A NAME="getConfig()"><!-- --></A><H3>
931	getConfig</H3>
932	<PRE>
933	public java.lang.String <B>getConfig</B>()</PRE>
934	<DL>
935	<DD>returns the path of the configuration file to be used
936	<P>
937	<DD><DL>
938
939	<DT><B>Returns:</B><DD>the path of the config file</DL>
940	</DD>
941	</DL>
942	<HR>
943
944	<A NAME="setConfig(java.io.File)"><!-- --></A><H3>
945	setConfig</H3>
946	<PRE>
947	public void <B>setConfig</B>(java.io.File f)</PRE>
948	<DL>
949	<DD>Sets a configuration file other than the default to be used.
950	These files have a .cfg extension and are often found in archive or pvcsprop folders.
951	<P>
952	<DD><DL>
953	<DT><B>Parameters:</B><DD><CODE>f</CODE> - config file - can be given absolute or relative to ant basedir</DL>
954	</DD>
955	</DL>
956	<HR>
957
958	<A NAME="getUserId()"><!-- --></A><H3>
959	getUserId</H3>
960	<PRE>
961	public java.lang.String <B>getUserId</B>()</PRE>
962	<DL>
963	<DD><DL>
964	</DL>
965	</DD>
966	</DL>
967	<HR>
968
969	<A NAME="setUserId(java.lang.String)"><!-- --></A><H3>
970	setUserId</H3>
971	<PRE>
972	public void <B>setUserId</B>(java.lang.String u)</PRE>
973	<DL>
974	<DD>User ID; unused.
975	<P>
976	<DD><DL>
977	</DL>
978	</DD>
979	</DL>
980	<!-- ========= END OF CLASS DATA ========= -->
981	<HR>
982
983
984	<!-- ======= START OF BOTTOM NAVBAR ====== -->
985	<A NAME="navbar_bottom"><!-- --></A>
986	<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
987	<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
988	<TR>
989	<TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
990	<A NAME="navbar_bottom_firstrow"><!-- --></A>
991	<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
992	<TR ALIGN="center" VALIGN="top">
993	<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
994	<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
995	<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev">  <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
996	<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
997	<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
998	<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
999	<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
1000	</TR>
1001	</TABLE>
1002	</TD>
1003	<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
1004	</EM>
1005	</TD>
1006	</TR>
1007
1008	<TR>
1009	<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
1010	PREV CLASS
1011	<A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/pvcs/PvcsProject.html" title="class in org.apache.tools.ant.taskdefs.optional.pvcs"><B>NEXT CLASS</B></A></FONT></TD>
1012	<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
1013	<A HREF="../../../../../../../index.html" target="_top"><B>FRAMES</B></A>
1014	<A HREF="Pvcs.html" target="_top"><B>NO FRAMES</B></A>
1015	<SCRIPT type="text/javascript">
1016	<!--
1017	if(window==top) {
1018	document.writeln('<A HREF="../../../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
1019	}
1020	//-->
1021	</SCRIPT>
1022	<NOSCRIPT>
1023	<A HREF="../../../../../../../allclasses-noframe.html"><B>All Classes</B></A>
1024	</NOSCRIPT>
1025
1026	</FONT></TD>
1027	</TR>
1028	<TR>
1029	<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
1030	SUMMARY: NESTED \| <A HREF="#fields_inherited_from_class_org.apache.tools.ant.Task">FIELD</A> \| <A HREF="#constructor_summary">CONSTR</A> \| <A HREF="#method_summary">METHOD</A></FONT></TD>
1031	<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
1032	DETAIL: FIELD \| <A HREF="#constructor_detail">CONSTR</A> \| <A HREF="#method_detail">METHOD</A></FONT></TD>
1033	</TR>
1034	</TABLE>
1035	<A NAME="skip-navbar_bottom"></A>
1036	<!-- ======== END OF BOTTOM NAVBAR ======= -->
1037
1038	<HR>
1039	Copyright Â© 2000-2007 Apache Software Foundation. All Rights Reserved.
1040	</BODY>
1041	</HTML>

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

Download in other formats: