org.schmant.task.text
Class FormatCharacterFileTask

java.lang.Object
  org.schmant.support.AbstractArgumentChecker
      org.schmant.task.stub.AbstractTask<T>
          org.schmant.task.stub.AbstractActionTask<T>
              org.schmant.task.stub.AbstractProcessTask<FormatCharacterFileTask>
                  org.schmant.task.text.FormatCharacterFileTask

All Implemented Interfaces:

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

public final class FormatCharacterFileTask
extends AbstractProcessTask<FormatCharacterFileTask>

See FormatCharacterFileTF

Since:

0.5

Author:

Karl Gustafsson

Task_package:

org.schmant.task.base

Field Summary

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

DEFAULT_OVERWRITE_STRATEGY

Method Summary

void	copyProperties(FormatCharacterFileTask spec) Override the implementation from AbstractTask to copy the source properties.
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 void	runInternal(Report r) Subclasses implement this.

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

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

Returns:

"Running " + toString()

runInternal

protected void runInternal(Report r)
                    throws Exception

Description copied from class: AbstractTask

Subclasses implement this. The task is AbstractTask.validate(Report):d before this method is called, see AbstractTask.run().

Specified by:

runInternal in class AbstractTask<FormatCharacterFileTask>

Parameters:

r - The current thread's Report.

Throws:

Exception - On errors.

copyProperties

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

Overrides:

copyProperties in class AbstractProcessTask<FormatCharacterFileTask>

Parameters:

spec - The specification to copy properties to.