org.schmant.task.xml.xslt
Class TemplateCompilerTask

java.lang.Object
  extended by org.schmant.support.AbstractArgumentChecker
      extended by org.schmant.task.stub.AbstractTask<T>
          extended by org.schmant.task.stub.AbstractActionTask<TemplateCompilerTask>
              extended by org.schmant.task.xml.xslt.TemplateCompilerTask
All Implemented Interfaces:
Producer<Templates>, TaskDependency, ActionTaskConfigurable<TemplateCompilerTask>, ActionTaskSpec<TemplateCompilerTask>, LoggingConfigurable<TemplateCompilerTask>, SourceConfigurable<TemplateCompilerTask>, SourceConfigured, Task, TaskRunnable, TaskSpecification<TemplateCompilerTask>

public final class TemplateCompilerTask
extends AbstractActionTask<TemplateCompilerTask>
implements Producer<Templates>

See TemplateCompilerTF

Since:
0.5
Author:
Karl Gustafsson
Task_package:
org.schmant.task.base

Method Summary
 void copyProperties(TemplateCompilerTask spec)
          Override the implementation from AbstractTask to copy the source properties.
 Templates get()
          Returns the produced object, or null if nothing is produced yet.
 Templates getTemplates()
           
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, isMoreThanOneSourceAllowed, isSourcesMandatory, setRelativeToBase, setSource, setSources
 
Methods inherited from class org.schmant.task.stub.AbstractTask
cancel, createTask, getDefaultLogFooter, getDefaultLogHeader, 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.TaskSpecification
createTask
 
Methods inherited from interface org.schmant.task.confable.LoggingConfigurable
setLogFooter, setLogHeader, setReportLevel, setTraceLogging
 

Method Detail

getTemplates

public Templates getTemplates()

get

public Templates 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<Templates>
Returns:
The produced object.

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<TemplateCompilerTask>
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)
                    throws TransformerConfigurationException
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<TemplateCompilerTask>
Parameters:
r - The current thread's Report.
Throws:
TransformerConfigurationException

copyProperties

public void copyProperties(TemplateCompilerTask 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<TemplateCompilerTask>
Overrides:
copyProperties in class AbstractActionTask<TemplateCompilerTask>
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<TemplateCompilerTask>