| <!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>ClassFileSet Type</title> |
| </head> |
| |
| <body> |
| <h2 id="fileset">ClassFileSet</h2> |
| <p>A classfileset is a specialized type of fileset which, given a set of "root" |
| classes, will include all of the class files upon which the root classes depend. This is |
| typically used to create a jar with all of the required classes for a particular application. |
| </p> |
| <p> |
| classfilesets are typically used by reference. They are declared with an <var>id</var> value and |
| this is then used as a reference where a normal fileset is expected. |
| </p> |
| <p> |
| This type requires |
| the <code>BCEL</code> <a href="../install.html#librarydependencies">library</a>. |
| </p> |
| |
| <h3>Attributes</h3> |
| <p> |
| The class fileset support the following attributes in addition to those supported by |
| the <a href="fileset.html">standard fileset</a>: |
| </p> |
| |
| <table class="attr"> |
| <tr> |
| <th scope="col">Attribute</th> |
| <th scope="col">Description</th> |
| <th scope="col">Required</th> |
| </tr> |
| <tr> |
| <td>rootclass</td> |
| <td>A single root class name</td> |
| <td>No</td> |
| </tr> |
| </table> |
| |
| <h3>Nested elements</h3> |
| |
| <h4>Root</h4> |
| <p> |
| When more than one root class is required, multiple nested <code><root></code> elements |
| may be used |
| </p> |
| <table class="attr"> |
| <tr> |
| <th scope="col">Attribute</th> |
| <th scope="col">Description</th> |
| <th scope="col">Required</th> |
| </tr> |
| <tr> |
| <td>classname</td> |
| <td>The fully qualified name of the root class</td> |
| <td>Yes</td> |
| </tr> |
| </table> |
| |
| <h4>RootFileSet</h4> |
| <p> |
| A root fileset is used to add a set of root classes from a fileset. In this case the entries in the |
| fileset are expected to be Java class files. The name of the Java class is determined by the |
| relative location of the classfile in the fileset. So, the |
| file <code>org/apache/tools/ant/Project.class</code> corresponds to the Java |
| class <code class="code">org.apache.tools.ant.Project</code>.</p> |
| |
| <h4>Examples</h4> |
| <pre> |
| <classfileset id="reqdClasses" dir="${classes.dir}"> |
| <root classname="org.apache.tools.ant.Project"/> |
| </classfileset></pre> |
| <p> |
| This example creates a fileset containing all the class files upon which |
| the <code class="code">org.apache.tools.ant.Project</code> class depends. This fileset could then be |
| used to create a jar. |
| </p> |
| |
| <pre> |
| <jar destfile="minimal.jar"> |
| <fileset refid="reqdClasses"/> |
| </jar></pre> |
| |
| <pre> |
| <classfileset id="reqdClasses" dir="${classes.dir}"> |
| <rootfileset dir="${classes.dir}" includes="org/apache/tools/ant/Project*.class"/> |
| </classfileset></pre> |
| <p> |
| This example constructs the classfileset using all the class with names starting |
| with <code class="code">Project</code> in the <code class="code">org.apache.tools.ant</code> |
| package. |
| </p> |
| |
| </body> |
| </html> |