org.apache.maven.artifact

Interface Artifact

public interface Artifact extends Comparable

Description of an artifact.

UNKNOWN: do we really need an interface here? get rid of the multiple states we can have (project, parent, etc artifacts, file == null, snapshot, etc) - construct subclasses and use accordingly?

Field Summary
StringLATEST_VERSION
StringRELEASE_VERSION
StringSCOPE_COMPILE
StringSCOPE_PROVIDED
StringSCOPE_RUNTIME
StringSCOPE_SYSTEM
StringSCOPE_TEST
StringSNAPSHOT_VERSION
PatternVERSION_FILE_PATTERN
Method Summary
voidaddMetadata(ArtifactMetadata metadata)
ArtifactHandlergetArtifactHandler()
StringgetArtifactId()
ListgetAvailableVersions()
StringgetBaseVersion()
StringgetClassifier()
StringgetDependencyConflictId()
ArtifactFiltergetDependencyFilter()
ListgetDependencyTrail()
StringgetDownloadUrl()
FilegetFile()
StringgetGroupId()
StringgetId()
CollectiongetMetadataList()
ArtifactRepositorygetRepository()
StringgetScope()
Get the scope of the artifact.
ArtifactVersiongetSelectedVersion()
StringgetType()
StringgetVersion()
VersionRangegetVersionRange()
booleanhasClassifier()
booleanisOptional()
booleanisRelease()
booleanisResolved()
booleanisSelectedVersionKnown()
booleanisSnapshot()
voidselectVersion(String version)
voidsetArtifactHandler(ArtifactHandler handler)
voidsetArtifactId(String artifactId)
voidsetAvailableVersions(List versions)
voidsetBaseVersion(String baseVersion)
voidsetDependencyFilter(ArtifactFilter artifactFilter)
voidsetDependencyTrail(List dependencyTrail)
voidsetDownloadUrl(String downloadUrl)
voidsetFile(File destination)
voidsetGroupId(String groupId)
voidsetOptional(boolean optional)
voidsetRelease(boolean release)
voidsetRepository(ArtifactRepository remoteRepository)
voidsetResolved(boolean resolved)
voidsetResolvedVersion(String version)
voidsetScope(String scope)
voidsetVersion(String version)
voidsetVersionRange(VersionRange newRange)
voidupdateVersion(String version, ArtifactRepository localRepository)

Field Detail

LATEST_VERSION

public String LATEST_VERSION

RELEASE_VERSION

public String RELEASE_VERSION

SCOPE_COMPILE

public String SCOPE_COMPILE

SCOPE_PROVIDED

public String SCOPE_PROVIDED

SCOPE_RUNTIME

public String SCOPE_RUNTIME

SCOPE_SYSTEM

public String SCOPE_SYSTEM

SCOPE_TEST

public String SCOPE_TEST

SNAPSHOT_VERSION

public String SNAPSHOT_VERSION

VERSION_FILE_PATTERN

public Pattern VERSION_FILE_PATTERN

Method Detail

addMetadata

public void addMetadata(ArtifactMetadata metadata)

getArtifactHandler

public ArtifactHandler getArtifactHandler()

getArtifactId

public String getArtifactId()

getAvailableVersions

public List getAvailableVersions()

getBaseVersion

public String getBaseVersion()

getClassifier

public String getClassifier()

getDependencyConflictId

public String getDependencyConflictId()

getDependencyFilter

public ArtifactFilter getDependencyFilter()

getDependencyTrail

public List getDependencyTrail()

getDownloadUrl

public String getDownloadUrl()

getFile

public File getFile()

getGroupId

public String getGroupId()

getId

public String getId()

getMetadataList

public Collection getMetadataList()

getRepository

public ArtifactRepository getRepository()

getScope

public String getScope()
Get the scope of the artifact. If the artifact is a standalone rather than a dependency, it's scope will be null. The scope may not be the same as it was declared on the original dependency, as this is the result of combining it with the main project scope.

Returns: the scope

getSelectedVersion

public ArtifactVersion getSelectedVersion()

getType

public String getType()

getVersion

public String getVersion()

getVersionRange

public VersionRange getVersionRange()

hasClassifier

public boolean hasClassifier()

isOptional

public boolean isOptional()

isRelease

public boolean isRelease()

isResolved

public boolean isResolved()

isSelectedVersionKnown

public boolean isSelectedVersionKnown()

isSnapshot

public boolean isSnapshot()

selectVersion

public void selectVersion(String version)

setArtifactHandler

public void setArtifactHandler(ArtifactHandler handler)

UNKNOWN: remove, a quick hack for the lifecycle executor

setArtifactId

public void setArtifactId(String artifactId)

setAvailableVersions

public void setAvailableVersions(List versions)

setBaseVersion

public void setBaseVersion(String baseVersion)

UNKNOWN: would like to get rid of this - or at least only have one. Base version should be immutable.

setDependencyFilter

public void setDependencyFilter(ArtifactFilter artifactFilter)

setDependencyTrail

public void setDependencyTrail(List dependencyTrail)

setDownloadUrl

public void setDownloadUrl(String downloadUrl)

setFile

public void setFile(File destination)

setGroupId

public void setGroupId(String groupId)

setOptional

public void setOptional(boolean optional)

setRelease

public void setRelease(boolean release)

setRepository

public void setRepository(ArtifactRepository remoteRepository)

setResolved

public void setResolved(boolean resolved)

setResolvedVersion

public void setResolvedVersion(String version)

setScope

public void setScope(String scope)

setVersion

public void setVersion(String version)

setVersionRange

public void setVersionRange(VersionRange newRange)

updateVersion

public void updateVersion(String version, ArtifactRepository localRepository)
Copyright © 2001-2007 Apache Software Foundation. All Rights Reserved.