blob: 3b7932b49b3e060789c60f73c4a567cc64276c76 [file] [log] [blame]
<!DOCTYPE html>
<!--
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
https://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 lang="en">
<head>
<link rel="stylesheet" type="text/css" href="../stylesheets/style.css">
<title>Extension Type</title>
</head>
<body>
<h2 id="fileset">Extension</h2>
<p>Utility type that represents either an available "Optional Package" (formerly known as "Standard
Extension") as described in the manifest of a JAR file, or the requirement for such an optional
package.</p>
<p>Note that this type 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 <samp>guide/extensions/versioning.html</samp> or the
online <a href="https://docs.oracle.com/javase/8/docs/technotes/guides/versioning/spec/versioning2.html#wp90779"
target="_top">Package Versioning documentation.</a></p>
<h3>Attributes</h3>
<p>The extension type supports the following attributes:</p>
<table class="attr">
<tr>
<th scope="col">Attribute</th>
<th scope="col">Description</th>
<th scope="col">Required</th>
</tr>
<tr>
<td>extensionName</td>
<td>The name of extension</td>
<td>yes</td>
</tr>
<tr>
<td>specificationVersion</td>
<td>The version of extension specification (must be in dewey decimal aka dotted decimal
notation, eg <q>3.2.4</q>)</td>
<td>no</td>
</tr>
<tr>
<td>specificationVendor</td>
<td>The specification vendor</td>
<td>no</td>
</tr>
<tr>
<td>implementationVersion</td>
<td>The version of extension implementation (must be in dewey decimal aka dotted decimal
notation, eg <q>3.2.4</q>)</td>
<td>no</td>
</tr>
<tr>
<td>implementationVendor</td>
<td>The implementation vendor</td>
<td>no</td>
</tr>
<tr>
<td>implementationVendorId</td>
<td>The implementation vendor ID</td>
<td>no</td>
</tr>
<tr>
<td>implementationURL</td>
<td>The url from which to retrieve extension.</td>
<td>no</td>
</tr>
<tr>
<td>refid</td>
<td>Makes this <code>extension</code>
a <a href="../using.html#references">reference</a> to
an <code>extension</code> defined elsewhere. If specified no other
attributes or nested elements are allowed.</td>
<td>No</td>
</tr>
</table>
<h4>Examples</h4>
<pre>
&lt;extension id=&quot;e1&quot;
extensionName=&quot;MyExtensions&quot;
specificationVersion=&quot;1.0&quot;
specificationVendor=&quot;Peter Donald&quot;
implementationVendorID=&quot;vv&quot;
implementationVendor=&quot;Apache&quot;
implementationVersion=&quot;2.0&quot;
implementationURL=&quot;https://somewhere.com/myExt.jar&quot;/&gt;
</pre>
<p>Fully specified extension object.</p>
<pre>
&lt;extension id=&quot;e1&quot;
extensionName=&quot;MyExtensions&quot;
specificationVersion=&quot;1.0&quot;
specificationVendor=&quot;Peter Donald&quot;/&gt;
</pre>
<p>Extension object that just specifies the specification details.</p>
</body>
</html>