Package com.polarion.alm.builder.spi

Interface IBuildArtifactEngineer.IEngineeringContext

Enclosing interface:

IBuildArtifactEngineer

public static interface IBuildArtifactEngineer.IEngineeringContext

Components and methods necessary for all engineering work.

Some of the components may be missing (depends on called method).

Version:

$Revision$ $Date$

Author:

Stepan Roh, Polarion Software

Method Summary

Modifier and Type	Method	Description
IContextualBuildArtifact	getContextualBuildArtifact()	Contextual build artifact.
IContextualBuildArtifactRepository	getContextualBuildArtifactRepository()	Contextual source repository.
IPreparedBuildArtifact	getPreparedBuildArtifact()	Prepared build artifact.
ISourceRepository	getSourceRepository()	Source repository.
void	registerOutputFile(File file)	Register output file whose contents should be logged during build.

Method Details

getPreparedBuildArtifact

IPreparedBuildArtifact getPreparedBuildArtifact()

Prepared build artifact.

Available only for IBuildArtifactEngineer.amendBuildArtifact(IEngineeringContext).

Returns:

prepared build artifact or null

getContextualBuildArtifact

IContextualBuildArtifact getContextualBuildArtifact()

Contextual build artifact.

Not available only for IBuildArtifactEngineer.amendBuildArtifact(IEngineeringContext).

Returns:

contextual build artifact or null

getSourceRepository

ISourceRepository getSourceRepository()

Source repository.

Available for all methods.

Returns:

source repository

getContextualBuildArtifactRepository

IContextualBuildArtifactRepository getContextualBuildArtifactRepository()

Contextual source repository.

Available if getContextualBuildArtifact() is available.

Returns:

contextual build artifact repository or null

registerOutputFile

void registerOutputFile(File file)

Register output file whose contents should be logged during build.

Available only for IBuildArtifactEngineer.createPOMFile(com.polarion.alm.builder.spi.IBuildArtifactEngineer.IEngineeringContext, String, String, File).

It is OK if given file does not (or will not exist).

Parameters:

file - file

Throws:

IllegalArgumentException - if file is null

IllegalStateException - if not called during IBuildArtifactEngineer.createPOMFile(com.polarion.alm.builder.spi.IBuildArtifactEngineer.IEngineeringContext, String, String, File)