org.schmant.task.meta
Class ForEachSourceTask

java.lang.Object
  org.schmant.support.AbstractArgumentChecker
      org.schmant.task.stub.AbstractTask<T>
          org.schmant.task.stub.AbstractActionTask<ForEachSourceTask>
              org.schmant.task.meta.ForEachSourceTask

All Implemented Interfaces:

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

public final class ForEachSourceTask
extends AbstractActionTask<ForEachSourceTask>

See ForEachSourceTF

Since:

0.6

Author:

Karl Gustafsson

Task_package:

org.schmant.task.base

Method Summary

void	copyProperties(ForEachSourceTask spec) Override the implementation from AbstractTask to copy the source properties.
TaskDependency	getDependencyForTasksScheduledByThisTask() This implementation returns this.
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.
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

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

cancel, createTask, getDefaultLogFooter, getDefaultLogHeader, 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.TaskSpecification

createTask

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

setLogFooter, setLogHeader, setReportLevel, setTraceLogging

Method Detail

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

Returns:

true

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

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.

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

Parameters:

r - The current thread's Report.

getDependencyForTasksScheduledByThisTask

public TaskDependency getDependencyForTasksScheduledByThisTask()

Description copied from class: AbstractTask

This implementation returns this. Subclasses that use TaskExecutor:s must override this method to return a dependency object for all of its scheduled tasks.

Specified by:

getDependencyForTasksScheduledByThisTask in interface Task

Overrides:

getDependencyForTasksScheduledByThisTask in class AbstractTask<ForEachSourceTask>

Returns:

this

copyProperties

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

Overrides:

copyProperties in class AbstractActionTask<ForEachSourceTask>

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 AbstractActionTask<ForEachSourceTask>