org.schmant.task.jdk.javadoc.ext
Class ExtJavadocTF

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

All Implemented Interfaces:

ActionTaskConfigurable<ExtJavadocTF>, ActionTaskFactory<ExtJavadocTF,ExtJavadocTask>, ArgumentsConfigurable<ExtJavadocTF>, BootClasspathConfigurable<ExtJavadocTF>, ClasspathConfigurable<ExtJavadocTF>, LoggingConfigurable<ExtJavadocTF>, SourceConfigurable<ExtJavadocTF>, TaskDecoratorConfigurable<ExtJavadocTF,JavadocTaskDecorator>, TaskFactory<ExtJavadocTF,ExtJavadocTask>, TaskRunnable, JvmConfigurable<ExtJavadocTF>, JvmOptionsConfigurable<ExtJavadocTF>, JavadocTaskConfigurable<ExtJavadocTF>, JavaHomeConfigurable<ExtJavadocTF>, ExtProcessConfigurable<ExtJavadocTF>

public final class ExtJavadocTF
extends AbstractJavadocTaskFactory<ExtJavadocTF,ExtJavadocTask>
implements JavaHomeConfigurable<ExtJavadocTF>, ExtProcessConfigurable<ExtJavadocTF>, BootClasspathConfigurable<ExtJavadocTF>, JvmConfigurable<ExtJavadocTF>

Factory for the ExtJavadocTask.

See ExtJavadocTF

Since:

0.5

Author:

Karl Gustafsson

See Also:

ExtJavadocTask

Task_package:

org.schmant.task.base

Constructor Summary

ExtJavadocTF()

Method Summary

ExtJavadocTF	addArgument(String s) Add one argument.
ExtJavadocTF	addArguments(Object o) Add one or several arguments.
ExtJavadocTF	addBootClasspathEntries(Object o) This method does the same as BootClasspathConfigurable.addBootClasspathEntry(Object).
ExtJavadocTF	addBootClasspathEntry(Object o) Add one or several entries to the boot classpath.
ExtJavadocTF	addEnvironmentVariable(String name, String value)
ExtJavadocTF	addEnvironmentVariables(Object o) Add one or several environment variables.
ExtJavadocTF	addJvmOption(String s)
ExtJavadocTF	addJvmOptions(Object o) Add one or several JVM options.
ExtJavadocTF	addTag(JavadocTagDefinition t) Corresponds to the -tag parameter.
ExtJavadocTF	addTag(String s) Corresponds to the -tag parameter.
ExtJavadocTF	addTaglet(String fqn) Corresponds to the -taglet parameter.
ExtJavadocTF	addTagletPath(Object o) Add one or several taglet paths.
ExtJavadocTF	addTagletPaths(Object o) This method does the same as JavadocTaskConfigurable.addTagletPath(Object).
ExtJavadocTF	addTaglets(Object o) Add a collection of taglets.
ExtJavadocTF	addTags(Object o) Add one or several custom tags.
ExtJavadocTF	clearArguments() Clear the list of arguments.
ExtJavadocTF	clearBootClasspathEntries()
ExtJavadocTF	clearEnvironmentVariables()
ExtJavadocTF	clearJvmOptions()
ExtJavadocTF	clearTagletPaths()
ExtJavadocTF	clearTaglets()
ExtJavadocTF	clearTags()
protected ExtJavadocTask	createSpecification() Subclasses implement this to create the task specification object that this factory uses to configure the task that it is creating.
ExtJavadocTF	setFailOnErrors(boolean b)
ExtJavadocTF	setInheritEnvironmentVariables(boolean b)
ExtJavadocTF	setJavadocExecutable(Object o)
ExtJavadocTF	setJavaHome(Object o)
ExtJavadocTF	setQuiet(boolean b)
ExtJavadocTF	setStderrStrategy(ProcessOutputStrategy pos)
ExtJavadocTF	setStdoutStrategy(ProcessOutputStrategy pos)
ExtJavadocTF	setVerbose(boolean b)
ExtJavadocTF	setWorkingDirectory(Object o)

Methods inherited from class org.schmant.task.template.jdk.javadoc.AbstractJavadocTaskFactory

