Package com.atlassian.bamboo.plan.artifact

Interface ImmutableArtifactDefinitionBase

All Superinterfaces:

BambooIdProvider, NameProvider

All Known Subinterfaces:

ArtifactDefinition, ArtifactDefinitionBase, ArtifactDefinitionContext, ImmutableArtifactDefinition

All Known Implementing Classes:

ArtifactDefinitionContextImpl, ArtifactDefinitionImpl, ImmutableArtifactDefinitionImpl

public interface ImmutableArtifactDefinitionBase
extends BambooIdProvider, NameProvider

Method Summary

Modifier and Type	Method	Description
@NotNull String	getCopyPattern()	Deprecated. since 9.0 use getCopyPatterns() instead
@NotNull List<String>	getCopyPatterns()	Get artifact copy patterns
@NotNull List<String>	getExclusionPatterns()	Get artifact exclusion patterns
long	getId()	Exposes the id of the ArtifactDefinition
@Nullable String	getLocation()	Get artifact location
@NotNull String	getName()	Get artifact name
boolean	isHttpCompressionOn()
boolean	isRequired()
boolean	isSharedArtifact()	Get value of "SharedArtifact" flag.

Method Detail

getId

long getId()

Exposes the id of the ArtifactDefinition

Specified by:

getId in interface BambooIdProvider

Returns:

-1 if the id is unknown

getName

@NotNull
@NotNull String getName()

Get artifact name

Specified by:

getName in interface NameProvider

Returns:

Artifact name

getLocation

@Nullable
@Nullable String getLocation()

Get artifact location

Returns:

artifact's contents path or null if none specified (then build root is supposed to be used)

getCopyPattern

@Deprecated
@NotNull
@NotNull String getCopyPattern()

Deprecated.

since 9.0 use getCopyPatterns() instead

Get artifact copy pattern

Returns:

Ant-compatible copy pattern

getCopyPatterns

@NotNull
@NotNull List<String> getCopyPatterns()

Get artifact copy patterns

Returns:

Ant-compatible copy patterns

Since:

9.0

getExclusionPatterns

@NotNull
@NotNull List<String> getExclusionPatterns()

Get artifact exclusion patterns

Returns:

Ant-compatible exclusion patterns

Since:

9.0

isSharedArtifact

boolean isSharedArtifact()

Get value of "SharedArtifact" flag.

Returns:

true if ArtifactDefinition is marked as "SharedArtifact"

isRequired

boolean isRequired()

Returns:

true if artifact is required for successful build completion

isHttpCompressionOn

boolean isHttpCompressionOn()

Returns:

true if use of compression enabled to transfer artifact between server and agent (both directions)