org.schmant.task.template.jdk.javadoc
Class AbstractJavadocTaskFactory<T extends AbstractJavadocTaskFactory<T,U>,U extends AbstractJavadocTask<U>>

java.lang.Object
  org.schmant.task.stub.AbstractTaskFactory<T,U>
      org.schmant.task.stub.AbstractActionTaskFactory<T,U>
          org.schmant.task.template.jdk.javadoc.AbstractJavadocTaskFactory<T,U>

All Implemented Interfaces:

ActionTaskConfigurable<T>, ActionTaskFactory<T,U>, ClasspathConfigurable<T>, LoggingConfigurable<T>, SourceConfigurable<T>, TaskDecoratorConfigurable<T,JavadocTaskDecorator>, TaskFactory<T,U>, TaskRunnable, JavadocTaskConfigurable<T>

Direct Known Subclasses:

ExtJavadocTF

public abstract class AbstractJavadocTaskFactory<T extends AbstractJavadocTaskFactory<T,U>,U extends AbstractJavadocTask<U>>
extends AbstractActionTaskFactory<T,U>
implements JavadocTaskConfigurable<T>

Abstract base class for Javadoc task factories.

Since:

0.5

Author:

Karl Gustafsson

Constructor Summary

AbstractJavadocTaskFactory()

Method Summary

T	addClasspathDecorator(PathDecorator<?,?> cd) Add one path decorator.
T	addClasspathDecorators(Object o) Add one or several path decorators.
T	addClasspathEntries(Object o) This method does the same as ClasspathConfigurable.addClasspathEntry(Object).
T	addClasspathEntry(Object o) Add one or several classpath entries to the classpath.
T	addDecorator(JavadocTaskDecorator d) Add one task decorator.
T	addDecorators(Object o) Add one or several task decorators.
T	addExcludePackage(String p)
T	addExcludePackages(Object o) Add one or several exclude packages.
T	addExtDirectories(Object o) Add one or several ext directories.
T	addExtDirectory(Object o) Add one or several ext directories.
T	addPackageName(String s)
T	addPackageNames(Object o) Add one or several package names.
T	addSourceFileName(String name)
T	addSourceFileNames(Object o) Add one or several source file names.
T	clearClasspathDecorators() Clear the list of classpath decorators.
T	clearClasspathEntries() Clear the list of classpath entries.
T	clearDecorators() Clear the list of decorators.
T	clearExcludePackages()
T	clearExtDirectories()
T	clearPackageNames()
T	clearSourceFileNames()
T	setBreakIterator(boolean b)
T	setEncoding(String name)
T	setLocale(String name)
T	setOverview(Object o)
T	setSourceCodeVersion(String s)
T	setSubPackages(boolean b)
T	setVisibilityLevel(JavadocVisibilityLevel l)

Methods inherited from class org.schmant.task.stub.AbstractActionTaskFactory

addSource, addSources, clearSources, setRelativeToBase, setSource, setSources

Methods inherited from class org.schmant.task.stub.AbstractTaskFactory

copy, create, createSpecification, getLastCreated, getSpecification, getThis, run, setLogFooter, setLogHeader, setReportLevel, setTraceLogging, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.schmant.task.template.jdk.javadoc.JavadocTaskConfigurable

addTag, addTag, addTaglet, addTagletPath, addTagletPaths, addTaglets, addTags, clearTagletPaths, clearTaglets, clearTags

Methods inherited from interface org.schmant.task.confable.SourceConfigurable

addSource, addSources, clearSources, setRelativeToBase, setSource, setSources

Methods inherited from interface org.schmant.task.TaskFactory

copy, create, getLastCreated, getSpecification

Methods inherited from interface org.schmant.task.confable.LoggingConfigurable

setLogFooter, setLogHeader, setReportLevel, setTraceLogging

Methods inherited from interface org.schmant.task.TaskRunnable

run

Constructor Detail

