io.takari.incrementalbuild.spi

Class AbstractBuildContext

java.lang.Object

io.takari.incrementalbuild.spi.AbstractBuildContext

Direct Known Subclasses:

DefaultAggregatorBuildContext, DefaultBasicBuildContext, DefaultBuildContext

public abstract class AbstractBuildContext
extends Object

Tracks build input and output resources and associations among them.

Field Summary

Fields

Modifier and Type	Field and Description
protected org.slf4j.Logger	log
protected DefaultBuildContextState	oldState
protected DefaultBuildContextState	state
protected io.takari.incrementalbuild.workspace.Workspace	workspace

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractBuildContext(BuildContextEnvironment env)
protected	AbstractBuildContext(io.takari.incrementalbuild.workspace.Workspace workspace, File stateFile, Map<String,Serializable> configuration, BuildContextFinalizer finalizer)

Method Summary

Methods

Modifier and Type	Method and Description
protected void	addMessage(Object resource, int line, int column, String message, MessageSeverity severity, Throwable cause)
protected abstract void	assertAssociation(DefaultResource<?> resource, DefaultOutput output)
protected void	assertOpen()
protected <T> DefaultOutput	associate(DefaultResource<T> resource, DefaultOutput output)
protected <T> DefaultOutput	associate(DefaultResource<T> resource, File outputFile)
void	commit(MessageSinkAdaptor messager)
protected void	deleteOutput(File resource)
protected abstract void	finalizeContext()
protected Collection<? extends ResourceMetadata<File>>	getAssociatedOutputs(DefaultBuildContextState state, Object resource)
protected <V extends Serializable> V	getAttribute(Object resource, String key, Class<V> clazz)
DefaultBuildContextState	getOldState()
protected <T extends Serializable> T	getResourceAttribute(DefaultBuildContextState state, Object resource, String key, Class<T> clazz)
protected ResourceStatus	getResourceStatus(Object resource) Returns resource status compared to the previous build.
DefaultBuildContextState	getState()
protected DefaultBuildContextState	getState(Object source)
protected boolean	isDeletedResource(Object resource)
protected boolean	isEscalated()
protected boolean	isProcessed()
protected boolean	isProcessedResource(Object resource)
protected boolean	isRegisteredResource(Object resource)
protected void	log(Object resource, int line, int column, String message, MessageSeverity severity, Throwable cause)
protected void	markProcessedResource(Object resource)
protected void	markSkipExecution() Marks skipped build execution.
protected void	markUptodateOutput(File outputFile)
protected DefaultOutput	newOutput(File resource)
protected OutputStream	newOutputStream(DefaultOutput output)
protected <T> DefaultResource<T>	newResource(T resource)
protected <T> DefaultResourceMetadata<T>	newResourceMetadata(DefaultBuildContextState state, T resource)
protected static File	normalize(File file)
protected DefaultOutput	processOutput(File outputFile)
protected <T> DefaultResource<T>	processResource(DefaultResourceMetadata<T> metadata)
protected void	processResource(Object resource)
protected Collection<DefaultResource<File>>	registerAndProcessInputs(File basedir, Collection<String> includes, Collection<String> excludes)
protected DefaultResourceMetadata<File>	registerInput(File inputFile)
protected <T extends Serializable> T	registerInput(ResourceHolder<T> holder) Adds the resource to this build's resource set.
protected Collection<DefaultResourceMetadata<File>>	registerInputs(File basedir, Collection<String> includes, Collection<String> excludes) Registers matching resources as this build's input set.
protected DefaultResourceMetadata<File>	registerNormalizedInput(File resourceFile, long lastModified, long length)
protected DefaultResourceMetadata<File>	registerNormalizedOutput(File outputFile)
protected <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

workspace

protected final io.takari.incrementalbuild.workspace.Workspace workspace

state

protected final DefaultBuildContextState state

oldState

protected final DefaultBuildContextState oldState

Constructor Detail

AbstractBuildContext

protected AbstractBuildContext(BuildContextEnvironment env)

