Package com.polarion.alm.builder.spi

Interface IPreparedBuildArtifact

All Superinterfaces:

IBuildArtifactRecognizer.IRecognizedBuildArtifact

public interface IPreparedBuildArtifact
extends IBuildArtifactRecognizer.IRecognizedBuildArtifact

Allows IBuildArtifactEngineer.amendBuildArtifact(IEngineeringContext) to populate build artifact with some values.

Version:

$Revision$ $Date$

Author:

Stepan Roh, Polarion Software

See Also:

• IBuildArtifact
• IBuildArtifactRecognizer.IRecognizedBuildArtifact

Method Summary

Modifier and Type	Method	Description
void	addAggregationResource(ILocalDeploymentDefinition resource)	Add aggregation resource definition.
void	addBuildDependency(IBuildArtifactSelector selector)	Add build dependency.
void	addContainedArtifact(IBuildArtifactSelector selector)	Add contained artifact.
void	addResource(ILocalDeploymentDefinition resource)	Add resource definition.
void	setArtifactId(String artifactId)	Set artifact id.
void	setDescription(String description)	Set description.
void	setGroupId(String groupId)	Set group id.
void	setLabel(String label)	Set label.
void	setTypeSpecificValue(String key, String value)	Set type specific data.

Methods inherited from interface com.polarion.alm.builder.spi.IBuildArtifactRecognizer.IRecognizedBuildArtifact

getAggregationResources, getBaseLocation, getConfiguration, getRepositoryTag, getResources, getType

Method Details

setGroupId

void setGroupId(String groupId)

Set group id.

Parameters:

groupId - group id

Throws:

IllegalArgumentException - if groupId is null

See Also:

• IBuildArtifact.getGroupId()

setArtifactId

void setArtifactId(String artifactId)

Set artifact id.

Parameters:

artifactId - group id

Throws:

IllegalArgumentException - if artifactId is null

See Also:

• IBuildArtifact.getArtifactId()

setLabel

void setLabel(String label)

Set label.

Parameters:

label - label

Throws:

IllegalArgumentException - if label is null

See Also:

• IBuildArtifact.getLabel()

setDescription

void setDescription(String description)

Set description.

Parameters:

description - description (may be null)

See Also:

• IBuildArtifact.getDescription()

addContainedArtifact

void addContainedArtifact(IBuildArtifactSelector selector)

Add contained artifact.

All selector's fields are treated literally (no pattern matching).

Selector's IBuildArtifactSelector.getRepositoryTag() is ignored and this artifact's repository tag is used.

Artifacts are assumed to be in the same IGroupEntity as this artifact is (no actual checking is done).

Parameters:

selector - artifact selector

Throws:

IllegalArgumentException - if selector is null

See Also:

• IBuildArtifact.getContainedArtifacts()

addBuildDependency

void addBuildDependency(IBuildArtifactSelector selector)

Add build dependency.

All selector's fields are treated literally (no pattern matching).

Parameters:

selector - artifact selector

Throws:

IllegalArgumentException - if selector is null

See Also:

• IBuildArtifact.getBuildDependencies()

addResource

void addResource(ILocalDeploymentDefinition resource)

Add resource definition.

Note that if resources were already specified by user, then this call is ignored.

Parameters:

resource - resource definition

Throws:

IllegalArgumentException - if resource is null

See Also:

• IBuildArtifact.getResources()

addAggregationResource

void addAggregationResource(ILocalDeploymentDefinition resource)

Add aggregation resource definition.

Note that if aggregation resources were already specified by user, then this call is ignored.

Parameters:

resource - resource definition

Throws:

IllegalArgumentException - if resource is null

See Also:

• IBuildArtifact.getAggregationResources()

setTypeSpecificValue

void setTypeSpecificValue(String key,
 String value)

Set type specific data.

Parameters:

key - data kay

value - data value (can be null)

Throws:

IllegalArgumentException - if key is null