????
Your IP : 216.73.216.152
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (version 1.7.0_03) on Tue May 22 06:24:54 CEST 2012 -->
<title>Pvcs (Apache Ant API)</title>
<meta name="date" content="2012-05-22">
<link rel="stylesheet" type="text/css" href="../../../../../../../stylesheet.css" title="Style">
</head>
<body>
<script type="text/javascript"><!--
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="Pvcs (Apache Ant API)";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar_top">
<!-- -->
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li>Prev Class</li>
<li><a href="../../../../../../../org/apache/tools/ant/taskdefs/optional/pvcs/PvcsProject.html" title="class in org.apache.tools.ant.taskdefs.optional.pvcs"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../../index.html?org/apache/tools/ant/taskdefs/optional/pvcs/Pvcs.html" target="_top">Frames</a></li>
<li><a href="Pvcs.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary: </li>
<li>Nested | </li>
<li><a href="#fields_inherited_from_class_org.apache.tools.ant.Task">Field</a> | </li>
<li><a href="#constructor_summary">Constr</a> | </li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li>Field | </li>
<li><a href="#constructor_detail">Constr</a> | </li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">org.apache.tools.ant.taskdefs.optional.pvcs</div>
<h2 title="Class Pvcs" class="title">Class Pvcs</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li><a href="../../../../../../../org/apache/tools/ant/ProjectComponent.html" title="class in org.apache.tools.ant">org.apache.tools.ant.ProjectComponent</a></li>
<li>
<ul class="inheritance">
<li><a href="../../../../../../../org/apache/tools/ant/Task.html" title="class in org.apache.tools.ant">org.apache.tools.ant.Task</a></li>
<li>
<ul class="inheritance">
<li>org.apache.tools.ant.taskdefs.optional.pvcs.Pvcs</li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd>java.lang.Cloneable</dd>
</dl>
<hr>
<br>
<pre>public class <span class="strong">Pvcs</span>
extends <a href="../../../../../../../org/apache/tools/ant/Task.html" title="class in org.apache.tools.ant">Task</a></pre>
<div class="block">Extracts the latest edition of the source code from a PVCS repository.
PVCS is a version control system
developed by <a href="http://www.merant.com/products/pvcs">Merant</a>.
<br>
Before using this tag, the user running ant must have access to the commands
of PVCS (get and pcli) and must have access to the repository. Note that the way to specify
the repository is platform dependent so use property to specify location of repository.
<br>
This version has been tested agains PVCS version 6.5 and 6.6 under Windows and Solaris.
<b>19-04-2001</b> <p>The task now has a more robust
parser. It allows for platform independant file paths
and supports file names with <i>()</i>. Thanks to Erik Husby for
bringing the bug to my attention.
<b>27-04-2001</b> <p>UNC paths are now handled properly.
Fix provided by Don Jeffery. He also added an <i>UpdateOnly</i> flag
that, when true, conditions the PVCS get using the -U option to only
update those files that have a modification time (in PVCS) that is newer
than the existing workfile.
<b>25-10-2002</b> <p>Added a revision attribute that currently is a
synonym for label, but in a future release the behavior of the label
attribute will change to use the -v option of GET. See bug #13847 for
discussion.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field_summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<ul class="blockList">
<li class="blockList"><a name="fields_inherited_from_class_org.apache.tools.ant.Task">
<!-- -->
</a>
<h3>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></h3>
<code><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></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="fields_inherited_from_class_org.apache.tools.ant.ProjectComponent">
<!-- -->
</a>
<h3>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></h3>
<code><a href="../../../../../../../org/apache/tools/ant/ProjectComponent.html#description">description</a>, <a href="../../../../../../../org/apache/tools/ant/ProjectComponent.html#location">location</a>, <a href="../../../../../../../org/apache/tools/ant/ProjectComponent.html#project">project</a></code></li>
</ul>
</li>
</ul>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><strong><a href="../../../../../../../org/apache/tools/ant/taskdefs/optional/pvcs/Pvcs.html#Pvcs()">Pvcs</a></strong>()</code>
<div class="block">Creates a Pvcs object</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method_summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span>Methods</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../../../org/apache/tools/ant/taskdefs/optional/pvcs/Pvcs.html#addPvcsproject(org.apache.tools.ant.taskdefs.optional.pvcs.PvcsProject)">addPvcsproject</a></strong>(<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>
<div class="block">Specify a project within the PVCS repository to extract files from.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../../../org/apache/tools/ant/taskdefs/optional/pvcs/Pvcs.html#execute()">execute</a></strong>()</code>
<div class="block">Called by the project to let the task do its work.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../../../../../../org/apache/tools/ant/taskdefs/optional/pvcs/Pvcs.html#getConfig()">getConfig</a></strong>()</code>
<div class="block">returns the path of the configuration file to be used</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../../../../../../org/apache/tools/ant/taskdefs/optional/pvcs/Pvcs.html#getFilenameFormat()">getFilenameFormat</a></strong>()</code>
<div class="block">The filenameFormat attribute defines a MessageFormat string used
to parse the output of the pcli command.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../../../../../../org/apache/tools/ant/taskdefs/optional/pvcs/Pvcs.html#getForce()">getForce</a></strong>()</code>
<div class="block">Get value of force</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../../../../org/apache/tools/ant/taskdefs/optional/pvcs/Pvcs.html#getIgnoreReturnCode()">getIgnoreReturnCode</a></strong>()</code>
<div class="block">Get value of ignorereturncode</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../../../../../../org/apache/tools/ant/taskdefs/optional/pvcs/Pvcs.html#getLabel()">getLabel</a></strong>()</code>
<div class="block">Get value of label</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../../../../../../org/apache/tools/ant/taskdefs/optional/pvcs/Pvcs.html#getLineStart()">getLineStart</a></strong>()</code>
<div class="block">The lineStart attribute is used to parse the output of the pcli
command.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../../../../../../org/apache/tools/ant/taskdefs/optional/pvcs/Pvcs.html#getPromotiongroup()">getPromotiongroup</a></strong>()</code>
<div class="block">Get value of promotiongroup</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../../../../../../org/apache/tools/ant/taskdefs/optional/pvcs/Pvcs.html#getPvcsbin()">getPvcsbin</a></strong>()</code>
<div class="block">Get name of the PVCS bin directory</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../../../../../../org/apache/tools/ant/taskdefs/optional/pvcs/Pvcs.html#getPvcsproject()">getPvcsproject</a></strong>()</code>
<div class="block">Get name of the project in the PVCS repository</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>java.util.Vector</code></td>
<td class="colLast"><code><strong><a href="../../../../../../../org/apache/tools/ant/taskdefs/optional/pvcs/Pvcs.html#getPvcsprojects()">getPvcsprojects</a></strong>()</code>
<div class="block">Get name of the project in the PVCS repository</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../../../../../../org/apache/tools/ant/taskdefs/optional/pvcs/Pvcs.html#getRepository()">getRepository</a></strong>()</code>
<div class="block">Get network name of the PVCS repository</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../../../../../../org/apache/tools/ant/taskdefs/optional/pvcs/Pvcs.html#getRevision()">getRevision</a></strong>()</code>
<div class="block">Get value of revision</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../../../../org/apache/tools/ant/taskdefs/optional/pvcs/Pvcs.html#getUpdateOnly()">getUpdateOnly</a></strong>()</code>
<div class="block">get the updateOnly attribute.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../../../../../../org/apache/tools/ant/taskdefs/optional/pvcs/Pvcs.html#getUserId()">getUserId</a></strong>()</code>
<div class="block">Get the userid.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../../../../../../org/apache/tools/ant/taskdefs/optional/pvcs/Pvcs.html#getWorkspace()">getWorkspace</a></strong>()</code>
<div class="block">Get name of the workspace to store the retrieved files</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected int</code></td>
<td class="colLast"><code><strong><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></strong>(<a href="../../../../../../../org/apache/tools/ant/types/Commandline.html" title="class in org.apache.tools.ant.types">Commandline</a> cmd,
<a href="../../../../../../../org/apache/tools/ant/taskdefs/ExecuteStreamHandler.html" title="interface in org.apache.tools.ant.taskdefs">ExecuteStreamHandler</a> out)</code>
<div class="block">Run the command.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../../../org/apache/tools/ant/taskdefs/optional/pvcs/Pvcs.html#setConfig(java.io.File)">setConfig</a></strong>(java.io.File f)</code>
<div class="block">Sets a configuration file other than the default to be used.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../../../org/apache/tools/ant/taskdefs/optional/pvcs/Pvcs.html#setFilenameFormat(java.lang.String)">setFilenameFormat</a></strong>(java.lang.String f)</code>
<div class="block">The format of the folder names; optional.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../../../org/apache/tools/ant/taskdefs/optional/pvcs/Pvcs.html#setForce(java.lang.String)">setForce</a></strong>(java.lang.String f)</code>
<div class="block">Specifies the value of the force argument; optional.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../../../org/apache/tools/ant/taskdefs/optional/pvcs/Pvcs.html#setIgnoreReturnCode(boolean)">setIgnoreReturnCode</a></strong>(boolean b)</code>
<div class="block">If set to true the return value from executing the pvcs
commands are ignored; optional, default false.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../../../org/apache/tools/ant/taskdefs/optional/pvcs/Pvcs.html#setLabel(java.lang.String)">setLabel</a></strong>(java.lang.String l)</code>
<div class="block">Only files marked with this label are extracted; optional.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../../../org/apache/tools/ant/taskdefs/optional/pvcs/Pvcs.html#setLineStart(java.lang.String)">setLineStart</a></strong>(java.lang.String l)</code>
<div class="block">What a valid return value from PVCS looks like
when it describes a file.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../../../org/apache/tools/ant/taskdefs/optional/pvcs/Pvcs.html#setPromotiongroup(java.lang.String)">setPromotiongroup</a></strong>(java.lang.String w)</code>
<div class="block">Specifies the name of the promotiongroup argument</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../../../org/apache/tools/ant/taskdefs/optional/pvcs/Pvcs.html#setPvcsbin(java.lang.String)">setPvcsbin</a></strong>(java.lang.String bin)</code>
<div class="block">Specifies the location of the PVCS bin directory; optional if on the PATH.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../../../org/apache/tools/ant/taskdefs/optional/pvcs/Pvcs.html#setPvcsproject(java.lang.String)">setPvcsproject</a></strong>(java.lang.String prj)</code>
<div class="block">The project within the PVCS repository to extract files from;
optional, default "/"</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../../../org/apache/tools/ant/taskdefs/optional/pvcs/Pvcs.html#setRepository(java.lang.String)">setRepository</a></strong>(java.lang.String repo)</code>
<div class="block">The network name of the PVCS repository; required.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../../../org/apache/tools/ant/taskdefs/optional/pvcs/Pvcs.html#setRevision(java.lang.String)">setRevision</a></strong>(java.lang.String r)</code>
<div class="block">Only files with this revision are extract; optional.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../../../org/apache/tools/ant/taskdefs/optional/pvcs/Pvcs.html#setUpdateOnly(boolean)">setUpdateOnly</a></strong>(boolean l)</code>
<div class="block">If set to <i>true</i> files are fetched only if
newer than existing local files; optional, default false.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../../../org/apache/tools/ant/taskdefs/optional/pvcs/Pvcs.html#setUserId(java.lang.String)">setUserId</a></strong>(java.lang.String u)</code>
<div class="block">User ID</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../../../org/apache/tools/ant/taskdefs/optional/pvcs/Pvcs.html#setWorkspace(java.lang.String)">setWorkspace</a></strong>(java.lang.String ws)</code>
<div class="block">Workspace to use; optional.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_org.apache.tools.ant.Task">
<!-- -->
</a>
<h3>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></h3>
<code><a href="../../../../../../../org/apache/tools/ant/Task.html#bindToOwner(org.apache.tools.ant.Task)">bindToOwner</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#log(java.lang.String, java.lang.Throwable, int)">log</a>, <a href="../../../../../../../org/apache/tools/ant/Task.html#log(java.lang.Throwable, 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#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></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_org.apache.tools.ant.ProjectComponent">
<!-- -->
</a>
<h3>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></h3>
<code><a href="../../../../../../../org/apache/tools/ant/ProjectComponent.html#clone()">clone</a>, <a href="../../../../../../../org/apache/tools/ant/ProjectComponent.html#getDescription()">getDescription</a>, <a href="../../../../../../../org/apache/tools/ant/ProjectComponent.html#getLocation()">getLocation</a>, <a href="../../../../../../../org/apache/tools/ant/ProjectComponent.html#getProject()">getProject</a>, <a href="../../../../../../../org/apache/tools/ant/ProjectComponent.html#setDescription(java.lang.String)">setDescription</a>, <a href="../../../../../../../org/apache/tools/ant/ProjectComponent.html#setLocation(org.apache.tools.ant.Location)">setLocation</a>, <a href="../../../../../../../org/apache/tools/ant/ProjectComponent.html#setProject(org.apache.tools.ant.Project)">setProject</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class java.lang.Object</h3>
<code>equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="Pvcs()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>Pvcs</h4>
<pre>public Pvcs()</pre>
<div class="block">Creates a Pvcs object</div>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="runCmd(org.apache.tools.ant.types.Commandline, org.apache.tools.ant.taskdefs.ExecuteStreamHandler)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>runCmd</h4>
<pre>protected int runCmd(<a href="../../../../../../../org/apache/tools/ant/types/Commandline.html" title="class in org.apache.tools.ant.types">Commandline</a> cmd,
<a href="../../../../../../../org/apache/tools/ant/taskdefs/ExecuteStreamHandler.html" title="interface in org.apache.tools.ant.taskdefs">ExecuteStreamHandler</a> out)</pre>
<div class="block">Run the command.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>cmd</code> - the command line to use.</dd><dd><code>out</code> - the output stream handler to use.</dd>
<dt><span class="strong">Returns:</span></dt><dd>the exit code of the command.</dd></dl>
</li>
</ul>
<a name="execute()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>execute</h4>
<pre>public void execute()
throws <a href="../../../../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</a></pre>
<div class="block"><strong>Description copied from class: <code><a href="../../../../../../../org/apache/tools/ant/Task.html#execute()">Task</a></code></strong></div>
<div class="block">Called by the project to let the task do its work. This method may be
called more than once, if the task is invoked more than once.
For example,
if target1 and target2 both depend on target3, then running
"ant target1 target2" will run all tasks in target3 twice.</div>
<dl>
<dt><strong>Overrides:</strong></dt>
<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></dd>
<dt><span class="strong">Throws:</span></dt>
<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...</dd></dl>
</li>
</ul>
<a name="getRepository()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getRepository</h4>
<pre>public java.lang.String getRepository()</pre>
<div class="block">Get network name of the PVCS repository</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>String</dd></dl>
</li>
</ul>
<a name="getFilenameFormat()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getFilenameFormat</h4>
<pre>public java.lang.String getFilenameFormat()</pre>
<div class="block">The filenameFormat attribute defines a MessageFormat string used
to parse the output of the pcli command. It defaults to
<code>{0}-arc({1})</code>. Repositories where the archive
extension is not -arc should set this.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the filename format attribute.</dd></dl>
</li>
</ul>
<a name="setFilenameFormat(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setFilenameFormat</h4>
<pre>public void setFilenameFormat(java.lang.String f)</pre>
<div class="block">The format of the folder names; optional.
This must be in a format suitable for
<code>java.text.MessageFormat</code>.
Index 1 of the format will be used as the file name.
Defaults to <code>{0}-arc({1})</code></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>f</code> - the format to use.</dd></dl>
</li>
</ul>
<a name="getLineStart()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getLineStart</h4>
<pre>public java.lang.String getLineStart()</pre>
<div class="block">The lineStart attribute is used to parse the output of the pcli
command. It defaults to <code>"P:</code>. The parser already
knows about / and \\, this property is useful in cases where the
repository is accessed on a Windows platform via a drive letter
mapping.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the lineStart attribute.</dd></dl>
</li>
</ul>
<a name="setLineStart(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setLineStart</h4>
<pre>public void setLineStart(java.lang.String l)</pre>
<div class="block">What a valid return value from PVCS looks like
when it describes a file. Defaults to <code>"P:</code>.
If you are not using an UNC name for your repository and the
drive letter <code>P</code> is incorrect for your setup, you may
need to change this value, UNC names will always be
accepted.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>l</code> - the value to use.</dd></dl>
</li>
</ul>
<a name="setRepository(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setRepository</h4>
<pre>public void setRepository(java.lang.String repo)</pre>
<div class="block">The network name of the PVCS repository; required.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>repo</code> - String</dd></dl>
</li>
</ul>
<a name="getPvcsproject()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPvcsproject</h4>
<pre>public java.lang.String getPvcsproject()</pre>
<div class="block">Get name of the project in the PVCS repository</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>String</dd></dl>
</li>
</ul>
<a name="setPvcsproject(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setPvcsproject</h4>
<pre>public void setPvcsproject(java.lang.String prj)</pre>
<div class="block">The project within the PVCS repository to extract files from;
optional, default "/"</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>prj</code> - String</dd></dl>
</li>
</ul>
<a name="getPvcsprojects()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPvcsprojects</h4>
<pre>public java.util.Vector getPvcsprojects()</pre>
<div class="block">Get name of the project in the PVCS repository</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>Vector</dd></dl>
</li>
</ul>
<a name="getWorkspace()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getWorkspace</h4>
<pre>public java.lang.String getWorkspace()</pre>
<div class="block">Get name of the workspace to store the retrieved files</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>String</dd></dl>
</li>
</ul>
<a name="setWorkspace(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setWorkspace</h4>
<pre>public void setWorkspace(java.lang.String ws)</pre>
<div class="block">Workspace to use; optional.
By specifying a workspace, the files are extracted to that location.
A PVCS workspace is a name for a location of the workfiles and
isn't as such the location itself.
You define the location for a workspace using the PVCS GUI clients.
If this isn't specified the default workspace for the current user is used.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>ws</code> - String</dd></dl>
</li>
</ul>
<a name="getPvcsbin()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPvcsbin</h4>
<pre>public java.lang.String getPvcsbin()</pre>
<div class="block">Get name of the PVCS bin directory</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>String</dd></dl>
</li>
</ul>
<a name="setPvcsbin(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setPvcsbin</h4>
<pre>public void setPvcsbin(java.lang.String bin)</pre>
<div class="block">Specifies the location of the PVCS bin directory; optional if on the PATH.
On some systems the PVCS executables <i>pcli</i>
and <i>get</i> are not found in the PATH. In such cases this attribute
should be set to the bin directory of the PVCS installation containing
the executables mentioned before. If this attribute isn't specified the
tag expects the executables to be found using the PATH environment variable.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>bin</code> - PVCS bin directory</dd><dt><span class="strong">To do:</span></dt>
<dd>use a File setter and resolve paths.</dd></dl>
</li>
</ul>
<a name="getForce()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getForce</h4>
<pre>public java.lang.String getForce()</pre>
<div class="block">Get value of force</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>String</dd></dl>
</li>
</ul>
<a name="setForce(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setForce</h4>
<pre>public void setForce(java.lang.String f)</pre>
<div class="block">Specifies the value of the force argument; optional.
If set to <i>yes</i> all files that exists and are
writable are overwritten. Default <i>no</i> causes the files
that are writable to be ignored. This stops the PVCS command
<i>get</i> to stop asking questions!</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>f</code> - String (yes/no)</dd><dt><span class="strong">To do:</span></dt>
<dd>make a boolean setter</dd></dl>
</li>
</ul>
<a name="getPromotiongroup()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPromotiongroup</h4>
<pre>public java.lang.String getPromotiongroup()</pre>
<div class="block">Get value of promotiongroup</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>String</dd></dl>
</li>
</ul>
<a name="setPromotiongroup(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setPromotiongroup</h4>
<pre>public void setPromotiongroup(java.lang.String w)</pre>
<div class="block">Specifies the name of the promotiongroup argument</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>w</code> - String</dd></dl>
</li>
</ul>
<a name="getLabel()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getLabel</h4>
<pre>public java.lang.String getLabel()</pre>
<div class="block">Get value of label</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>String</dd></dl>
</li>
</ul>
<a name="setLabel(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setLabel</h4>
<pre>public void setLabel(java.lang.String l)</pre>
<div class="block">Only files marked with this label are extracted; optional.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>l</code> - String</dd></dl>
</li>
</ul>
<a name="getRevision()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getRevision</h4>
<pre>public java.lang.String getRevision()</pre>
<div class="block">Get value of revision</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>String</dd></dl>
</li>
</ul>
<a name="setRevision(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setRevision</h4>
<pre>public void setRevision(java.lang.String r)</pre>
<div class="block">Only files with this revision are extract; optional.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>r</code> - String</dd></dl>
</li>
</ul>
<a name="getIgnoreReturnCode()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getIgnoreReturnCode</h4>
<pre>public boolean getIgnoreReturnCode()</pre>
<div class="block">Get value of ignorereturncode</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>String</dd></dl>
</li>
</ul>
<a name="setIgnoreReturnCode(boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setIgnoreReturnCode</h4>
<pre>public void setIgnoreReturnCode(boolean b)</pre>
<div class="block">If set to true the return value from executing the pvcs
commands are ignored; optional, default false.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>b</code> - a <code>boolean</code> value.</dd></dl>
</li>
</ul>
<a name="addPvcsproject(org.apache.tools.ant.taskdefs.optional.pvcs.PvcsProject)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addPvcsproject</h4>
<pre>public void addPvcsproject(<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>
<div class="block">Specify a project within the PVCS repository to extract files from.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>p</code> - the pvcs project to use.</dd></dl>
</li>
</ul>
<a name="getUpdateOnly()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getUpdateOnly</h4>
<pre>public boolean getUpdateOnly()</pre>
<div class="block">get the updateOnly attribute.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the updateOnly attribute.</dd></dl>
</li>
</ul>
<a name="setUpdateOnly(boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setUpdateOnly</h4>
<pre>public void setUpdateOnly(boolean l)</pre>
<div class="block">If set to <i>true</i> files are fetched only if
newer than existing local files; optional, default false.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>l</code> - a <code>boolean</code> value.</dd></dl>
</li>
</ul>
<a name="getConfig()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getConfig</h4>
<pre>public java.lang.String getConfig()</pre>
<div class="block">returns the path of the configuration file to be used</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the path of the config file</dd></dl>
</li>
</ul>
<a name="setConfig(java.io.File)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setConfig</h4>
<pre>public void setConfig(java.io.File f)</pre>
<div class="block">Sets a configuration file other than the default to be used.
These files have a .cfg extension and are often found in archive or pvcsprop folders.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>f</code> - config file - can be given absolute or relative to ant basedir</dd></dl>
</li>
</ul>
<a name="getUserId()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getUserId</h4>
<pre>public java.lang.String getUserId()</pre>
<div class="block">Get the userid.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the userid.</dd></dl>
</li>
</ul>
<a name="setUserId(java.lang.String)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>setUserId</h4>
<pre>public void setUserId(java.lang.String u)</pre>
<div class="block">User ID</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>u</code> - the value to use.</dd></dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar_bottom">
<!-- -->
</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li>Prev Class</li>
<li><a href="../../../../../../../org/apache/tools/ant/taskdefs/optional/pvcs/PvcsProject.html" title="class in org.apache.tools.ant.taskdefs.optional.pvcs"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../../index.html?org/apache/tools/ant/taskdefs/optional/pvcs/Pvcs.html" target="_top">Frames</a></li>
<li><a href="Pvcs.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary: </li>
<li>Nested | </li>
<li><a href="#fields_inherited_from_class_org.apache.tools.ant.Task">Field</a> | </li>
<li><a href="#constructor_summary">Constr</a> | </li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li>Field | </li>
<li><a href="#constructor_detail">Constr</a> | </li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>