org.schmant.task.text.apilinks
Class ApiLinksTask

java.lang.Object
  org.schmant.support.AbstractArgumentChecker
      org.schmant.task.stub.AbstractTask<T>
          org.schmant.task.stub.AbstractActionTask<T>
              org.schmant.task.stub.AbstractProcessTask<T>
                  org.schmant.task.template.text.AbstractTextInsertionTask<ApiLinksTask>
                      org.schmant.task.text.apilinks.ApiLinksTask

All Implemented Interfaces:

Producer<WritableFile>, TaskDependency, ActionTaskConfigurable<ApiLinksTask>, ActionTaskSpec<ApiLinksTask>, LoggingConfigurable<ApiLinksTask>, OverwriteConfigurable<ApiLinksTask>, SourceConfigurable<ApiLinksTask>, SourceConfigured, TargetConfigurable<ApiLinksTask>, TargetConfigured, GeneratorTaskConfigurable<ApiLinksTask>, GeneratorTaskSpec<ApiLinksTask>, ProcessTaskConfigurable<ApiLinksTask>, ProcessTaskSpec<ApiLinksTask>, Task, TaskRunnable, TaskSpecification<ApiLinksTask>

public final class ApiLinksTask
extends AbstractTextInsertionTask<ApiLinksTask>

See ApiLinksTF

Since:

0.8

Author:

Karl Gustafsson

Task_package:

org.schmant.task.base

Field Summary

Fields inherited from class org.schmant.task.template.text.AbstractTextInsertionTask

DEFAULT_BUFFER_SIZE

Fields inherited from interface org.schmant.task.confable.OverwriteConfigurable

DEFAULT_OVERWRITE_STRATEGY

Method Summary

void	copyProperties(ApiLinksTask spec) Override the implementation from AbstractTask to copy the source properties.
protected List<PatternAndStrategy>	createReplaces(ReadableFile source) Subclasses implement this method to create the replaces that it uses.
protected String	getDefaultLogHeader() Get the default log header to log (to level INFO) before the task is run if the task user has not set a custom header.
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.template.text.AbstractTextInsertionTask

get, getBufferSize, getInputEncoding, getOutputEncoding, getTempDirectory, isErrorIfReplaceNotFound, runInternal

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

getOverwriteStrategy, getTarget, isTargetMandatory, setOverwrite, setOverwriteStrategy, setTarget, toString

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

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

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

cancel, createTask, getDefaultLogFooter, getDependencyForTasksScheduledByThisTask, getDependencyObservable, getFailureCause, getLogFooter, getLogHeader, getSatisfiedStateLock, getThis, isCancelled, isDone, isInterrupted, isRunning, isSatisfied, isSuccessful, run, 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.confable.SourceConfigurable

addSource, addSources, clearSources, setRelativeToBase, setSource, setSources

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

getSource, getSources

Methods inherited from interface org.schmant.task.TaskSpecification

createTask

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

setLogFooter, setLogHeader, setReportLevel, setTraceLogging

Method Detail

getDefaultLogHeader

protected String getDefaultLogHeader()

Description copied from class: AbstractTask

Get the default log header to log (to level INFO) before the task is run if the task user has not set a custom header. Subclasses may override this to return better headers.

This is called after validating the task.

Return null to disable logging.

Overrides:

getDefaultLogHeader in class AbstractTask<ApiLinksTask>

Returns:

"Running " + toString()

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 AbstractProcessTask<ApiLinksTask>

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.

createReplaces

protected List<PatternAndStrategy> createReplaces(ReadableFile source)

Description copied from class: AbstractTextInsertionTask

Subclasses implement this method to create the replaces that it uses.

Specified by:

createReplaces in class AbstractTextInsertionTask<ApiLinksTask>

copyProperties

public void copyProperties(ApiLinksTask 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<ApiLinksTask>

Overrides:

copyProperties in class AbstractTextInsertionTask<ApiLinksTask>

Parameters:

spec - The specification to copy properties to.