AbstractBuildContext

protected AbstractBuildContext(io.takari.incrementalbuild.workspace.Workspace workspace,
                    File stateFile,
                    Map<String,Serializable> configuration,
                    BuildContextFinalizer finalizer)

Method Detail

isEscalated

protected boolean isEscalated()

registerInputs

protected Collection<DefaultResourceMetadata<File>> registerInputs(File basedir,
                                                       Collection<String> includes,
                                                       Collection<String> excludes)
                                                            throws IOException

Registers matching resources as this build's input set.

Throws:

IOException

registerAndProcessInputs

protected Collection<DefaultResource<File>> registerAndProcessInputs(File basedir,
                                                         Collection<String> includes,
                                                         Collection<String> excludes)
                                                              throws IOException

Throws:

IOException

normalize

protected static File normalize(File file)

registerNormalizedInput

protected DefaultResourceMetadata<File> registerNormalizedInput(File resourceFile,
                                                    long lastModified,
                                                    long length)

registerNormalizedOutput

protected DefaultResourceMetadata<File> registerNormalizedOutput(File outputFile)

registerInput

protected DefaultResourceMetadata<File> registerInput(File inputFile)

registerInput

protected <T extends Serializable> T registerInput(ResourceHolder<T> holder)

Adds the resource to this build's resource set. The resource must exist, i.e. it's status must not be REMOVED.

getResourceStatus

protected ResourceStatus getResourceStatus(Object resource)

Returns resource status compared to the previous build.

processResource

protected <T> DefaultResource<T> processResource(DefaultResourceMetadata<T> metadata)

processResource

protected void processResource(Object resource)

markProcessedResource

protected void markProcessedResource(Object resource)

setResourceAttribute

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

getResourceAttribute

protected <T extends Serializable> T getResourceAttribute(DefaultBuildContextState state,
                                              Object resource,
                                              String key,
                                              Class<T> clazz)

addMessage

protected void addMessage(Object resource,
              int line,
              int column,
              String message,
              MessageSeverity severity,
              Throwable cause)

processOutput

protected DefaultOutput processOutput(File outputFile)

newOutputStream

protected OutputStream newOutputStream(DefaultOutput output)
                                throws IOException

Throws:

IOException

associate

protected <T> DefaultOutput associate(DefaultResource<T> resource,
                          DefaultOutput output)

assertAssociation

protected abstract void assertAssociation(DefaultResource<?> resource,
                     DefaultOutput output)

associate

protected <T> DefaultOutput associate(DefaultResource<T> resource,
                          File outputFile)

getAssociatedOutputs

protected Collection<? extends ResourceMetadata<File>> getAssociatedOutputs(DefaultBuildContextState state,
                                                                Object resource)

commit

public void commit(MessageSinkAdaptor messager)
            throws IOException

Throws:

IOException

finalizeContext

protected abstract void finalizeContext()
                                 throws IOException

Throws:

IOException

log

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

deleteOutput

protected void deleteOutput(File resource)
                     throws IOException

Throws:

IOException

assertOpen

protected void assertOpen()

markSkipExecution

protected 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.

isProcessedResource

protected boolean isProcessedResource(Object resource)

isProcessed

protected boolean isProcessed()

isRegisteredResource

protected boolean isRegisteredResource(Object resource)

isDeletedResource

protected boolean isDeletedResource(Object resource)

newResourceMetadata

protected <T> DefaultResourceMetadata<T> newResourceMetadata(DefaultBuildContextState state,
                                                 T resource)

newResource

protected <T> DefaultResource<T> newResource(T resource)

newOutput

protected DefaultOutput newOutput(File resource)

markUptodateOutput

protected void markUptodateOutput(File outputFile)

getOldState

public DefaultBuildContextState getOldState()

getState

public DefaultBuildContextState getState()

getState

protected DefaultBuildContextState getState(Object source)

getAttribute

protected <V extends Serializable> V getAttribute(Object resource,
                                      String key,
                                      Class<V> clazz)