From e7f19f65dbe6e8a0fabe514d45b1521fe1b22509 Mon Sep 17 00:00:00 2001 From: Conor MacNeill Date: Thu, 4 Apr 2002 12:58:23 +0000 Subject: [PATCH] Document the optional data type git-svn-id: https://svn.apache.org/repos/asf/ant/core/trunk@272213 13f79535-47bb-0310-9956-ffa450edef68 --- docs/manual/OptionalTypes/classfileset.html | 87 +++++++++++++++++++++ docs/manual/conceptstypeslist.html | 7 +- docs/manual/install.html | 6 +- 3 files changed, 97 insertions(+), 3 deletions(-) create mode 100644 docs/manual/OptionalTypes/classfileset.html diff --git a/docs/manual/OptionalTypes/classfileset.html b/docs/manual/OptionalTypes/classfileset.html new file mode 100644 index 000000000..caaca1400 --- /dev/null +++ b/docs/manual/OptionalTypes/classfileset.html @@ -0,0 +1,87 @@ + + + +ClassFileSet Type + + + +

ClassFileSet

+

A classfileset is a specialised 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. +

+

+classfilesets are typically used by reference. They are declared with an +"id" value and this is then used as a reference where a normal fileset +is expected. +

+

+This type requires the jakarta-BCEL library. +

+ + +

Attributes

+

The class fileset support the following attributes in addition +to those supported by the +standard fileset: +

+ + + + + + + + + + + + +
AttributeDescriptionRequired
rootclassA single root class nameNo
+ +

Nested Elements

+ +

Root

+

+When more than one root class is required, multiple nested <root> elements +may be used +

+ + + + + + + + + + + +
AttributeDescriptionRequired
classnameThe fully qualified name of the root classYes
+ +

Examples

+
+<classfileset id="reqdClasses" dir="${classes.dir}">
+  <root classname="org.apache.tools.ant.Project" />
+</classfileset>
+
+ +

This example creates a fileset containing all the class files upon which the +org.apache.tools.ant.Project class depends. This fileset could +then be used to create a jar. +

+ +
+<jar destfile="minimal.jar" >
+  <fileset refid="reqdClasses"/>
+</jar>
+
+ +
+

Copyright © 2001 Apache Software Foundation. All rights +Reserved.

+ + + + diff --git a/docs/manual/conceptstypeslist.html b/docs/manual/conceptstypeslist.html index 9c30f22d9..8a056b91a 100644 --- a/docs/manual/conceptstypeslist.html +++ b/docs/manual/conceptstypeslist.html @@ -10,9 +10,11 @@

Table of Contents

-

Concepts and Types

+

Concepts

build.sysclasspath
Common Attributes
+ +

Core Types

Description Type
Directory-based Tasks
DirSet
@@ -23,5 +25,8 @@ FilterSet
PatternSet
XMLCatalog
+ +

Optional Types

+Class Fileset
diff --git a/docs/manual/install.html b/docs/manual/install.html index 3cb8ff92d..0669388e8 100644 --- a/docs/manual/install.html +++ b/docs/manual/install.html @@ -342,8 +342,10 @@ Installing Ant / Optional Tasks section above.

bcel.jar - classfileset data type and JavaClassHelper used by the ClassConstants - filter reader. + classfileset data type, + JavaClassHelper used by the ClassConstants filter reader and + optionally used by ejbjar for dependency determination + jakarta.apache.org/bcel/