com.atlassian.bamboo.build.artifact
Interface ArtifactLink

All Superinterfaces:
BambooObject
All Known Implementing Classes:
DefaultArtifactLink

public interface ArtifactLink
extends BambooObject

Interface for a simple Artifact


Field Summary
static java.lang.String SYSTEM_LINK_TYPE
          Default 'system' getLinkType()
 
Method Summary
 ResultsSummary getBuildResultsSummary()
           
 java.io.File getFile()
          Accessor for the actual file handle of the artifact.
 java.lang.String getLabel()
          Label of the Artifact
 java.lang.String getLinkType()
          Type of artifact link
 BuildResultsSummary getProducerJobResult()
           
 java.lang.String getSizeDescription()
          Returns a human-readable version of the file size, where the input represents a specific number of bytes.
 java.util.List<ConsumedSubscription> getSubscriptions()
           
 java.lang.String getUrl()
          URL of the artifact relative to AdministrationConfiguration.getBaseUrl()
 boolean isExists()
          If the artifact link exists
 boolean isSharedArtifact()
          Indicates if the artifact is a shared artifact.
 
Methods inherited from interface com.atlassian.bamboo.core.BambooObject
getId, setId
 

Field Detail

SYSTEM_LINK_TYPE

static final java.lang.String SYSTEM_LINK_TYPE
Default 'system' getLinkType()

See Also:
Constant Field Values
Method Detail

getLabel

@NotNull
java.lang.String getLabel()
Label of the Artifact

Returns:
label

getUrl

@Nullable
java.lang.String getUrl()
URL of the artifact relative to AdministrationConfiguration.getBaseUrl()

Returns:
url

isExists

boolean isExists()
If the artifact link exists

Returns:
true if the artifact exists, false otherwise

getFile

@Nullable
java.io.File getFile()
Accessor for the actual file handle of the artifact.

Returns:
a File object pointing to either the file or directory of this artifact

isSharedArtifact

boolean isSharedArtifact()
Indicates if the artifact is a shared artifact.

Returns:
true if artifact is a shared artifact.

getSizeDescription

@NotNull
java.lang.String getSizeDescription()
Returns a human-readable version of the file size, where the input represents a specific number of bytes.

Returns:
size description

getBuildResultsSummary

@Nullable
ResultsSummary getBuildResultsSummary()
Returns:
ResultsSummary which this artifact link belongs to. May be null if still not associated with ResultsSummary

getProducerJobResult

@Nullable
BuildResultsSummary getProducerJobResult()
Returns:
ResultsSummary of the Job that produced this artifact. May be null if still not associated with ResultsSummary or if it has been removed but artifact still exists.

getSubscriptions

java.util.List<ConsumedSubscription> getSubscriptions()

getLinkType

@NotNull
java.lang.String getLinkType()
Type of artifact link

Returns:
linkType


Copyright © 2011 Atlassian. All Rights Reserved.