|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--org.apache.tools.ant.ProjectComponent | +--org.apache.tools.ant.Task | +--attrib4j.ant.Attrib4jTask
Nested Class Summary | |
static class |
Attrib4jTask.PackageName
Used to track info about the packages to be javadoc'd |
static class |
Attrib4jTask.SourceFile
This class is used to manage the source files to be processed. |
Field Summary |
Fields inherited from class org.apache.tools.ant.Task |
description, location, target, taskName, taskType, wrapper |
Fields inherited from class org.apache.tools.ant.ProjectComponent |
project |
Constructor Summary | |
Attrib4jTask()
|
Method Summary | |
void |
addExcludePackage(Attrib4jTask.PackageName pn)
Add a package to be excluded from the javadoc run. |
void |
addFileset(org.apache.tools.ant.types.FileSet fs)
Adds a fileset. |
void |
addPackage(Attrib4jTask.PackageName pn)
Add a single package to be processed. |
void |
addSource(Attrib4jTask.SourceFile sf)
Add a single source file. |
org.apache.tools.ant.types.Path |
createClasspath()
Create a Path to be configured with the classpath to use |
org.apache.tools.ant.types.Path |
createSourcepath()
Create a path to be configured with the locations of the source files. |
void |
execute()
|
void |
setAttributePackages(java.lang.String packages)
|
void |
setClasspath(org.apache.tools.ant.types.Path path)
Set the classpath to be used for this javadoc run. |
void |
setClasspathRef(org.apache.tools.ant.types.Reference r)
Adds a reference to a CLASSPATH defined elsewhere. |
void |
setDestdir(java.io.File dir)
Set the directory where the Javadoc output will be generated. |
void |
setDocletPath(org.apache.tools.ant.types.Path docletPath)
Set the classpath used to find the doclet class. |
void |
setExcludePackageNames(java.lang.String packages)
Set the list of packages to be excluded. |
void |
setLoglevel(java.lang.String level)
|
void |
setMaxmemory(java.lang.String max)
Set the maximum memory to be used by the javadoc process |
void |
setPackagenames(java.lang.String packages)
Set the package names to be processed. |
void |
setSourcefiles(java.lang.String src)
Set the list of source files to process. |
void |
setSourcepath(org.apache.tools.ant.types.Path src)
Specify where to find source file |
void |
setSourcepathRef(org.apache.tools.ant.types.Reference r)
Adds a reference to a CLASSPATH defined elsewhere. |
void |
setUseExternalFile(boolean b)
Work around command line length limit by using an external file for the sourcefiles. |
Methods inherited from class org.apache.tools.ant.Task |
getDescription, getLocation, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, handleErrorOutput, handleOutput, init, isInvalid, log, log, maybeConfigure, perform, setDescription, setLocation, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName |
Methods inherited from class org.apache.tools.ant.ProjectComponent |
getProject, setProject |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
public Attrib4jTask()
Method Detail |
public void setUseExternalFile(boolean b)
b
- true if an external file is to be used.public void setMaxmemory(java.lang.String max)
max
- a string indicating the maximum memory according to the
JVM conventions (e.g. 128m is 128 Megabytes)public void setSourcepath(org.apache.tools.ant.types.Path src)
src
- a Path instance containing the various source directories.public void setAttributePackages(java.lang.String packages)
public void setLoglevel(java.lang.String level)
public org.apache.tools.ant.types.Path createSourcepath()
public void setSourcepathRef(org.apache.tools.ant.types.Reference r)
r
- the reference containing the source path definition.public void setDestdir(java.io.File dir)
dir
- the destination directory.public void setSourcefiles(java.lang.String src)
src
- a comma separated list of source files.public void addSource(Attrib4jTask.SourceFile sf)
sf
- the source file to be processed.public void setPackagenames(java.lang.String packages)
packages
- a comma separated list of packages specs
(may be wildcarded).for wildcard information.
public void addPackage(Attrib4jTask.PackageName pn)
pn
- the package name, possibly wildcarded.public void setExcludePackageNames(java.lang.String packages)
packages
- a comma separated list of packages to be excluded.
This may not include wildcards.public void addExcludePackage(Attrib4jTask.PackageName pn)
pn
- the name of the package (wildcards are not permitted).public void addFileset(org.apache.tools.ant.types.FileSet fs)
All included files will be added as sourcefiles. The task
will automatically add
includes="**/*.java"
to the
fileset.
public void setClasspath(org.apache.tools.ant.types.Path path)
path
- an Ant Path object containing the compilation
classpath.public org.apache.tools.ant.types.Path createClasspath()
public void setClasspathRef(org.apache.tools.ant.types.Reference r)
r
- the reference to an instance defining the classpath.public void setDocletPath(org.apache.tools.ant.types.Path docletPath)
docletPath
- the doclet classpath.public void execute() throws org.apache.tools.ant.BuildException
execute
in class org.apache.tools.ant.Task
org.apache.tools.ant.BuildException
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |