io.takari.incrementalbuild.spi

Class DefaultBuildContext<BuildFailureException extends Exception>

java.lang.Object

io.takari.incrementalbuild.spi.DefaultBuildContext<BuildFailureException>

All Implemented Interfaces:

BuildContext

Direct Known Subclasses:

MavenBuildContext, StandaloneBuildContext

public abstract class DefaultBuildContext<BuildFailureException extends Exception>
extends Object
implements BuildContext

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
protected org.slf4j.Logger	log
protected File	stateFile

Constructor Summary

Constructors

Constructor and Description
DefaultBuildContext(io.takari.incrementalbuild.workspace.Workspace workspace, io.takari.incrementalbuild.workspace.MessageSink messageSink, File stateFile, Map<String,Serializable> configuration)

Method Summary

Methods

Modifier and Type	Method and Description
void	addCapability(DefaultOutput output, String qualifier, String localName)
void	addMessage(Object resource, int line, int column, String message, BuildContext.Severity severity, Throwable cause)
void	associate(DefaultInput<?> input, DefaultOutput output)
void	associateIncludedInput(DefaultInput<?> input, DefaultInput<File> included)
protected void	carryOverOutput(File outputFile)
protected void	carryOverOutput(Object inputResource, File outputFile)
void	commit()
protected void	deleteStaleOutput(File outputFile)
Iterable<DefaultOutputMetadata>	deleteStaleOutputs(boolean eager) Deletes outputs that were registered during the previous build but not the current build.
Iterable<DefaultOutput>	getAssociatedOutputs(File inputFile)
Iterable<DefaultInputMetadata<File>>	getDependentInputs(String qualifier, String localName) Returns Inputs with specified requirement.
BuildContext.ResourceStatus	getInputStatus(Object inputResource, boolean associated)
Collection<String>	getOutputCapabilities(File outputFile, String qualifier)
BuildContext.ResourceStatus	getOutputStatus(File outputFile)
Iterable<DefaultOutputMetadata>	getProcessedOutputs() Returns all outputs processed by this BuildContext during current build or carried over from previous build.
Iterable<DefaultInputMetadata<File>>	getRegisteredInputs() Returns all inputs registered with this BuildContext during current and previous builds.
<T> Iterable<DefaultInputMetadata<T>>	getRegisteredInputs(Class<T> clazz)
<T> Set<DefaultInputMetadata<T>>	getRemovedInputs(Class<T> clazz)
<T extends Serializable> T	getResourceAttribute(Object resource, String key, boolean previous, Class<T> clazz)
boolean	isEscalated()
boolean	isProcessingRequired()
protected void	log(Object resource, int line, int column, String message, BuildContext.Severity severity, Throwable cause)
void	markOutputAsUptodate(File outputFile)
void	markOutputsAsUptodate() Marks all outputs processed during the previous build as up-to-date, in other words, the outputs and their associated metadata are carried over to the next build as-is.
void	markSkipExecution() Marks skipped build execution.
protected abstract BuildFailureException	newBuildFailureException(String message)
DefaultInput<File>	processIncludedInput(File inputFile)
<T> DefaultInput<T>	processInput(DefaultInputMetadata<T> inputMetadata)
DefaultOutput	processOutput(File outputFile)
Iterable<DefaultInput<File>>	registerAndProcessInputs(File basedir, Collection<String> includes, Collection<String> excludes) Registers inputs identified by basedir and includes/excludes ant patterns.
DefaultInputMetadata<File>	registerInput(File inputFile) Registers specified input File with this build context.
<T extends Serializable> DefaultInputMetadata<T>	registerInput(ResourceHolder<T> holder)
Iterable<DefaultInputMetadata<File>>	registerInputs(File basedir, Collection<String> includes, Collection<String> excludes) Registers inputs identified by basedir and includes/excludes ant patterns.
Iterable<DefaultInputMetadata<File>>	registerInputs(Iterable<File> inputs)
<T extends Serializable> Serializable	setResourceAttribute(Object resource, String key, T value)

Methods inherited from class java.lang.Object

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

Field Detail

log

protected final org.slf4j.Logger log

stateFile

protected final File stateFile

Constructor Detail

DefaultBuildContext

public DefaultBuildContext(io.takari.incrementalbuild.workspace.Workspace workspace,
                   io.takari.incrementalbuild.workspace.MessageSink messageSink,
                   File stateFile,
                   Map<String,Serializable> configuration)

Method Detail

isEscalated

public boolean isEscalated()

processInput

