Attrib4jTask (Attributes in Java 0.8.9 API)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

attrib4j.ant
Class Attrib4jTask

java.lang.Object
  |
  +--org.apache.tools.ant.ProjectComponent
        |
        +--org.apache.tools.ant.Task
              |
              +--attrib4j.ant.Attrib4jTask

public class Attrib4jTask
extends org.apache.tools.ant.Task

A custom Ant task to run Attrib4 that supports the following syntax. It also is a helper class to the Attrib4jCompilerAdapter It will eventually support running both the Sun JDK javadoc engine and alternative javadoc engines. Now heavily influenced from the Ant javadoc task.

Author:: Mark.Pollack

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.

java.lang.String setupAttrib4j(org.apache.tools.ant.taskdefs.Javac javac)


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

Attrib4jTask

public Attrib4jTask()

Method Detail

setUseExternalFile

public void setUseExternalFile(boolean b)

Work around command line length limit by using an external file for the sourcefiles.

Parameters:: b - true if an external file is to be used.

setMaxmemory

public void setMaxmemory(java.lang.String max)

Set the maximum memory to be used by the javadoc process

Parameters:: max - a string indicating the maximum memory according to the JVM conventions (e.g. 128m is 128 Megabytes)

setSourcepath

public void setSourcepath(org.apache.tools.ant.types.Path src)

Specify where to find source file

Parameters:: src - a Path instance containing the various source directories.

setAttributePackages

public void setAttributePackages(java.lang.String packages)

setLoglevel

public void setLoglevel(java.lang.String level)

createSourcepath

public org.apache.tools.ant.types.Path createSourcepath()

Create a path to be configured with the locations of the source files.

Returns:: a new Path instance to be configured by the Ant core.

setSourcepathRef

public void setSourcepathRef(org.apache.tools.ant.types.Reference r)

Adds a reference to a CLASSPATH defined elsewhere.

Parameters:: r - the reference containing the source path definition.

setDestdir

public void setDestdir(java.io.File dir)

Set the directory where the Javadoc output will be generated.

Parameters:: dir - the destination directory.

setSourcefiles

public void setSourcefiles(java.lang.String src)

Set the list of source files to process.

Parameters:: src - a comma separated list of source files.

addSource

public void addSource(Attrib4jTask.SourceFile sf)

Add a single source file.

Parameters:: sf - the source file to be processed.

setPackagenames

public void setPackagenames(java.lang.String packages)

Set the package names to be processed.

Parameters:: packages - a comma separated list of packages specs (may be wildcarded).
See Also:: for wildcard information.

addPackage

public void addPackage(Attrib4jTask.PackageName pn)

Add a single package to be processed. If the package name ends with ".*" the Javadoc task will find and process all subpackages.

Parameters:: pn - the package name, possibly wildcarded.

setExcludePackageNames

public void setExcludePackageNames(java.lang.String packages)

Set the list of packages to be excluded.

Parameters:: packages - a comma separated list of packages to be excluded. This may not include wildcards.

addExcludePackage

public void addExcludePackage(Attrib4jTask.PackageName pn)

Add a package to be excluded from the javadoc run.

Parameters:: pn - the name of the package (wildcards are not permitted).

addFileset

public void addFileset(org.apache.tools.ant.types.FileSet fs)

Adds a fileset.

All included files will be added as sourcefiles. The task will automatically add includes="**/*.java" to the fileset.

Since:: 1.5

setClasspath

public void setClasspath(org.apache.tools.ant.types.Path path)

Set the classpath to be used for this javadoc run.

Parameters:: path - an Ant Path object containing the compilation classpath.

createClasspath

public org.apache.tools.ant.types.Path createClasspath()

Create a Path to be configured with the classpath to use

Returns:: a new Path instance to be configured with the classpath.

setClasspathRef

public void setClasspathRef(org.apache.tools.ant.types.Reference r)