org.schmant.task.confable
Interface SourceConfigurable<T extends SourceConfigurable<T>>

All Known Subinterfaces:

ActionTaskConfigurable<T>, ActionTaskFactory<T,U>, ActionTaskSpec<T>, JavacTaskFactory<T,U>, JavadocTaskConfigurable<T>, ProcessTaskConfigurable<T>, ProcessTaskFactory<T,U>, ProcessTaskSpec<T>, ProxyTaskConfigurable<T>, RecursiveActionTaskConfigurable<T>, RecursiveActionTaskFactory<T,U>, RecursiveActionTaskSpec<T>, RecursiveProcessTaskConfigurable<T>, RecursiveProcessTaskFactory<T,U>, RecursiveProcessTaskSpec<T>, TextInsertionTaskConfigurable<T>

All Known Implementing Classes:

AbstractActionTask, AbstractActionTaskFactory, AbstractAddTextTask, AbstractAddTextTaskFactory, AbstractCallbackRecursiveActionTask, AbstractCallbackRecursiveProcessTask, AbstractJarTask, AbstractJarTaskFactory, AbstractJavacTask, AbstractJavacTaskFactory, AbstractJavadocTask, AbstractJavadocTaskFactory, AbstractJavaZipTask, AbstractJavaZipTaskFactory, AbstractLinkInsertionTask, AbstractLinkInsertionTaskFactory, AbstractParseXmlTask, AbstractParseXmlTaskFactory, AbstractProcessOneFileTask, AbstractProcessTask, AbstractProcessTaskFactory, AbstractProxyTask, AbstractProxyTaskFactory, AbstractRecursiveActionTaskFactory, AbstractRecursiveProcessTaskFactory, AbstractTextInsertionTask, AbstractTextInsertionTaskFactory, AbstractXmlCatalogActionTask, AbstractXmlCatalogActionTaskFactory, AbstractZipTask, AbstractZipTaskFactory, AddSystemIdToCatalogTask, AddSystemIdToCatalogTF, AddUriToCatalogTask, AddUriToCatalogTF, AntTask, AntTF, ApiLinksTask, ApiLinksTF, ArgumentInterpreterLinksTask, ArgumentInterpreterLinksTF, At4JUnzipTF, At4JZipTask, At4JZipTF, BZip2Task, BZip2TF, ChmodTask, ChmodTF, ClosureTask, CopyTask, CopyTF, DeleteTask, DeleteTF, DomParseXmlTask, DomParseXmlTF, EarTask, EarTF, ErrorIgnoringTask, ErrorIgnoringTF, ExtFindbugsTask, ExtFindbugsTF, ExtJarSignerTask, ExtJarSignerTF, ExtJavacTask, ExtJavacTF, ExtJavadocTask, ExtJavadocTF, ForEachSourceTask, ForEachSourceTF, FormatCharacterFileTask, FormatCharacterFileTF, GZipTask, GZipTF, HtmlLinkValidationTask, HtmlLinkValidationTF, IncludeFilesTask, IncludeFilesTF, JarTask, JarTF, Jdk6JavacTask, Jdk6JavacTF, LzmaTask, LzmaTF, MoveTask, MoveTF, RecursiveActionTask, RecursiveActionTF, RecursiveProcessTask, RecursiveProcessTF, RedirectReportTask, RedirectReportTF, ReplaceSourceFileTask, ReplaceSourceFileTF, SchemaFactoryTask, SchemaFactoryTF, SchmantTaskrefTask, SchmantTaskrefTF, TarTask, TarTF, TaskFactoryLinksTask, TaskFactoryLinksTF, TemplateCompilerTask, TemplateCompilerTF, TextAppendTask, TextAppendTF, TextPrependTask, TextPrependTF, TextReplaceTask, TextReplaceTF, TimedExecutionTask, TimedExecutionTF, TreeCopyTask, TreeCopyTF, TreeDeleteTask, TreeDeleteTF, UntarTF, WarTask, WarTF, XsltTask, XsltTF, ZipTask, ZipTF

public interface SourceConfigurable<T extends SourceConfigurable<T>>

This interface defines a class that can be configured with a collection of sources. It is up to the implementing object to decide how the source objects should be interpreted.

Sources are objects used as a input data for, for instance, an action task.

Since:

0.5

Author:

Karl Gustafsson

Method Summary

T	addSource(Object o) Add one or several sources.
T	addSources(Object o) This method does the same as addSource(Object)
T	clearSources() Clear the collection of sources.
T	setRelativeToBase(RelativeLocation rel) This property is set with the task's source's location relative to a base location if the task is run within a recursive task.
T	setSource(Object o) Set one or several sources, discarding previously set sources.
T	setSources(Object o) This method does the same as setSource(Object)

Method Detail

setSource

T setSource(Object o)

Set one or several sources, discarding previously set sources.

Parameters:

o - The source. If this is a Collection or an array, it is flattened (see FlatteningList), and all objects in the collection or array are set.

Returns:

this

setSources

T setSources(Object o)

This method does the same as setSource(Object)

Parameters:

o - The source or sources.

Returns:

this

addSource

T addSource(Object o)

Add one or several sources.

Parameters:

o - The source. If this is a Collection or an array, it is flattened (see FlatteningList), and all sources in the collection or array are added.

Returns:

this

addSources

T addSources(Object o)

This method does the same as addSource(Object)

Parameters:

o - The source or sources.

Returns:

this

clearSources

T clearSources()

Clear the collection of sources.

Returns:

this.

setRelativeToBase

T setRelativeToBase(RelativeLocation rel)

This property is set with the task's source's location relative to a base location if the task is run within a recursive task. The base location is the location of the source of the recursive task.

If the SourceConfigurable (this object) is an action task factory that is used in a recursive action task, the recursive action task sets this property for each created task.

Parameters:

rel - The source's location relative to the base location.

Returns:

this