com.atlassian.bamboo.plan.artifact

Interface ImmutableArtifactDefinitionBase

All Superinterfaces:

BambooIdProvider, ImmutableEntityWithOid, NameProvider

All Known Subinterfaces:

ArtifactDefinition, ArtifactDefinitionBase, ArtifactDefinitionContext, ImmutableArtifactDefinition

All Known Implementing Classes:

ArtifactDefinitionContextImpl, ArtifactDefinitionImpl, ImmutableArtifactDefinitionImpl

public interface ImmutableArtifactDefinitionBase
extends BambooIdProvider, NameProvider, ImmutableEntityWithOid

Method Summary

Modifier and Type	Method and Description
String	getCopyPattern() Get artifact copy pattern
default BambooEntityType	getEntityType() Entity type of this object, used in BambooEntityOid.
long	getId() Exposes the id of the ArtifactDefinition
String	getLocation() Get artifact location
String	getName() Get artifact name
boolean	isRequired()
boolean	isSharedArtifact() Get value of "SharedArtifact" flag.

Methods inherited from interface com.atlassian.bamboo.core.ImmutableEntityWithOid

getOid

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
String getName()

Get artifact name

Specified by:

getName in interface NameProvider

Returns:

Artifact name

getLocation

@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

@NotNull
String getCopyPattern()

Get artifact copy pattern

Returns:

Ant-compatible copy pattern

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

getEntityType

default BambooEntityType getEntityType()

Description copied from interface: ImmutableEntityWithOid

Entity type of this object, used in BambooEntityOid.

Specified by:

getEntityType in interface ImmutableEntityWithOid