????

Your IP : 216.73.216.152

Current Path : /opt/ant/manual/api/org/apache/tools/ant/util/facade/
Upload File :
Current File : //opt/ant/manual/api/org/apache/tools/ant/util/facade/FacadeTaskHelper.html

<!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:55 CEST 2012 -->
<title>FacadeTaskHelper (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="FacadeTaskHelper (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/util/facade/ImplementationSpecificArgument.html" title="class in org.apache.tools.ant.util.facade"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/apache/tools/ant/util/facade/FacadeTaskHelper.html" target="_top">Frames</a></li>
<li><a href="FacadeTaskHelper.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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor_summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor_detail">Constr</a>&nbsp;|&nbsp;</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.util.facade</div>
<h2 title="Class FacadeTaskHelper" class="title">Class FacadeTaskHelper</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>org.apache.tools.ant.util.facade.FacadeTaskHelper</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public class <span class="strong">FacadeTaskHelper</span>
extends java.lang.Object</pre>
<div class="block">Helper class for facade implementations - encapsulates treatment of
 explicit implementation choices, magic properties and
 implementation specific command line arguments.</div>
<dl><dt><span class="strong">Since:</span></dt>
  <dd>Ant 1.5</dd></dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== 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">&nbsp;</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/util/facade/FacadeTaskHelper.html#FacadeTaskHelper(java.lang.String)">FacadeTaskHelper</a></strong>(java.lang.String&nbsp;defaultValue)</code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><strong><a href="../../../../../../org/apache/tools/ant/util/facade/FacadeTaskHelper.html#FacadeTaskHelper(java.lang.String, java.lang.String)">FacadeTaskHelper</a></strong>(java.lang.String&nbsp;defaultValue,
                java.lang.String&nbsp;magicValue)</code>&nbsp;</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">&nbsp;</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/util/facade/FacadeTaskHelper.html#addImplementationArgument(org.apache.tools.ant.util.facade.ImplementationSpecificArgument)">addImplementationArgument</a></strong>(<a href="../../../../../../org/apache/tools/ant/util/facade/ImplementationSpecificArgument.html" title="class in org.apache.tools.ant.util.facade">ImplementationSpecificArgument</a>&nbsp;arg)</code>
<div class="block">Command line argument.</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/util/facade/FacadeTaskHelper.html#getArgs()">getArgs</a></strong>()</code>
<div class="block">Retrieves the command line arguments enabled for the current
 facade implementation.</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/util/facade/FacadeTaskHelper.html#getExplicitChoice()">getExplicitChoice</a></strong>()</code>
<div class="block">Retrieves the explicit user choice.</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/util/facade/FacadeTaskHelper.html#getImplementation()">getImplementation</a></strong>()</code>
<div class="block">Retrieves the implementation.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../../../org/apache/tools/ant/types/Path.html" title="class in org.apache.tools.ant.types">Path</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../../org/apache/tools/ant/util/facade/FacadeTaskHelper.html#getImplementationClasspath(org.apache.tools.ant.Project)">getImplementationClasspath</a></strong>(<a href="../../../../../../org/apache/tools/ant/Project.html" title="class in org.apache.tools.ant">Project</a>&nbsp;project)</code>
<div class="block">The classpath to use when loading the implementation.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../../../org/apache/tools/ant/util/facade/FacadeTaskHelper.html#hasBeenSet()">hasBeenSet</a></strong>()</code>
<div class="block">Tests whether the implementation has been chosen by the user
 (either via a magic property or explicitly.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../../org/apache/tools/ant/util/facade/FacadeTaskHelper.html#setImplementation(java.lang.String)">setImplementation</a></strong>(java.lang.String&nbsp;userChoice)</code>
<div class="block">Used for explicit user choices.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../../org/apache/tools/ant/util/facade/FacadeTaskHelper.html#setMagicValue(java.lang.String)">setMagicValue</a></strong>(java.lang.String&nbsp;magicValue)</code>
<div class="block">Used to set the value of the magic property.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">
<!--   -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
<code>clone, 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="FacadeTaskHelper(java.lang.String)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>FacadeTaskHelper</h4>
<pre>public&nbsp;FacadeTaskHelper(java.lang.String&nbsp;defaultValue)</pre>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>defaultValue</code> - The default value for the implementation.
 Must not be null.</dd></dl>
</li>
</ul>
<a name="FacadeTaskHelper(java.lang.String, java.lang.String)">
<!--   -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>FacadeTaskHelper</h4>
<pre>public&nbsp;FacadeTaskHelper(java.lang.String&nbsp;defaultValue,
                java.lang.String&nbsp;magicValue)</pre>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>defaultValue</code> - The default value for the implementation.
 Must not be null.</dd><dd><code>magicValue</code> - the value of a magic property that may hold a user.
 choice.  May be null.</dd></dl>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!--   -->
</a>
<h3>Method Detail</h3>
<a name="setMagicValue(java.lang.String)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setMagicValue</h4>
<pre>public&nbsp;void&nbsp;setMagicValue(java.lang.String&nbsp;magicValue)</pre>
<div class="block">Used to set the value of the magic property.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>magicValue</code> - the value of a magic property that may hold a user.</dd></dl>
</li>
</ul>
<a name="setImplementation(java.lang.String)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setImplementation</h4>
<pre>public&nbsp;void&nbsp;setImplementation(java.lang.String&nbsp;userChoice)</pre>
<div class="block">Used for explicit user choices.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>userChoice</code> - the explicitly chosen implementation.</dd></dl>
</li>
</ul>
<a name="getImplementation()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getImplementation</h4>
<pre>public&nbsp;java.lang.String&nbsp;getImplementation()</pre>
<div class="block">Retrieves the implementation.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the implementation.</dd></dl>
</li>
</ul>
<a name="getExplicitChoice()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getExplicitChoice</h4>
<pre>public&nbsp;java.lang.String&nbsp;getExplicitChoice()</pre>
<div class="block">Retrieves the explicit user choice.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the explicit user choice.</dd></dl>
</li>
</ul>
<a name="addImplementationArgument(org.apache.tools.ant.util.facade.ImplementationSpecificArgument)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addImplementationArgument</h4>
<pre>public&nbsp;void&nbsp;addImplementationArgument(<a href="../../../../../../org/apache/tools/ant/util/facade/ImplementationSpecificArgument.html" title="class in org.apache.tools.ant.util.facade">ImplementationSpecificArgument</a>&nbsp;arg)</pre>
<div class="block">Command line argument.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>arg</code> - an argument to add.</dd></dl>
</li>
</ul>
<a name="getArgs()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getArgs</h4>
<pre>public&nbsp;java.lang.String[]&nbsp;getArgs()</pre>
<div class="block">Retrieves the command line arguments enabled for the current
 facade implementation.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>an array of command line arguements.</dd></dl>
</li>
</ul>
<a name="hasBeenSet()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>hasBeenSet</h4>
<pre>public&nbsp;boolean&nbsp;hasBeenSet()</pre>
<div class="block">Tests whether the implementation has been chosen by the user
 (either via a magic property or explicitly.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>true if magic or user choice has be set.</dd><dt><span class="strong">Since:</span></dt>
  <dd>Ant 1.5.2</dd></dl>
</li>
</ul>
<a name="getImplementationClasspath(org.apache.tools.ant.Project)">
<!--   -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getImplementationClasspath</h4>
<pre>public&nbsp;<a href="../../../../../../org/apache/tools/ant/types/Path.html" title="class in org.apache.tools.ant.types">Path</a>&nbsp;getImplementationClasspath(<a href="../../../../../../org/apache/tools/ant/Project.html" title="class in org.apache.tools.ant">Project</a>&nbsp;project)</pre>
<div class="block">The classpath to use when loading the implementation.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>project</code> - the current project</dd>
<dt><span class="strong">Returns:</span></dt><dd>a Path instance that may be appended to</dd><dt><span class="strong">Since:</span></dt>
  <dd>Ant 1.8.0</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/util/facade/ImplementationSpecificArgument.html" title="class in org.apache.tools.ant.util.facade"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/apache/tools/ant/util/facade/FacadeTaskHelper.html" target="_top">Frames</a></li>
<li><a href="FacadeTaskHelper.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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor_summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor_detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_bottom">
<!--   -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>