public <T> DefaultInput<T> processInput(DefaultInputMetadata<T> inputMetadata)

registerAndProcessInputs

public Iterable<DefaultInput<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

deleteStaleOutputs

public Iterable<DefaultOutputMetadata> deleteStaleOutputs(boolean eager)
                                                   throws IOException

Deletes outputs that were registered during the previous build but not the current build. Usually not called directly, since it is automatically invoked during commit().

Result includes DefaultOutput instances removed from the state even if underlying file did not exist.

If eager == false, preserves outputs associated with existing inputs during the previous build and outputs that do not have associated inputs. This is useful if generator needs access to old output files during multi-round build. For example, java incremental compiler needs to compare old and new version of class files to determine if changes need to be propagated.

Returns:

deleted outputs

Throws:

IOException - if an orphaned output file cannot be deleted.

deleteStaleOutput

protected void deleteStaleOutput(File outputFile)
                          throws IOException

Throws:

IOException

processOutput

public DefaultOutput processOutput(File outputFile)

Specified by:

processOutput in interface BuildContext

markOutputsAsUptodate

public void markOutputsAsUptodate()

Marks all outputs processed during the previous build as up-to-date, in other words, the outputs and their associated metadata are carried over to the next build as-is. This method is only allowed when isProcessingRequired() returns false. No context modification operations (register* or process) are permitted after this call.

This is useful when this build context is used to track both inputs and outputs but not association between the two. Without input/output association information the build context is not able to determine what outputs are stale/orphaned and what outputs are still relevant.

markSkipExecution

public void markSkipExecution()

Marks skipped build execution. All inputs, outputs and their associated metadata are carried over to the next build as-is. No context modification operations (register* or process) are permitted after this call.

markOutputAsUptodate

public void markOutputAsUptodate(File outputFile)

processIncludedInput

public DefaultInput<File> processIncludedInput(File inputFile)

getInputStatus

public BuildContext.ResourceStatus getInputStatus(Object inputResource,
                                         boolean associated)

getOutputStatus

public BuildContext.ResourceStatus getOutputStatus(File outputFile)

registerInput

public DefaultInputMetadata<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.

registerInput

public <T extends Serializable> DefaultInputMetadata<T> registerInput(ResourceHolder<T> holder)

registerInputs

public Iterable<DefaultInputMetadata<File>> registerInputs(Iterable<File> inputs)

registerInputs

public Iterable<DefaultInputMetadata<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

getRegisteredInputs

public Iterable<DefaultInputMetadata<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

getRegisteredInputs

public <T> Iterable<DefaultInputMetadata<T>> getRegisteredInputs(Class<T> clazz)

getRemovedInputs

public <T> Set<DefaultInputMetadata<T>> getRemovedInputs(Class<T> clazz)

getProcessedOutputs

public Iterable<DefaultOutputMetadata> 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

associate

public void associate(DefaultInput<?> input,
             DefaultOutput output)

getAssociatedOutputs

public Iterable<DefaultOutput> getAssociatedOutputs(File inputFile)

associateIncludedInput

public void associateIncludedInput(DefaultInput<?> input,
                          DefaultInput<File> included)

addCapability

public void addCapability(DefaultOutput output,
                 String qualifier,
                 String localName)

getOutputCapabilities

public Collection<String> getOutputCapabilities(File outputFile,
                                       String qualifier)

getDependentInputs

public Iterable<DefaultInputMetadata<File>> getDependentInputs(String qualifier,
                                                      String localName)

Returns Inputs with specified requirement. Inputs from the old state are automatically registered for processing.

setResourceAttribute

public <T extends Serializable> Serializable setResourceAttribute(Object resource,
                                                         String key,
                                                         T value)

getResourceAttribute

public <T extends Serializable> T getResourceAttribute(Object resource,
                                              String key,
                                              boolean previous,
                                              Class<T> clazz)

addMessage

public void addMessage(Object resource,
              int line,
              int column,
              String message,
              BuildContext.Severity severity,
              Throwable cause)

log

protected void log(Object resource,
       int line,
       int column,
       String message,
       BuildContext.Severity severity,
       Throwable cause)

commit

public void commit()
            throws BuildFailureException extends Exception,
                   IOException

Throws:

BuildFailureException extends Exception

IOException

carryOverOutput

protected void carryOverOutput(Object inputResource,
                   File outputFile)

carryOverOutput

protected void carryOverOutput(File outputFile)

isProcessingRequired

public boolean isProcessingRequired()

newBuildFailureException

protected abstract BuildFailureException newBuildFailureException(String message)