addClasspathDecorator, addClasspathDecorators, addClasspathEntries, addClasspathEntry, addDecorator, addDecorators, addExcludePackage, addExcludePackages, addExtDirectories, addExtDirectory, addPackageName, addPackageNames, addSourceFileName, addSourceFileNames, clearClasspathDecorators, clearClasspathEntries, clearDecorators, clearExcludePackages, clearExtDirectories, clearPackageNames, clearSourceFileNames, setBreakIterator, setEncoding, setLocale, setOverview, setSourceCodeVersion, setSubPackages, setVisibilityLevel

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, 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.confable.ClasspathConfigurable

addClasspathDecorator, addClasspathDecorators, addClasspathEntries, addClasspathEntry, clearClasspathDecorators, clearClasspathEntries

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

ExtJavadocTF

public ExtJavadocTF()

Method Detail

addTag

public ExtJavadocTF addTag(String s)

Description copied from interface: JavadocTaskConfigurable

Corresponds to the -tag parameter.

Add one custom tag.

Specified by:

addTag in interface JavadocTaskConfigurable<ExtJavadocTF>

Parameters:

s - The tag definition on String format.

Returns:

this

addTag

public ExtJavadocTF addTag(JavadocTagDefinition t)

Description copied from interface: JavadocTaskConfigurable

Corresponds to the -tag parameter.

Add one custom tag.

Specified by:

addTag in interface JavadocTaskConfigurable<ExtJavadocTF>

Parameters:

t - The tag definition represented as a JavadocTagDefinition object.

Returns:

this

addTags

public ExtJavadocTF addTags(Object o)

Description copied from interface: JavadocTaskConfigurable

Add one or several custom tags.

Corresponds to giving the -tag parameter for each added tag.

Specified by:

addTags in interface JavadocTaskConfigurable<ExtJavadocTF>

Parameters:

o - One or an array or collection of JavadocTagDefinition objects.

Returns:

this

clearTags

public ExtJavadocTF clearTags()

Specified by:

clearTags in interface JavadocTaskConfigurable<ExtJavadocTF>

addTaglet

public ExtJavadocTF addTaglet(String fqn)

Description copied from interface: JavadocTaskConfigurable

Corresponds to the -taglet parameter.

Specified by:

addTaglet in interface JavadocTaskConfigurable<ExtJavadocTF>

Parameters:

fqn - The fully qualified name of a taglet class.

Returns:

this

addTaglets

public ExtJavadocTF addTaglets(Object o)

Description copied from interface: JavadocTaskConfigurable

Add a collection of taglets.

Corresponds to giving the -taglet parameter for each added object.

Specified by:

addTaglets in interface JavadocTaskConfigurable<ExtJavadocTF>

Parameters:

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

Returns:

this

clearTaglets

public ExtJavadocTF clearTaglets()

Specified by:

clearTaglets in interface JavadocTaskConfigurable<ExtJavadocTF>

addTagletPath

public ExtJavadocTF addTagletPath(Object o)

Description copied from interface: JavadocTaskConfigurable

Add one or several taglet paths. This corresponds to the -tagletpath parameter. The path is interpreted by InterpretAsFileStrategy.

Specified by:

addTagletPath in interface JavadocTaskConfigurable<ExtJavadocTF>

Parameters:

o - The path to a taglet class directory. If this is a Collection or an array, it is flattened (see FlatteningList).

Returns:

this

addTagletPaths

public ExtJavadocTF addTagletPaths(Object o)

Description copied from interface: JavadocTaskConfigurable

This method does the same as JavadocTaskConfigurable.addTagletPath(Object).

Specified by:

addTagletPaths in interface JavadocTaskConfigurable<ExtJavadocTF>

Parameters:

o - A collection of paths. See JavadocTaskConfigurable.addTagletPath(Object).

Returns:

this

clearTagletPaths

public ExtJavadocTF clearTagletPaths()

Specified by:

clearTagletPaths in interface JavadocTaskConfigurable<ExtJavadocTF>

addJvmOption

public ExtJavadocTF addJvmOption(String s)

Specified by:

addJvmOption in interface JvmOptionsConfigurable<ExtJavadocTF>

addJvmOptions

public ExtJavadocTF addJvmOptions(Object o)

Description copied from interface: JvmOptionsConfigurable

Add one or several JVM options.

Specified by:

addJvmOptions in interface JvmOptionsConfigurable<ExtJavadocTF>

Parameters:

o - One string or an array or collection of strings. Each string is an JVM option.

clearJvmOptions

public ExtJavadocTF clearJvmOptions()

Specified by:

clearJvmOptions in interface JvmOptionsConfigurable<ExtJavadocTF>

setJavadocExecutable

