io.takari.incrementalbuild

Interface BuildContext

All Known Implementing Classes:

DefaultBuildContext, MavenBuildContext, MavenBuildContext.MojoExecutionScopedBuildContext

public interface BuildContext

Build context that supports 1..* input-output associations.

Method Summary

Methods

Modifier and Type	Method and Description
void	markSkipExecution()
Iterable<? extends Resource<File>>	registerAndProcessInputs(File basedir, Collection<String> includes, Collection<String> excludes) Registers inputs identified by basedir and includes/excludes ant patterns.
ResourceMetadata<File>	registerInput(File inputFile) Registers specified input File with this build context.
Iterable<? extends ResourceMetadata<File>>	registerInputs(File basedir, Collection<String> includes, Collection<String> excludes) Registers inputs identified by basedir and includes/excludes ant patterns.

Method Detail

registerInput

ResourceMetadata<File> registerInput(File inputFile)

Registers specified input File with this build context.

Returns:

InputMetadata representing the input file, never null.

Throws:

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

registerInputs

Iterable<? extends ResourceMetadata<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 Resource<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

markSkipExecution

void markSkipExecution()