aboutsummaryrefslogtreecommitdiffstats
path: root/framework/src/ant/apache-ant-1.9.6/manual/Tasks/jarlib-available.html
blob: adb732f0384bf961ed90d487343145597f908c36 (plain) 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134

<!--
   Licensed to the Apache Software Foundation (ASF) under one or more
   contributor license agreements.  See the NOTICE file distributed with
   this work for additional information regarding copyright ownership.
   The ASF licenses this file to You under the Apache License, Version 2.0
   (the "License"); you may not use this file except in compliance with
   the License.  You may obtain a copy of the License at

       http://www.apache.org/licenses/LICENSE-2.0

   Unless required by applicable law or agreed to in writing, software
   distributed under the License is distributed on an "AS IS" BASIS,
   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
   See the License for the specific language governing permissions and
   limitations under the License.
-->
<html>

<head>
<meta http-equiv="Content-Language" content="en-us">
<link rel="stylesheet" type="text/css" href="../stylesheets/style.css">
<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
Java Standard Edition package, in file
<code>guide/extensions/versioning.html</code> or the online
<a target="_blank" href="http://docs.oracle.com/javase/7/docs/technotes/guides/extensions/versioning.html">
Extension and ExtensionSet documentation</a> 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="../Types/extension.html">Extension</a> the extension
 to search for.</p>

<h4>fileset</h4>
 <p><a href="../Types/fileset.html">FileSet</a>s are used to select
sets of files to check for extension.</p>

<h4>extensionSet</h4>
 <p><a href="../Types/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 referencing 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>



</body>
</html>