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

All Known Subinterfaces:
ExtJavaConfigurable<T>, ExtJavaTaskConfigurable<T>, ExtJvmConfigurable<T>, ExtJvmTaskConfigurable<T>, JavacTaskConfigurable<T>, JavacTaskFactory<T,U>, JavadocTaskConfigurable<T>, JvmConfigurable<T>
All Known Implementing Classes:
AbstractExtJavaTaskFactory, AbstractExtJvmTaskFactory, AbstractJavacTaskFactory, AbstractJavadocTaskFactory, ExtFindbugsTF, ExtJavacTF, ExtJavadocTF, JavaTF, Jdk6JavacTF, JUnit4TF

public interface ClasspathConfigurable<T extends ClasspathConfigurable<T>>

This interface defines an object that can be configured with a classpath. The classpath entries are stored in a list that contains the entries in the order that they were added.

In addition to manually added entries, classpath entries can also be added from PathDecorator:s. Entries from decorators are added after the manually added entries. (The implementing class may have other kinds of decorators that add entries to the head of the list.)

Since:
0.5
Author:
Karl Gustafsson

Method Summary
 T addClasspathDecorator(PathDecorator<?,?> cd)
          Add one path decorator.
 T addClasspathDecorators(Object o)
          Add one or several path decorators.
 T addClasspathEntries(Object o)
          This method does the same as addClasspathEntry(Object).
 T addClasspathEntry(Object o)
          Add one or several classpath entries to the classpath.
 T clearClasspathDecorators()
          Clear the list of classpath decorators.
 T clearClasspathEntries()
          Clear the list of classpath entries.
 

Method Detail

addClasspathEntry

T addClasspathEntry(Object o)
Add one or several classpath entries to the classpath.

Parameters:
o - The entry or entries. If the object is a collection or array, it is flattened (see FlatteningList). It is up to the implementing object to decide how the object or objects should be interpreted.
Returns:
this

addClasspathEntries

T addClasspathEntries(Object o)
This method does the same as addClasspathEntry(Object).

Parameters:
o - The entries. See addClasspathEntry(Object).
Returns:
this

clearClasspathEntries

T clearClasspathEntries()
Clear the list of classpath entries.

Returns:
this.

addClasspathDecorator

T addClasspathDecorator(PathDecorator<?,?> cd)
Add one path decorator.

Returns:
this

addClasspathDecorators

T addClasspathDecorators(Object o)
Add one or several path decorators.

Parameters:
o - One or an array or collection of classpath decorators (PathDecorator objects).
Returns:
this

clearClasspathDecorators

T clearClasspathDecorators()
Clear the list of classpath decorators.

Returns:
this