Google Git
Sign in
apache / ant / 6a58fc065a946967e4842914d64b2e3259305021 / . / docs / manual / OptionalTasks / jarlib-available.html
blob: ceb97b9646ea01c38b67f989e425b6c45770cc8a [file] [log] [blame]
<html>
<head>
<meta http-equiv="Content-Language" content="en-us">
<title>jarlib-available Task</title>
</head>
<body>
<h2><a name="jarlib-available">jarlib-available</a></h2>
<h3>Description</h3>
<p>Check whether an extension is present in a fileset or an extensionSet.
If the extension is present then a property is set.</p>
<p>Note that this task
works with extensions as defined by the "Optional Package" specification.
For more information about optional packages, see the document
<em>Optional Package Versioning</em> in the documentation bundle for your
Java2 Standard Edition package, in file
<code>guide/extensions/versioning.html</code> or online at
<a href="http://java.sun.com/j2se/1.3/docs/guide/extensions/versioning.html">
http://java.sun.com/j2se/1.3/docs/guide/extensions/versioning.html</a>.</p>
<p>See the Extension and ExtensionSet documentation for further details</p>
<h3>Parameters</h3>
<table border="1" cellpadding="2" cellspacing="0">
<tr>
<td valign="top"><b>Attribute</b></td>
<td valign="top"><b>Description</b></td>
<td align="center" valign="top"><b>Required</b></td>
</tr>
<tr>
<td valign="top">property</td>
<td valign="top">The name of property to set if extensions is available.</td>
<td valign="top" align="center">Yes</td>
</tr>
<tr>
<td valign="top">file</td>
<td valign="top">The file to check for extension</td>
<td valign="top" align="center">No, one of file, nested
ExtensionSet or nested fileset must be present.</td>
</tr>
</table>
<h3>Parameters specified as nested elements</h3>
<h4>extension</h4>
<p><a href="../OptionalTypes/extension.html">Extension</a> the extension
to search for.</p>
<h4>fileset</h4>
<p><a href="../CoreTypes/fileset.html">FileSet</a>s are used to select
sets of files to check for extension.</p>
<h4>extensionSet</h4>
<p><a href="../OptionalTypes/extensionset.html">ExtensionSet</a>s is the set
of extensions to search for extension in.</p>
<h3>Examples</h3>
<p><b>Search for extension in single file</b></p>
<pre>
&lt;jarlib-available property=&quot;myext.present&quot; file=&quot;myfile.jar&quot;&gt;
&lt;extension
extensionName=&quot;org.apache.tools.ant&quot;
specificationVersion=&quot;1.4.9&quot;
specificationVendor=&quot;Apache Software Foundation&quot;/&gt;
&lt;/jarlib-available&gt;
</pre>
<p><b>Search for extension in single file refencing external Extension</b></p>
<pre>
&lt;extension id=&quot;myext&quot;
extensionName=&quot;org.apache.tools.ant&quot;
specificationVersion=&quot;1.4.9&quot;
specificationVendor=&quot;Apache Software Foundation&quot;/&gt;
&lt;jarlib-available property=&quot;myext.present&quot; file=&quot;myfile.jar&quot;&gt;
&lt;extension refid=&quot;myext&quot;/&gt;
&lt;/jarlib-available&gt;
</pre>
<p><b>Search for extension in fileset</b></p>
<pre>
&lt;extension id=&quot;myext&quot;
extensionName=&quot;org.apache.tools.ant&quot;
specificationVersion=&quot;1.4.9&quot;
specificationVendor=&quot;Apache Software Foundation&quot;/&gt;
&lt;jarlib-available property=&quot;myext.present&quot;&gt;
&lt;extension refid=&quot;myext&quot;/&gt;
&lt;fileset dir="lib"&gt;
&lt;include name="*.jar"/&gt;
&lt;/fileset&gt;
&lt;/jarlib-available&gt;
</pre>
<p><b>Search for extension in extensionSet</b></p>
<pre>
&lt;extension id=&quot;myext&quot;
extensionName=&quot;org.apache.tools.ant&quot;
specificationVersion=&quot;1.4.9&quot;
specificationVendor=&quot;Apache Software Foundation&quot;/&gt;
&lt;jarlib-available property=&quot;myext.present&quot;&gt;
&lt;extension refid=&quot;myext&quot;/&gt;
&lt;extensionSet id=&quot;exts3&quot;&gt;
&lt;libfileset
includeUrl=&quot;false&quot;
includeImpl=&quot;true&quot;
dir=&quot;lib&quot;&gt;
&lt;include name=&quot;*.jar&quot;/&gt;
&lt;/libfileset&gt;
&lt;/extensionSet&gt;
&lt;/jarlib-available&gt;
</pre>
<hr><p align="center">Copyright &copy; 2002 Apache Software Foundation.
All rights Reserved.</p>
</body>
</html>