????
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>P4Base (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="P4Base (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><a href="../../../../../../../org/apache/tools/ant/taskdefs/optional/perforce/P4Add.html" title="class in org.apache.tools.ant.taskdefs.optional.perforce"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../../../../org/apache/tools/ant/taskdefs/optional/perforce/P4Change.html" title="class in org.apache.tools.ant.taskdefs.optional.perforce"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../../index.html?org/apache/tools/ant/taskdefs/optional/perforce/P4Base.html" target="_top">Frames</a></li>
<li><a href="P4Base.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="#field_summary">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><a href="#field_detail">Field</a> | </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.perforce</div>
<h2 title="Class P4Base" class="title">Class P4Base</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.perforce.P4Base</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>
<dl>
<dt>Direct Known Subclasses:</dt>
<dd><a href="../../../../../../../org/apache/tools/ant/taskdefs/optional/perforce/P4Add.html" title="class in org.apache.tools.ant.taskdefs.optional.perforce">P4Add</a>, <a href="../../../../../../../org/apache/tools/ant/taskdefs/optional/perforce/P4Change.html" title="class in org.apache.tools.ant.taskdefs.optional.perforce">P4Change</a>, <a href="../../../../../../../org/apache/tools/ant/taskdefs/optional/perforce/P4Counter.html" title="class in org.apache.tools.ant.taskdefs.optional.perforce">P4Counter</a>, <a href="../../../../../../../org/apache/tools/ant/taskdefs/optional/perforce/P4Delete.html" title="class in org.apache.tools.ant.taskdefs.optional.perforce">P4Delete</a>, <a href="../../../../../../../org/apache/tools/ant/taskdefs/optional/perforce/P4Edit.html" title="class in org.apache.tools.ant.taskdefs.optional.perforce">P4Edit</a>, <a href="../../../../../../../org/apache/tools/ant/taskdefs/optional/perforce/P4Fstat.html" title="class in org.apache.tools.ant.taskdefs.optional.perforce">P4Fstat</a>, <a href="../../../../../../../org/apache/tools/ant/taskdefs/optional/perforce/P4Have.html" title="class in org.apache.tools.ant.taskdefs.optional.perforce">P4Have</a>, <a href="../../../../../../../org/apache/tools/ant/taskdefs/optional/perforce/P4Integrate.html" title="class in org.apache.tools.ant.taskdefs.optional.perforce">P4Integrate</a>, <a href="../../../../../../../org/apache/tools/ant/taskdefs/optional/perforce/P4Label.html" title="class in org.apache.tools.ant.taskdefs.optional.perforce">P4Label</a>, <a href="../../../../../../../org/apache/tools/ant/taskdefs/optional/perforce/P4Labelsync.html" title="class in org.apache.tools.ant.taskdefs.optional.perforce">P4Labelsync</a>, <a href="../../../../../../../org/apache/tools/ant/taskdefs/optional/perforce/P4Reopen.html" title="class in org.apache.tools.ant.taskdefs.optional.perforce">P4Reopen</a>, <a href="../../../../../../../org/apache/tools/ant/taskdefs/optional/perforce/P4Resolve.html" title="class in org.apache.tools.ant.taskdefs.optional.perforce">P4Resolve</a>, <a href="../../../../../../../org/apache/tools/ant/taskdefs/optional/perforce/P4Revert.html" title="class in org.apache.tools.ant.taskdefs.optional.perforce">P4Revert</a>, <a href="../../../../../../../org/apache/tools/ant/taskdefs/optional/perforce/P4Submit.html" title="class in org.apache.tools.ant.taskdefs.optional.perforce">P4Submit</a>, <a href="../../../../../../../org/apache/tools/ant/taskdefs/optional/perforce/P4Sync.html" title="class in org.apache.tools.ant.taskdefs.optional.perforce">P4Sync</a></dd>
</dl>
<hr>
<br>
<pre>public abstract class <span class="strong">P4Base</span>
extends <a href="../../../../../../../org/apache/tools/ant/Task.html" title="class in org.apache.tools.ant">Task</a></pre>
<div class="block">Base class for Perforce (P4) ANT tasks. See individual task for example usage.</div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../../../org/apache/tools/ant/taskdefs/optional/perforce/P4Sync.html" title="class in org.apache.tools.ant.taskdefs.optional.perforce"><code>P4Sync</code></a>,
<a href="../../../../../../../org/apache/tools/ant/taskdefs/optional/perforce/P4Have.html" title="class in org.apache.tools.ant.taskdefs.optional.perforce"><code>P4Have</code></a>,
<a href="../../../../../../../org/apache/tools/ant/taskdefs/optional/perforce/P4Change.html" title="class in org.apache.tools.ant.taskdefs.optional.perforce"><code>P4Change</code></a>,
<a href="../../../../../../../org/apache/tools/ant/taskdefs/optional/perforce/P4Edit.html" title="class in org.apache.tools.ant.taskdefs.optional.perforce"><code>P4Edit</code></a>,
<a href="../../../../../../../org/apache/tools/ant/taskdefs/optional/perforce/P4Submit.html" title="class in org.apache.tools.ant.taskdefs.optional.perforce"><code>P4Submit</code></a>,
<a href="../../../../../../../org/apache/tools/ant/taskdefs/optional/perforce/P4Label.html" title="class in org.apache.tools.ant.taskdefs.optional.perforce"><code>P4Label</code></a>,
<a href="../../../../../../../org/apache/tools/ant/taskdefs/Execute.html" title="class in org.apache.tools.ant.taskdefs"><code>Execute</code></a></dd></dl>
</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>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
<caption><span>Fields</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Field and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../../../../org/apache/tools/ant/taskdefs/optional/perforce/P4Base.html#failOnError">failOnError</a></strong></code>
<div class="block">Keep going or fail on error - defaults to fail.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../../../../../../org/apache/tools/ant/taskdefs/optional/perforce/P4Base.html#P4Client">P4Client</a></strong></code>
<div class="block">Perforce Client (eg myclientspec)</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../../../../../../org/apache/tools/ant/taskdefs/optional/perforce/P4Base.html#P4CmdOpts">P4CmdOpts</a></strong></code>
<div class="block">Perforce command opts.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../../../../../../org/apache/tools/ant/taskdefs/optional/perforce/P4Base.html#P4Opts">P4Opts</a></strong></code>
<div class="block">Perforce 'global' opts.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../../../../../../org/apache/tools/ant/taskdefs/optional/perforce/P4Base.html#P4Port">P4Port</a></strong></code>
<div class="block">Perforce Server Port (eg KM01:1666)</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../../../../../../org/apache/tools/ant/taskdefs/optional/perforce/P4Base.html#P4User">P4User</a></strong></code>
<div class="block">Perforce User (eg fbloggs)</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../../../../../../org/apache/tools/ant/taskdefs/optional/perforce/P4Base.html#P4View">P4View</a></strong></code>
<div class="block">Perforce view for commands.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../../../../../../org/apache/tools/ant/taskdefs/optional/perforce/P4Base.html#shell">shell</a></strong></code>
<div class="block">The OS shell to use (cmd.exe or /bin/sh)</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected org.apache.oro.text.perl.Perl5Util</code></td>
<td class="colLast"><code><strong><a href="../../../../../../../org/apache/tools/ant/taskdefs/optional/perforce/P4Base.html#util">util</a></strong></code>
<div class="block">Perl5 regexp in Java - cool eh?</div>
</td>
</tr>
</table>
<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/perforce/P4Base.html#P4Base()">P4Base</a></strong>()</code> </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>protected void</code></td>
<td class="colLast"><code><strong><a href="../../../../../../../org/apache/tools/ant/taskdefs/optional/perforce/P4Base.html#execP4Command(java.lang.String)">execP4Command</a></strong>(java.lang.String command)</code>
<div class="block">no usages found for this method
runs a Perforce command without a handler</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><strong><a href="../../../../../../../org/apache/tools/ant/taskdefs/optional/perforce/P4Base.html#execP4Command(java.lang.String, org.apache.tools.ant.taskdefs.optional.perforce.P4Handler)">execP4Command</a></strong>(java.lang.String command,
<a href="../../../../../../../org/apache/tools/ant/taskdefs/optional/perforce/P4Handler.html" title="interface in org.apache.tools.ant.taskdefs.optional.perforce">P4Handler</a> handler)</code>
<div class="block">Execute P4 command assembled by subclasses.</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/perforce/P4Base.html#getErrorMessage()">getErrorMessage</a></strong>()</code>
<div class="block">gets the error message recorded by the Perforce handler</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/perforce/P4Base.html#getInError()">getInError</a></strong>()</code>
<div class="block">gets whether or not the task has encountered an error</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/perforce/P4Base.html#init()">init</a></strong>()</code>
<div class="block">sets attributes Port, Client, User from properties
if these properties are defined.</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/perforce/P4Base.html#setClient(java.lang.String)">setClient</a></strong>(java.lang.String p4Client)</code>
<div class="block">The p4 client spec to use;
optional, defaults to the current user</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/perforce/P4Base.html#setCmdopts(java.lang.String)">setCmdopts</a></strong>(java.lang.String p4CmdOpts)</code>
<div class="block">Set extra command options; only used on some
of the Perforce tasks.</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/perforce/P4Base.html#setErrorMessage(java.lang.String)">setErrorMessage</a></strong>(java.lang.String errorMessage)</code>
<div class="block">sets the error message</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/perforce/P4Base.html#setFailonerror(boolean)">setFailonerror</a></strong>(boolean fail)</code>
<div class="block">whether to stop the build (true, default)
or keep going if an error is returned from the p4 command</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/perforce/P4Base.html#setGlobalopts(java.lang.String)">setGlobalopts</a></strong>(java.lang.String p4Opts)</code>
<div class="block">Set global P4 options; Used on all
of the Perforce tasks.</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/perforce/P4Base.html#setInError(boolean)">setInError</a></strong>(boolean inError)</code>
<div class="block">sets the error flag on the task</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/perforce/P4Base.html#setPort(java.lang.String)">setPort</a></strong>(java.lang.String p4Port)</code>
<div class="block">The p4d server and port to connect to;
optional, default "perforce:1666"</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/perforce/P4Base.html#setUser(java.lang.String)">setUser</a></strong>(java.lang.String p4User)</code>
<div class="block">The p4 username;
optional, defaults to the current user</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/perforce/P4Base.html#setView(java.lang.String)">setView</a></strong>(java.lang.String p4View)</code>
<div class="block">The client, branch or label view to operate upon;
optional default "//...".</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#execute()">execute</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#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">
<!-- ============ FIELD DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="field_detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a name="util">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>util</h4>
<pre>protected org.apache.oro.text.perl.Perl5Util util</pre>
<div class="block">Perl5 regexp in Java - cool eh?</div>
</li>
</ul>
<a name="shell">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>shell</h4>
<pre>protected java.lang.String shell</pre>
<div class="block">The OS shell to use (cmd.exe or /bin/sh)</div>
</li>
</ul>
<a name="P4Port">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>P4Port</h4>
<pre>protected java.lang.String P4Port</pre>
<div class="block">Perforce Server Port (eg KM01:1666)</div>
</li>
</ul>
<a name="P4Client">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>P4Client</h4>
<pre>protected java.lang.String P4Client</pre>
<div class="block">Perforce Client (eg myclientspec)</div>
</li>
</ul>
<a name="P4User">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>P4User</h4>
<pre>protected java.lang.String P4User</pre>
<div class="block">Perforce User (eg fbloggs)</div>
</li>
</ul>
<a name="P4View">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>P4View</h4>
<pre>protected java.lang.String P4View</pre>
<div class="block">Perforce view for commands. (eg //projects/foobar/main/source/... )</div>
</li>
</ul>
<a name="failOnError">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>failOnError</h4>
<pre>protected boolean failOnError</pre>
<div class="block">Keep going or fail on error - defaults to fail.</div>
</li>
</ul>
<a name="P4Opts">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>P4Opts</h4>
<pre>protected java.lang.String P4Opts</pre>
<div class="block">Perforce 'global' opts.
Forms half of low level API</div>
</li>
</ul>
<a name="P4CmdOpts">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>P4CmdOpts</h4>
<pre>protected java.lang.String P4CmdOpts</pre>
<div class="block">Perforce command opts.
Forms half of low level API</div>
</li>
</ul>
</li>
</ul>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="P4Base()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>P4Base</h4>
<pre>public P4Base()</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="getInError()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getInError</h4>
<pre>public boolean getInError()</pre>
<div class="block">gets whether or not the task has encountered an error</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>error flag</dd><dt><span class="strong">Since:</span></dt>
<dd>ant 1.6</dd></dl>
</li>
</ul>
<a name="setInError(boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setInError</h4>
<pre>public void setInError(boolean inError)</pre>
<div class="block">sets the error flag on the task</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>inError</code> - if true an error has been encountered by the handler</dd><dt><span class="strong">Since:</span></dt>
<dd>ant 1.6</dd></dl>
</li>
</ul>
<a name="getErrorMessage()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getErrorMessage</h4>
<pre>public java.lang.String getErrorMessage()</pre>
<div class="block">gets the error message recorded by the Perforce handler</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>error message</dd></dl>
</li>
</ul>
<a name="setErrorMessage(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setErrorMessage</h4>
<pre>public void setErrorMessage(java.lang.String errorMessage)</pre>
<div class="block">sets the error message</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>errorMessage</code> - line of error output</dd></dl>
</li>
</ul>
<a name="setPort(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setPort</h4>
<pre>public void setPort(java.lang.String p4Port)</pre>
<div class="block">The p4d server and port to connect to;
optional, default "perforce:1666"</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>p4Port</code> - the port one wants to set such as localhost:1666</dd></dl>
</li>
</ul>
<a name="setClient(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setClient</h4>
<pre>public void setClient(java.lang.String p4Client)</pre>
<div class="block">The p4 client spec to use;
optional, defaults to the current user</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>p4Client</code> - the name of the Perforce client spec</dd></dl>
</li>
</ul>
<a name="setUser(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setUser</h4>
<pre>public void setUser(java.lang.String p4User)</pre>
<div class="block">The p4 username;
optional, defaults to the current user</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>p4User</code> - the user name</dd></dl>
</li>
</ul>
<a name="setGlobalopts(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setGlobalopts</h4>
<pre>public void setGlobalopts(java.lang.String p4Opts)</pre>
<div class="block">Set global P4 options; Used on all
of the Perforce tasks.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>p4Opts</code> - global options, to use a specific P4Config file for instance</dd></dl>
</li>
</ul>
<a name="setView(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setView</h4>
<pre>public void setView(java.lang.String p4View)</pre>
<div class="block">The client, branch or label view to operate upon;
optional default "//...".
the view is required for the following tasks :
<ul>
<li>p4delete</li>
<li>p4edit</li>
<li>p4reopen</li>
<li>p4resolve</li>
</ul></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>p4View</code> - the view one wants to use</dd></dl>
</li>
</ul>
<a name="setCmdopts(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setCmdopts</h4>
<pre>public void setCmdopts(java.lang.String p4CmdOpts)</pre>
<div class="block">Set extra command options; only used on some
of the Perforce tasks.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>p4CmdOpts</code> - command line options going after the particular
Perforce command</dd></dl>
</li>
</ul>
<a name="setFailonerror(boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setFailonerror</h4>
<pre>public void setFailonerror(boolean fail)</pre>
<div class="block">whether to stop the build (true, default)
or keep going if an error is returned from the p4 command</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>fail</code> - indicates whether one wants to fail the build if an error comes from the
Perforce command</dd></dl>
</li>
</ul>
<a name="init()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>init</h4>
<pre>public void init()</pre>
<div class="block">sets attributes Port, Client, User from properties
if these properties are defined.
Called automatically by UnknownElement</div>
<dl>
<dt><strong>Overrides:</strong></dt>
<dd><code><a href="../../../../../../../org/apache/tools/ant/Task.html#init()">init</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">See Also:</span></dt><dd><a href="../../../../../../../org/apache/tools/ant/UnknownElement.html" title="class in org.apache.tools.ant"><code><table>
<tr><th>Property</th><th>Attribute</th></tr>
<tr><td>p4.port</td><td>Port</td></tr>
<tr><td>p4.client</td><td>Client</td></tr>
<tr><td>p4.user</td><td>User</td></tr>
</table></code></a></dd></dl>
</li>
</ul>
<a name="execP4Command(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>execP4Command</h4>
<pre>protected void execP4Command(java.lang.String command)
throws <a href="../../../../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</a></pre>
<div class="block">no usages found for this method
runs a Perforce command without a handler</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>command</code> - the command that one wants to execute</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> - if failonerror is set and the command fails</dd></dl>
</li>
</ul>
<a name="execP4Command(java.lang.String, org.apache.tools.ant.taskdefs.optional.perforce.P4Handler)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>execP4Command</h4>
<pre>protected void execP4Command(java.lang.String command,
<a href="../../../../../../../org/apache/tools/ant/taskdefs/optional/perforce/P4Handler.html" title="interface in org.apache.tools.ant.taskdefs.optional.perforce">P4Handler</a> handler)
throws <a href="../../../../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</a></pre>
<div class="block">Execute P4 command assembled by subclasses.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>command</code> - The command to run</dd><dd><code>handler</code> - A P4Handler to process any input and output</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> - if failonerror has been set to true</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><a href="../../../../../../../org/apache/tools/ant/taskdefs/optional/perforce/P4Add.html" title="class in org.apache.tools.ant.taskdefs.optional.perforce"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../../../../org/apache/tools/ant/taskdefs/optional/perforce/P4Change.html" title="class in org.apache.tools.ant.taskdefs.optional.perforce"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../../index.html?org/apache/tools/ant/taskdefs/optional/perforce/P4Base.html" target="_top">Frames</a></li>
<li><a href="P4Base.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="#field_summary">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><a href="#field_detail">Field</a> | </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>