org.schmant.task.io
Class CopyTask

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

All Implemented Interfaces:

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

public final class CopyTask
extends AbstractProcessTask<CopyTask>
implements Producer<EntityView>, ProcessTaskSpec<CopyTask>

See CopyTF

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(CopyTask spec) Override the implementation from AbstractTask to copy the source properties.
EntityView	get() Returns the produced object, or null if nothing is produced yet.
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 boolean	isMoreThanOneSourceAllowed() Is more than one source object allowed? This method returns false .
protected void	runInternal(Report r) Subclasses implement this.
String	toString() Default implementation for tasks.

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

getOverwriteStrategy, getTarget, isTargetMandatory, setOverwrite, setOverwriteStrategy, setTarget, validate

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

addSource, addSources, clearSources, getRelativeToBase, getSource, getSources, 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

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

setTarget

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

setOverwrite, setOverwriteStrategy

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

getTarget

Method Detail

getDefaultLogHeader

public 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<CopyTask>

Returns:

"Running " + toString()

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

Returns:

false, always

get

public EntityView get()

Description copied from interface: Producer

Returns the produced object, or null if nothing is produced yet.

This method should be implemented thread-safe.

Specified by:

get in interface Producer<EntityView>

Returns:

The produced object.

runInternal

protected void runInternal(Report r)

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

Parameters:

r - The current thread's Report.

copyProperties

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

Overrides:

copyProperties in class AbstractProcessTask<CopyTask>

Parameters:

spec - The specification to copy properties to.

toString

public String toString()

Description copied from class: AbstractTask

Default implementation for tasks. Task implementations may override this. It is used in the default log header that is written (level INFO) before a task is run.

This implementation just returns the class name.

Overrides:

toString in class AbstractProcessTask<CopyTask>