AbstractJavadocTaskFactory

public AbstractJavadocTaskFactory()

Method Detail

addPackageName

public final T addPackageName(String s)

Specified by:

addPackageName in interface JavadocTaskConfigurable<T extends AbstractJavadocTaskFactory<T,U>>

addPackageNames

public final T addPackageNames(Object o)

Description copied from interface: JavadocTaskConfigurable

Add one or several package names.

Specified by:

addPackageNames in interface JavadocTaskConfigurable<T extends AbstractJavadocTaskFactory<T,U>>

Parameters:

o - One string or an array or collection of strings.

clearPackageNames

public final T clearPackageNames()

Specified by:

clearPackageNames in interface JavadocTaskConfigurable<T extends AbstractJavadocTaskFactory<T,U>>

setSubPackages

public final T setSubPackages(boolean b)

Specified by:

setSubPackages in interface JavadocTaskConfigurable<T extends AbstractJavadocTaskFactory<T,U>>

addSourceFileName

public final T addSourceFileName(String name)

Specified by:

addSourceFileName in interface JavadocTaskConfigurable<T extends AbstractJavadocTaskFactory<T,U>>

addSourceFileNames

public final T addSourceFileNames(Object o)

Description copied from interface: JavadocTaskConfigurable

Add one or several source file names.

Specified by:

addSourceFileNames in interface JavadocTaskConfigurable<T extends AbstractJavadocTaskFactory<T,U>>

Parameters:

o - One string or an array or collection of strings.

clearSourceFileNames

public final T clearSourceFileNames()

Specified by:

clearSourceFileNames in interface JavadocTaskConfigurable<T extends AbstractJavadocTaskFactory<T,U>>

addClasspathEntry

public final T addClasspathEntry(Object o)

Description copied from interface: ClasspathConfigurable

Add one or several classpath entries to the classpath.

Specified by:

addClasspathEntry in interface ClasspathConfigurable<T extends AbstractJavadocTaskFactory<T,U>>

Parameters:

o - The entry or entries. If the object is a collection or array, it is flattened (see FlatteningList). It is up to the implementing object to decide how the object or objects should be interpreted.

Returns:

this

addClasspathEntries

public T addClasspathEntries(Object o)

Description copied from interface: ClasspathConfigurable

This method does the same as ClasspathConfigurable.addClasspathEntry(Object).

Specified by:

addClasspathEntries in interface ClasspathConfigurable<T extends AbstractJavadocTaskFactory<T,U>>

Parameters:

o - The entries. See ClasspathConfigurable.addClasspathEntry(Object).

Returns:

this

clearClasspathEntries

public T clearClasspathEntries()

Description copied from interface: ClasspathConfigurable

Clear the list of classpath entries.

Specified by:

clearClasspathEntries in interface ClasspathConfigurable<T extends AbstractJavadocTaskFactory<T,U>>

Returns:

this.

addClasspathDecorator

public final T addClasspathDecorator(PathDecorator<?,?> cd)

Description copied from interface: ClasspathConfigurable

Add one path decorator.

Specified by:

addClasspathDecorator in interface ClasspathConfigurable<T extends AbstractJavadocTaskFactory<T,U>>

Returns:

this

addClasspathDecorators

public final T addClasspathDecorators(Object o)

Description copied from interface: ClasspathConfigurable

Add one or several path decorators.

Specified by:

addClasspathDecorators in interface ClasspathConfigurable<T extends AbstractJavadocTaskFactory<T,U>>

Parameters:

o - One or an array or collection of classpath decorators (PathDecorator objects).

Returns:

this

clearClasspathDecorators

public final T clearClasspathDecorators()

Description copied from interface: ClasspathConfigurable

Clear the list of classpath decorators.

Specified by:

clearClasspathDecorators in interface ClasspathConfigurable<T extends AbstractJavadocTaskFactory<T,U>>

Returns:

