org.schmant.task.tp.ailinks
Class ArgumentInterpreterLinksTask

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<T>
                      org.schmant.task.tp.AbstractLinkInsertionTask<ArgumentInterpreterLinksTask>
                          org.schmant.task.tp.ailinks.ArgumentInterpreterLinksTask

All Implemented Interfaces:

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

public final class ArgumentInterpreterLinksTask
extends AbstractLinkInsertionTask<ArgumentInterpreterLinksTask>

Since:

0.8

Author:

Karl Gustafsson

Task_package:

org.schmant.task.taskpackage

Field Summary

static String

DEFAULT_ARGUMENT_INTERPRETER_DOC_PAGE

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

protected List<PatternAndStrategy>	createReplacesFromBaseUrl(String effectiveBaseUrl)
protected String	getDefaultDocBaseUrl()
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 String	getLinkClass() This method may be overridden by subclasses that want to return a default link class if none is set.

Methods inherited from class org.schmant.task.tp.AbstractLinkInsertionTask

copyProperties, createReplaces, getBaseDirectory, getDocBaseUrl, getLinkTarget

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, validate

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

Field Detail

DEFAULT_ARGUMENT_INTERPRETER_DOC_PAGE

public static final String DEFAULT_ARGUMENT_INTERPRETER_DOC_PAGE

See Also:

Constant Field Values

Method Detail

getDefaultDocBaseUrl

protected String getDefaultDocBaseUrl()

Specified by:

getDefaultDocBaseUrl in class AbstractLinkInsertionTask<ArgumentInterpreterLinksTask>

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<ArgumentInterpreterLinksTask>

Returns:

"Running " + toString()

getLinkClass

protected String getLinkClass()

Description copied from class: AbstractLinkInsertionTask

This method may be overridden by subclasses that want to return a default link class if none is set.

Overrides:

getLinkClass in class AbstractLinkInsertionTask<ArgumentInterpreterLinksTask>

Returns:

The set link class, if any.

createReplacesFromBaseUrl

protected List<PatternAndStrategy> createReplacesFromBaseUrl(String effectiveBaseUrl)

Specified by:

createReplacesFromBaseUrl in class AbstractLinkInsertionTask<ArgumentInterpreterLinksTask>