io.takari.incrementalbuild

Interface BuildContext

All Known Implementing Classes:

DefaultBuildContext, MavenBuildContext, SingletonBuildContext, StandaloneBuildContext

public interface BuildContext

XXX decide if implementations of this interface should be thread-safe or not.

Author:

igor

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	BuildContext.Input<T> Read-write state associated with input.
static interface	BuildContext.InputMetadata<T> Read-only state associated with input.
static interface	BuildContext.Output<T>
static interface	BuildContext.OutputMetadata<T>
static interface	BuildContext.Resource<T>
static interface	BuildContext.ResourceMetadata<T>
static class	BuildContext.ResourceStatus
static class	BuildContext.Severity

Method Summary

Methods

Modifier and Type	Method and Description
Iterable<? extends BuildContext.OutputMetadata<File>>	getProcessedOutputs() Returns all outputs processed by this BuildContext during current build or carried over from previous build.
Iterable<? extends BuildContext.InputMetadata<File>>	getRegisteredInputs() Returns all inputs registered with this BuildContext during current and previous builds.
BuildContext.Output<File>	processOutput(File outputFile)
Iterable<? extends BuildContext.Input<File>>	registerAndProcessInputs(File basedir, Collection<String> includes, Collection<String> excludes) Registers inputs identified by basedir and includes/excludes ant patterns.
BuildContext.InputMetadata<File>	registerInput(File inputFile) Registers specified input File with this build context.
Iterable<? extends BuildContext.InputMetadata<File>>	registerInputs(File basedir, Collection<String> includes, Collection<String> excludes) Registers inputs identified by basedir and includes/excludes ant patterns.

Method Detail

registerInput

BuildContext.InputMetadata<File> registerInput(File inputFile)

Registers specified input File with this build context.

Returns:

BuildContext.InputMetadata representing the input file, never null.

Throws:

IllegalArgumentException - if inputFile is not a file or cannot be read

registerInputs

Iterable<? extends BuildContext.InputMetadata<File>> registerInputs(File basedir,
                                                                  Collection<String> includes,
                                                                  Collection<String> excludes)
                                                                    throws IOException

Registers inputs identified by basedir and includes/excludes ant patterns.

When a file is found under basedir, it will be registered if it does not match excludes patterns and matches includes patterns. null or empty includes parameter will match all files. excludes match takes precedence over includes, if a file matches one of excludes patterns it will not be registered regardless of includes patterns match.

Implementation is not expected to handle changes basedir, includes or excludes incrementally.

Parameters:

basedir - is the base directory to look for inputs, must not be null

includes - patterns of the files to register, can be null

excludes - patterns of the files to ignore, can be null

Throws:

IOException

See Also:

http://ant.apache.org/manual/dirtasks.html#patterns

registerAndProcessInputs

Iterable<? extends BuildContext.Input<File>> registerAndProcessInputs(File basedir,
                                                                    Collection<String> includes,
                                                                    Collection<String> excludes)
                                                                      throws IOException

Registers inputs identified by basedir and includes/excludes ant patterns. Processes inputs that are new or modified since previous build.

Throws:

IOException

processOutput

BuildContext.Output<File> processOutput(File outputFile)

getRegisteredInputs

Iterable<? extends BuildContext.InputMetadata<File>> getRegisteredInputs()

Returns all inputs registered with this BuildContext during current and previous builds.

getProcessedOutputs

Iterable<? extends BuildContext.OutputMetadata<File>> getProcessedOutputs()

Returns all outputs processed by this BuildContext during current build or carried over from previous build.