com.atlassian.bamboo.plan.artifact
Interface ArtifactDefinitionBase

All Superinterfaces:

NameProvider

All Known Subinterfaces:

ArtifactDefinition, ArtifactDefinitionContext

All Known Implementing Classes:

ArtifactDefinitionContextImpl, ArtifactDefinitionImpl

public interface ArtifactDefinitionBase
extends NameProvider

Method Summary

java.lang.String	getCopyPattern() Get artifact copy pattern
long	getId() Exposes the id of the ArtifactDefinition
java.lang.String	getLocation() Get artifact location
java.lang.String	getName() Get artifact name
boolean	isSharedArtifact() Get value of "SharedArtifact" flag.
void	setCopyPattern(java.lang.String copyPattern) Set copy pattern
void	setLocation(java.lang.String location) Set artifact location
void	setName(java.lang.String name) Set label
void	setSharedArtifact(boolean sharedArtifact) Set "SharedArtifact" flag

Method Detail

getId

long getId()

Exposes the id of the ArtifactDefinition

Returns:

-1 if the id is unknown

getName

@NotNull
java.lang.String getName()

Get artifact name

Specified by:

getName in interface NameProvider

Returns:

Artifact name

setName

void setName(@NotNull
             java.lang.String name)

Set label

Parameters:

name - new value of label

getLocation

@Nullable
java.lang.String getLocation()

Get artifact location

Returns:

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

setLocation

void setLocation(@Nullable
                 java.lang.String location)

Set artifact location

Parameters:

location - new artifact location

getCopyPattern

@NotNull
java.lang.String getCopyPattern()

Get artifact copy pattern

Returns:

Ant-compatible copy pattern

setCopyPattern

void setCopyPattern(@NotNull
                    java.lang.String copyPattern)

Set copy pattern

Parameters:

copyPattern - new value of copy pattern

isSharedArtifact

boolean isSharedArtifact()

Get value of "SharedArtifact" flag.

Returns:

true if ArtifactDefinition is marked as "SharedArtifact"

setSharedArtifact

void setSharedArtifact(boolean sharedArtifact)

Set "SharedArtifact" flag

Parameters:

sharedArtifact - new value of "SharedArtifact" flag