From 49727a3da8d30bd6abcb219f140097f4a3b6fe95 Mon Sep 17 00:00:00 2001 From: Stefan Bodewig Date: Thu, 6 Apr 2006 18:27:32 +0000 Subject: [PATCH] allow ressource collections for source files in git-svn-id: https://svn.apache.org/repos/asf/ant/core/trunk@392027 13f79535-47bb-0310-9956-ffa450edef68 --- docs/manual/CoreTasks/javadoc.html | 10 ++- .../testcases/taskdefs/javadoc/javadoc.xml | 22 ++++++ .../apache/tools/ant/taskdefs/Javadoc.java | 68 +++++++++++++++---- .../tools/ant/taskdefs/JavadocTest.java | 12 ++++ 4 files changed, 96 insertions(+), 16 deletions(-) diff --git a/docs/manual/CoreTasks/javadoc.html b/docs/manual/CoreTasks/javadoc.html index 704a46494..5976e1dea 100644 --- a/docs/manual/CoreTasks/javadoc.html +++ b/docs/manual/CoreTasks/javadoc.html @@ -484,7 +484,7 @@ the nested <packageset> elements.

A FileSet. All matched files will be passed to javadoc as source files. Ant will automatically add the include pattern **/*.java (and -**/package.html if inncludenosourcepackages is true) to +**/package.html if includenosourcepackages is true) to these filesets.

Nested filesets can be used to document sources that are in the @@ -497,6 +497,14 @@ increases javadocs performance.

defaultexcludes attributes of the task have no effect on the nested <fileset> elements.

+

sourcefiles

+ +

A container for arbitrary file system based resource +collections. All files contained in any of the nested collections +(this includes nested filesets, filelists or paths) will be passed to +javadoc as source files.

+

package

Same as one entry in the list given by packagenames.

diff --git a/src/etc/testcases/taskdefs/javadoc/javadoc.xml b/src/etc/testcases/taskdefs/javadoc/javadoc.xml index 44bb02ec6..7fb367be8 100755 --- a/src/etc/testcases/taskdefs/javadoc/javadoc.xml +++ b/src/etc/testcases/taskdefs/javadoc/javadoc.xml @@ -56,6 +56,28 @@ + + + + + + + + + + + + + + + + + + + + + + diff --git a/src/main/org/apache/tools/ant/taskdefs/Javadoc.java b/src/main/org/apache/tools/ant/taskdefs/Javadoc.java index a878b3bbd..9d9ba787b 100644 --- a/src/main/org/apache/tools/ant/taskdefs/Javadoc.java +++ b/src/main/org/apache/tools/ant/taskdefs/Javadoc.java @@ -25,7 +25,9 @@ import java.io.BufferedReader; import java.io.FileReader; import java.net.MalformedURLException; import java.net.URL; +import java.util.ArrayList; import java.util.Enumeration; +import java.util.Iterator; import java.util.Locale; import java.util.StringTokenizer; import java.util.Vector; @@ -41,6 +43,8 @@ import org.apache.tools.ant.types.FileSet; import org.apache.tools.ant.types.Path; import org.apache.tools.ant.types.PatternSet; import org.apache.tools.ant.types.Reference; +import org.apache.tools.ant.types.ResourceCollection; +import org.apache.tools.ant.types.resources.FileResource; import org.apache.tools.ant.util.FileUtils; import org.apache.tools.ant.util.JavaEnvUtils; @@ -344,6 +348,23 @@ public class Javadoc extends Task { } } + /** + * Holds a collection of ResourceCollections. + * + *

A separate kind of container is needed since this task + * contains special handling for FileSets that has to occur at + * task runtime.

+ */ + public class ResourceCollectionContainer { + private ArrayList rcs = new ArrayList(); + public void add(ResourceCollection rc) { + rcs.add(rc); + } + private Iterator iterator() { + return rcs.iterator(); + } + } + private static final FileUtils FILE_UTILS = FileUtils.getFileUtils(); /** The command line built to execute Javadoc. */ @@ -412,7 +433,8 @@ public class Javadoc extends Task { private boolean old = false; private String executable = null; - private Vector fileSets = new Vector(); + private ResourceCollectionContainer nestedSourceFiles + = new ResourceCollectionContainer(); private Vector packageSets = new Vector(); /** @@ -1514,7 +1536,17 @@ public class Javadoc extends Task { * @since 1.5 */ public void addFileset(FileSet fs) { - fileSets.addElement(fs); + createSourceFiles().add(fs); + } + + /** + * Adds a container for resource collections. + * + *

All included files will be added as sourcefiles.

+ * @since 1.7 + */ + public ResourceCollectionContainer createSourceFiles() { + return nestedSourceFiles; } /** @@ -1594,7 +1626,7 @@ public class Javadoc extends Task { } Vector sourceFilesToDoc = (Vector) sourceFiles.clone(); - addFileSets(sourceFilesToDoc); + addSourceFiles(sourceFilesToDoc); if (packageList == null && packagesToDoc.size() == 0 && sourceFilesToDoc.size() == 0) { @@ -2036,15 +2068,21 @@ public class Javadoc extends Task { } /** - * Add the files matched by the nested filesets to the Vector as - * SourceFile instances. + * Add the files matched by the nested source files to the Vector + * as SourceFile instances. * - * @since 1.5 + * @since 1.7 */ - private void addFileSets(Vector sf) { - Enumeration e = fileSets.elements(); - while (e.hasMoreElements()) { - FileSet fs = (FileSet) e.nextElement(); + private void addSourceFiles(Vector sf) { + Iterator e = nestedSourceFiles.iterator(); + while (e.hasNext()) { + ResourceCollection rc = (ResourceCollection) e.next(); + if (!rc.isFilesystemOnly()) { + throw new BuildException("only file system based resources are" + + " supported by javadoc"); + } + if (rc instanceof FileSet) { + FileSet fs = (FileSet) rc; if (!fs.hasPatterns() && !fs.hasSelectors()) { fs = (FileSet) fs.clone(); fs.createInclude().setName("**/*.java"); @@ -2052,11 +2090,11 @@ public class Javadoc extends Task { fs.createInclude().setName("**/package.html"); } } - File baseDir = fs.getDir(getProject()); - DirectoryScanner ds = fs.getDirectoryScanner(getProject()); - String[] files = ds.getIncludedFiles(); - for (int i = 0; i < files.length; i++) { - sf.addElement(new SourceFile(new File(baseDir, files[i]))); + } + Iterator iter = rc.iterator(); + while (iter.hasNext()) { + sf.addElement(new SourceFile(((FileResource) iter.next()) + .getFile())); } } } diff --git a/src/testcases/org/apache/tools/ant/taskdefs/JavadocTest.java b/src/testcases/org/apache/tools/ant/taskdefs/JavadocTest.java index 2856894aa..c0bb5b675 100755 --- a/src/testcases/org/apache/tools/ant/taskdefs/JavadocTest.java +++ b/src/testcases/org/apache/tools/ant/taskdefs/JavadocTest.java @@ -118,4 +118,16 @@ public class JavadocTest extends BuildFileTest { public void testNestedFilesetRefInPath() throws Exception { executeTarget("nestedFilesetRefInPath"); } + + public void testNestedFilesetNoPatterns() throws Exception { + executeTarget("nestedFilesetNoPatterns"); + } + + public void testDoublyNestedFileset() throws Exception { + executeTarget("doublyNestedFileset"); + } + + public void testDoublyNestedFilesetNoPatterns() throws Exception { + executeTarget("doublyNestedFilesetNoPatterns"); + } }