public ExtJavadocTF setJavadocExecutable(Object o)
                                  throws FileNotFoundException

Throws:

FileNotFoundException

setJavaHome

public ExtJavadocTF setJavaHome(Object o)

Specified by:

setJavaHome in interface JavaHomeConfigurable<ExtJavadocTF>

setVerbose

public ExtJavadocTF setVerbose(boolean b)

setQuiet

public ExtJavadocTF setQuiet(boolean b)

addArgument

public ExtJavadocTF addArgument(String s)

Description copied from interface: ArgumentsConfigurable

Add one argument.

Specified by:

addArgument in interface ArgumentsConfigurable<ExtJavadocTF>

Parameters:

s - The argument.

Returns:

this

addArguments

public ExtJavadocTF addArguments(Object o)

Description copied from interface: ArgumentsConfigurable

Add one or several arguments.

Specified by:

addArguments in interface ArgumentsConfigurable<ExtJavadocTF>

Parameters:

o - An argument or an array or Collection of arguments. If this is an array or a collection, it is flattened as described in FlatteningList.

Returns:

this

clearArguments

public ExtJavadocTF clearArguments()

Description copied from interface: ArgumentsConfigurable

Clear the list of arguments.

Specified by:

clearArguments in interface ArgumentsConfigurable<ExtJavadocTF>

Returns:

this.

addEnvironmentVariable

public ExtJavadocTF addEnvironmentVariable(String name,
                                           String value)

Specified by:

addEnvironmentVariable in interface ExtProcessConfigurable<ExtJavadocTF>

addEnvironmentVariables

public ExtJavadocTF addEnvironmentVariables(Object o)

Description copied from interface: ExtProcessConfigurable

Add one or several environment variables.

Specified by:

addEnvironmentVariables in interface ExtProcessConfigurable<ExtJavadocTF>

Parameters:

o - A string or an array or collection of strings. The strings must have the format variable=value.

clearEnvironmentVariables

public ExtJavadocTF clearEnvironmentVariables()

Specified by:

clearEnvironmentVariables in interface ExtProcessConfigurable<ExtJavadocTF>

setInheritEnvironmentVariables

public ExtJavadocTF setInheritEnvironmentVariables(boolean b)

Specified by:

setInheritEnvironmentVariables in interface ExtProcessConfigurable<ExtJavadocTF>

setFailOnErrors

public ExtJavadocTF setFailOnErrors(boolean b)

Specified by:

setFailOnErrors in interface ExtProcessConfigurable<ExtJavadocTF>

setWorkingDirectory

public ExtJavadocTF setWorkingDirectory(Object o)

Specified by:

setWorkingDirectory in interface ExtProcessConfigurable<ExtJavadocTF>

setStdoutStrategy

public ExtJavadocTF setStdoutStrategy(ProcessOutputStrategy pos)

Specified by:

setStdoutStrategy in interface ExtProcessConfigurable<ExtJavadocTF>

setStderrStrategy

public ExtJavadocTF setStderrStrategy(ProcessOutputStrategy pos)

Specified by:

setStderrStrategy in interface ExtProcessConfigurable<ExtJavadocTF>

addBootClasspathEntry

public ExtJavadocTF addBootClasspathEntry(Object o)

Description copied from interface: BootClasspathConfigurable

Add one or several entries to the boot classpath.

Specified by:

addBootClasspathEntry in interface BootClasspathConfigurable<ExtJavadocTF>

Parameters:

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

Returns:

this

addBootClasspathEntries

public ExtJavadocTF addBootClasspathEntries(Object o)

Description copied from interface: BootClasspathConfigurable

This method does the same as BootClasspathConfigurable.addBootClasspathEntry(Object).

Specified by:

addBootClasspathEntries in interface BootClasspathConfigurable<ExtJavadocTF>

Parameters:

o - The boot classpath entry or entries. See BootClasspathConfigurable.addBootClasspathEntry(Object).

Returns:

this

clearBootClasspathEntries

public ExtJavadocTF clearBootClasspathEntries()

Specified by:

clearBootClasspathEntries in interface BootClasspathConfigurable<ExtJavadocTF>

createSpecification

protected ExtJavadocTask createSpecification()

Description copied from class: AbstractTaskFactory

Subclasses implement this to create the task specification object that this factory uses to configure the task that it is creating.

Specified by:

createSpecification in class AbstractTaskFactory<ExtJavadocTF,ExtJavadocTask>