io.takari.incrementalbuild.maven.internal

Class SingletonBuildContext

java.lang.Object

io.takari.incrementalbuild.maven.internal.SingletonBuildContext

All Implemented Interfaces:

BuildContext

@Named(value="singleton")
@Typed(value=BuildContext.class)
@Singleton
public class SingletonBuildContext
extends Object
implements BuildContext

Singleton-friendly BuildContext implementation. Uses Provider to locate currently active MavenBuildContext instance.

MavenBuildContext is MojoExecutionScoped and its lifecycle is bound to lifecycle of the corresponding mojo execution, that is, it is created right before the mojo execution starts and discarded immediately after the mojo execution ends. Most Maven plugin components, however, are singletons, which means they are created when plugin class realm is created at the beginning of the build and discarded when plugin realm is discarded at the end of the build. It is therefore not possible to bind MavenBuildContext to singleton components directly.

Nested Class Summary

Nested classes/interfaces inherited from interface io.takari.incrementalbuild.BuildContext

BuildContext.Input<T>, BuildContext.InputMetadata<T>, BuildContext.Output<T>, BuildContext.OutputMetadata<T>, BuildContext.Resource<T>, BuildContext.ResourceMetadata<T>, BuildContext.ResourceStatus, BuildContext.Severity

Field Summary

Fields

Modifier and Type	Field and Description
static String	HINT

Constructor Summary

Constructors

Constructor and Description
SingletonBuildContext(javax.inject.Provider<MavenBuildContext> delegate)

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.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

HINT

public static final String HINT

See Also:

Constant Field Values

Constructor Detail

SingletonBuildContext

@Inject
public SingletonBuildContext(javax.inject.Provider<MavenBuildContext> delegate)

Method Detail

registerInput

public BuildContext.InputMetadata<File> registerInput(File inputFile)

Description copied from interface: BuildContext

Registers specified input File with this build context.

Specified by:

registerInput in interface BuildContext

Returns:

BuildContext.InputMetadata representing the input file, never null.

registerInputs

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

Description copied from interface: BuildContext

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.

Specified by:

registerInputs in interface BuildContext

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

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

Description copied from interface: BuildContext

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

Specified by:

registerAndProcessInputs in interface BuildContext

Throws:

IOException

processOutput

public BuildContext.Output<File> processOutput(File outputFile)

Specified by:

processOutput in interface BuildContext

getRegisteredInputs

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

Description copied from interface: BuildContext

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

Specified by:

getRegisteredInputs in interface BuildContext

getProcessedOutputs

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

Description copied from interface: BuildContext

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

Specified by:

getProcessedOutputs in interface BuildContext