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

java.lang.Object
  org.schmant.support.AbstractArgumentChecker
      org.schmant.task.stub.AbstractTask<T>
          org.schmant.task.stub.AbstractActionTask<T>
              org.schmant.task.template.jdk.javadoc.AbstractJavadocTask<T>

All Implemented Interfaces:

TaskDependency, ActionTaskConfigurable<T>, ActionTaskSpec<T>, LoggingConfigurable<T>, SourceConfigurable<T>, SourceConfigured, Task, TaskRunnable, TaskSpecification<T>

Direct Known Subclasses:

ExtJavadocTask

public abstract class AbstractJavadocTask<T extends AbstractJavadocTask<T>>
extends AbstractActionTask<T>

Abstract base class for Javadoc task implementations.

Since:

0.5

Author:

Karl Gustafsson

Constructor Summary

AbstractJavadocTask()

Method Summary

void	copyProperties(T spec) Override the implementation from AbstractTask to copy the source properties.
protected List<PathDecorator<?,?>>	getClasspathDecorators()
protected List<Object>	getClasspathEntries()
protected List<Object>	getClasspathFromDecorators() Get a list of classpath entries from all registered PathDecorator :s.
protected List<JavadocTaskDecorator>	getDecorators()
protected String	getEncoding()
protected Collection<String>	getExcludePackages()
protected List<Object>	getExtDirectories()
protected String	getLocale()
protected Object	getOverview()
protected Collection<String>	getPackageNames()
protected String	getSourceCodeVersion()
protected Collection<String>	getSourceFileNames()
protected JavadocVisibilityLevel	getVisibilityLevel()
protected boolean	isBreakIterator()
protected boolean	isMoreThanOneSourceAllowed() Is more than one source object allowed? This method returns false .
protected boolean	isSubPackages()
protected Collection<String>	validate(Report r) Override the method inherited from AbstractTask to give a validation error if no source is set (and AbstractActionTask.isSourcesMandatory() is true).

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

addSource, addSources, clearSources, getRelativeToBase, getSource, getSources, isSourcesMandatory, setRelativeToBase, setSource, setSources, toString

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

cancel, createTask, getDefaultLogFooter, getDefaultLogHeader, getDependencyForTasksScheduledByThisTask, getDependencyObservable, getFailureCause, getLogFooter, getLogHeader, getSatisfiedStateLock, getThis, isCancelled, isDone, isInterrupted, isRunning, isSatisfied, isSuccessful, run, runInternal, setLogFooter, setLogHeader, setReportLevel, setTraceLogging

Methods inherited from class org.schmant.support.AbstractArgumentChecker

check, check, check, check

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.schmant.task.TaskSpecification

createTask

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

setLogFooter, setLogHeader, setReportLevel, setTraceLogging

Constructor Detail

AbstractJavadocTask

public AbstractJavadocTask()

Method Detail

getPackageNames

protected final Collection<String> getPackageNames()

isSubPackages

protected final boolean isSubPackages()

getSourceFileNames

protected final Collection<String> getSourceFileNames()

getClasspathEntries

protected final List<Object> getClasspathEntries()

getClasspathDecorators

protected final List<PathDecorator<?,?>> getClasspathDecorators()

getOverview

protected final Object getOverview()

getVisibilityLevel

protected final JavadocVisibilityLevel getVisibilityLevel()

getSourceCodeVersion

protected final String getSourceCodeVersion()

getExcludePackages

protected final Collection<String> getExcludePackages()

getExtDirectories

protected final List<Object> getExtDirectories()

isBreakIterator

protected final boolean isBreakIterator()

getLocale

protected final String getLocale()

getEncoding

protected final String getEncoding()

getDecorators

protected final List<JavadocTaskDecorator> getDecorators()

getClasspathFromDecorators

protected List<Object> getClasspathFromDecorators()

Get a list of classpath entries from all registered PathDecorator :s.

Returns:

A list of classpath entries.

isMoreThanOneSourceAllowed

protected boolean isMoreThanOneSourceAllowed()

Description copied from class: AbstractActionTask

Is more than one source object allowed? This method returns false . Subclasses override this method to return true if they allow several sources.

This method will only be called if AbstractActionTask.isSourcesMandatory() returns true.

Overrides:

isMoreThanOneSourceAllowed in class AbstractActionTask<T extends AbstractJavadocTask<T>>

Returns:

false, always

validate

protected Collection<String> validate(Report r)

Description copied from class: AbstractActionTask

Override the method inherited from AbstractTask to give a validation error if no source is set (and AbstractActionTask.isSourcesMandatory() is true).

Subclasses may override this to add their own validations.

Overrides:

validate in class AbstractActionTask<T extends AbstractJavadocTask<T>>

Parameters:

r - A report to log warning and debug messages to. Validation errors should not be logged, though. They are logged later.

Returns:

A collection of error messages.

copyProperties

public void copyProperties(T spec)

Description copied from class: AbstractActionTask

Override the implementation from AbstractTask to copy the source properties. Subclasses must override this to copy their own properties.

Specified by:

copyProperties in interface TaskSpecification<T extends AbstractJavadocTask<T>>

Overrides:

copyProperties in class AbstractActionTask<T extends AbstractJavadocTask<T>>

Parameters:

spec - The specification to copy properties to.