this

setOverview

public final T setOverview(Object o)

Specified by:

setOverview in interface JavadocTaskConfigurable<T extends AbstractJavadocTaskFactory<T,U>>

setVisibilityLevel

public final T setVisibilityLevel(JavadocVisibilityLevel l)

Specified by:

setVisibilityLevel in interface JavadocTaskConfigurable<T extends AbstractJavadocTaskFactory<T,U>>

setSourceCodeVersion

public final T setSourceCodeVersion(String s)

Specified by:

setSourceCodeVersion in interface JavadocTaskConfigurable<T extends AbstractJavadocTaskFactory<T,U>>

addExcludePackage

public final T addExcludePackage(String p)

Specified by:

addExcludePackage in interface JavadocTaskConfigurable<T extends AbstractJavadocTaskFactory<T,U>>

addExcludePackages

public final T addExcludePackages(Object o)

Description copied from interface: JavadocTaskConfigurable

Add one or several exclude packages.

Specified by:

addExcludePackages in interface JavadocTaskConfigurable<T extends AbstractJavadocTaskFactory<T,U>>

Parameters:

o - One package name or an array or collection of package names (strings).

clearExcludePackages

public final T clearExcludePackages()

Specified by:

clearExcludePackages in interface JavadocTaskConfigurable<T extends AbstractJavadocTaskFactory<T,U>>

addExtDirectory

public final T addExtDirectory(Object o)

Description copied from interface: JavadocTaskConfigurable

Add one or several ext directories.

Specified by:

addExtDirectory in interface JavadocTaskConfigurable<T extends AbstractJavadocTaskFactory<T,U>>

Parameters:

o - One directory or an array or collection of directories. This argument is interpreted. See the task reference documentation.

addExtDirectories

public final T addExtDirectories(Object o)

Description copied from interface: JavadocTaskConfigurable

Add one or several ext directories.

Specified by:

addExtDirectories in interface JavadocTaskConfigurable<T extends AbstractJavadocTaskFactory<T,U>>

Parameters:

o - One directory or an array or collection of directories. This argument is interpreted. See the task reference documentation.

clearExtDirectories

public final T clearExtDirectories()

Specified by:

clearExtDirectories in interface JavadocTaskConfigurable<T extends AbstractJavadocTaskFactory<T,U>>

setBreakIterator

public final T setBreakIterator(boolean b)

Specified by:

setBreakIterator in interface JavadocTaskConfigurable<T extends AbstractJavadocTaskFactory<T,U>>

setLocale

public final T setLocale(String name)

Specified by:

setLocale in interface JavadocTaskConfigurable<T extends AbstractJavadocTaskFactory<T,U>>

setEncoding

public final T setEncoding(String name)

Specified by:

setEncoding in interface JavadocTaskConfigurable<T extends AbstractJavadocTaskFactory<T,U>>

addDecorator

public final T addDecorator(JavadocTaskDecorator d)

Description copied from interface: TaskDecoratorConfigurable

Add one task decorator.

Specified by:

addDecorator in interface TaskDecoratorConfigurable<T extends AbstractJavadocTaskFactory<T,U>,JavadocTaskDecorator>

Parameters:

d - The task decorator

Returns:

this

addDecorators

public final T addDecorators(Object o)

Description copied from interface: TaskDecoratorConfigurable

Add one or several task decorators.

Specified by:

addDecorators in interface TaskDecoratorConfigurable<T extends AbstractJavadocTaskFactory<T,U>,JavadocTaskDecorator>

Parameters:

o - One decorator or an array or collection of decorators.

Returns:

this

clearDecorators

public final T clearDecorators()

Description copied from interface: TaskDecoratorConfigurable

Clear the list of decorators.

Specified by:

clearDecorators in interface TaskDecoratorConfigurable<T extends AbstractJavadocTaskFactory<T,U>,JavadocTaskDecorator>

Returns:

this