org.apache.maven.mercury.artifact
Class ArtifactMetadata

java.lang.Object
  extended by org.apache.maven.mercury.artifact.ArtifactMetadata
Direct Known Subclasses:
DefaultArtifact

public class ArtifactMetadata
extends java.lang.Object

this is the most primitive metadata there is, usually used to query repository for "real" metadata. It holds everything a project.dependencies.dependency element can have

Version:
$Id: ArtifactMetadata.java 762963 2009-04-07 21:01:07Z ogusakov $
Author:
Oleg Gusakov

Field Summary
protected  java.lang.String artifactId
           
protected  ArtifactScopeEnum artifactScope
           
protected  java.lang.String artifactUri
          artifact URI
protected  java.util.Map<java.lang.String,java.lang.String> attributes
           
protected  java.lang.String classifier
           
static java.lang.String DEFAULT_ARTIFACT_TYPE
           
protected  java.util.List<ArtifactMetadata> dependencies
          dependencies of the artifact behind this metadata
protected  ArtifactCoordinates effectiveCoordinates
           
protected  java.util.Collection<ArtifactMetadata> exclusions
           
protected  java.lang.String groupId
          standard glorified artifact coordinates
protected  java.util.Collection<ArtifactMetadata> inclusions
           
protected  boolean optional
           
protected  java.util.List<ArtifactCoordinates> relocations
          relocation chain after processing by ProjectBuilder
protected  java.lang.String scope
           
protected  java.lang.String type
           
 
Constructor Summary
ArtifactMetadata()
           
ArtifactMetadata(ArtifactMetadata copyFrom)
          copy constructor
ArtifactMetadata(java.lang.String gavQuery)
          create basic out of group:artifact:version:classifier:type string, use empty string to specify missing component - for instance query for common-1.3.zip can be specified as ":common:1.3::zip" - note missing groupId and classifier.
 
Method Summary
 ArtifactMetadata addRelocation(ArtifactCoordinates coord)
           
 boolean allowDependency(ArtifactMetadata dep)
          run dependency through inclusion/exclusion filters.
static ArtifactMetadata create(java.lang.String query)
          create basic out of group:artifact:version:classifier:type string, use empty string to specify missing component - for instance query for common-1.3.zip can be specified as ":common:1.3::zip" - note missing groupId and classifier.
 boolean equals(java.lang.Object obj)
           
 java.lang.String getArtifactId()
           
 ArtifactScopeEnum getArtifactScope()
           
 java.lang.String getArtifactUri()
           
 java.util.Map<java.lang.String,java.lang.String> getAttributes()
           
 java.lang.String getBaseName()
           
 java.lang.String getBaseName(java.lang.String classifier)
           
 java.lang.String getCheckedType()
           
 java.lang.String getClassifier()
           
 java.lang.Object getDatum()
           
 java.util.List<ArtifactMetadata> getDependencies()
           
 java.lang.String getEffectiveArtifactId()
           
 ArtifactCoordinates getEffectiveCoordinates()
           
 java.lang.String getEffectiveersion()
           
 java.lang.String getEffectiveGroupId()
           
 java.util.Collection<ArtifactMetadata> getExclusions()
           
 java.lang.String getFileName()
           
 java.lang.String getGA()
           
 java.lang.String getGAV()
           
 java.lang.String getGroupId()
           
 java.util.Collection<ArtifactMetadata> getInclusions()
           
 Quality getRequestedQuality()
          code quality used to decide whether try or skip a repository - see repository code quality
 java.lang.String getScope()
           
 ArtifactScopeEnum getScopeAsEnum()
           
 java.lang.Object getTracker()
           
 java.lang.String getType()
           
 java.lang.String getVersion()
           
 boolean hasClassifier()
           
 boolean hasExclusions()
           
 int hashCode()
           
 boolean hasInclusions()
           
 boolean hasVersion()
           
 java.lang.Boolean isLocal()
           
 boolean isOptional()
           
 boolean isPom()
           
 boolean isRange()
           
 boolean isSingleton()
           
 boolean isVirtual()
           
 boolean isVirtualLatest()
           
 boolean isVirtualRelease()
           
 boolean isVirtualSnapshot()
           
 boolean sameGA(ArtifactMetadata md)
           
 boolean sameGAV(ArtifactMetadata md)
           
 void setArtifactId(java.lang.String artifactId)
           
 void setArtifactScope(ArtifactScopeEnum artifactScope)
           
 void setArtifactUri(java.lang.String artifactUri)
           
 void setClassifier(java.lang.String classifier)
           
 void setDatum(java.lang.Object datum)
           
 void setDependencies(java.util.List<ArtifactMetadata> dependencies)
           
 void setExclusions(java.util.Collection<ArtifactMetadata> exclusions)
           
 void setGroupId(java.lang.String groupId)
           
 void setInclusions(java.util.Collection<ArtifactMetadata> inclusions)
           
 void setLocal(java.lang.Boolean local)
           
 void setOptional(boolean optional)
           
 void setOptional(java.lang.String optional)
           
 void setScope(java.lang.String scope)
           
 void setTracker(java.lang.Object tracker)
           
 void setType(java.lang.String type)
           
 void setVersion(java.lang.String version)
           
 java.lang.String toDomainString()
           
 java.lang.String toManagementString()
           
 java.lang.String toScopedString()
           
 java.lang.String toString()
           
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

DEFAULT_ARTIFACT_TYPE

public static final java.lang.String DEFAULT_ARTIFACT_TYPE
See Also:
Constant Field Values

groupId

protected java.lang.String groupId
standard glorified artifact coordinates


artifactId

protected java.lang.String artifactId

relocations

protected java.util.List<ArtifactCoordinates> relocations
relocation chain after processing by ProjectBuilder


effectiveCoordinates

protected ArtifactCoordinates effectiveCoordinates

classifier

protected java.lang.String classifier

type

protected java.lang.String type

artifactScope

protected ArtifactScopeEnum artifactScope

scope

protected java.lang.String scope

optional

protected boolean optional

inclusions

protected java.util.Collection<ArtifactMetadata> inclusions

exclusions

protected java.util.Collection<ArtifactMetadata> exclusions

attributes

protected java.util.Map<java.lang.String,java.lang.String> attributes

dependencies

protected java.util.List<ArtifactMetadata> dependencies
dependencies of the artifact behind this metadata


artifactUri

protected java.lang.String artifactUri
artifact URI

Constructor Detail

ArtifactMetadata

public ArtifactMetadata()

ArtifactMetadata

public ArtifactMetadata(java.lang.String gavQuery)
create basic out of group:artifact:version:classifier:type string, use empty string to specify missing component - for instance query for common-1.3.zip can be specified as ":common:1.3::zip" - note missing groupId and classifier.


ArtifactMetadata

public ArtifactMetadata(ArtifactMetadata copyFrom)
copy constructor

Parameters:
copyFrom -
Method Detail

create

public static ArtifactMetadata create(java.lang.String query)
create basic out of group:artifact:version:classifier:type string, use empty string to specify missing component - for instance query for common-1.3.zip can be specified as ":common:1.3::zip" - note missing groupId and classifier.


sameGAV

public boolean sameGAV(ArtifactMetadata md)

sameGA

public boolean sameGA(ArtifactMetadata md)

getGA

public java.lang.String getGA()

getGAV

public java.lang.String getGAV()

toString

public java.lang.String toString()
Overrides:
toString in class java.lang.Object

toScopedString

public java.lang.String toScopedString()

toDomainString

public java.lang.String toDomainString()

toManagementString

public java.lang.String toManagementString()

getBaseName

public java.lang.String getBaseName()

getFileName

public java.lang.String getFileName()

getBaseName

public java.lang.String getBaseName(java.lang.String classifier)

getCheckedType

public java.lang.String getCheckedType()

getGroupId

public java.lang.String getGroupId()

setGroupId

public void setGroupId(java.lang.String groupId)

getArtifactId

public java.lang.String getArtifactId()

setArtifactId

public void setArtifactId(java.lang.String artifactId)

getVersion

public java.lang.String getVersion()

hasVersion

public boolean hasVersion()

setVersion

public void setVersion(java.lang.String version)

isSingleton

public boolean isSingleton()

isRange

public boolean isRange()

getRequestedQuality

public Quality getRequestedQuality()
code quality used to decide whether try or skip a repository - see repository code quality


getClassifier

public java.lang.String getClassifier()

setClassifier

public void setClassifier(java.lang.String classifier)

getType

public java.lang.String getType()

setType

public void setType(java.lang.String type)

getAttributes

public java.util.Map<java.lang.String,java.lang.String> getAttributes()

getScope

public java.lang.String getScope()

getScopeAsEnum

public ArtifactScopeEnum getScopeAsEnum()

getArtifactScope

public ArtifactScopeEnum getArtifactScope()

setArtifactScope

public void setArtifactScope(ArtifactScopeEnum artifactScope)

setScope

public void setScope(java.lang.String scope)

isOptional

public boolean isOptional()

setOptional

public void setOptional(boolean optional)

setOptional

public void setOptional(java.lang.String optional)

getTracker

public java.lang.Object getTracker()

setTracker

public void setTracker(java.lang.Object tracker)

hasClassifier

public boolean hasClassifier()

isLocal

public java.lang.Boolean isLocal()

setLocal

public void setLocal(java.lang.Boolean local)

isPom

public boolean isPom()

isVirtual

public boolean isVirtual()

isVirtualSnapshot

public boolean isVirtualSnapshot()

isVirtualRelease

public boolean isVirtualRelease()

isVirtualLatest

public boolean isVirtualLatest()

getEffectiveCoordinates

public ArtifactCoordinates getEffectiveCoordinates()

addRelocation

public ArtifactMetadata addRelocation(ArtifactCoordinates coord)

getEffectiveGroupId

public java.lang.String getEffectiveGroupId()

getEffectiveArtifactId

public java.lang.String getEffectiveArtifactId()

getEffectiveersion

public java.lang.String getEffectiveersion()

hasInclusions

public boolean hasInclusions()

getInclusions

public java.util.Collection<ArtifactMetadata> getInclusions()

setInclusions

public void setInclusions(java.util.Collection<ArtifactMetadata> inclusions)

hasExclusions

public boolean hasExclusions()

getExclusions

public java.util.Collection<ArtifactMetadata> getExclusions()

setExclusions

public void setExclusions(java.util.Collection<ArtifactMetadata> exclusions)

allowDependency

public boolean allowDependency(ArtifactMetadata dep)
                        throws VersionException
run dependency through inclusion/exclusion filters. Inclusion filter is always a "hole"-filter, which is then enhanced by exclusion "cork"-filter

Parameters:
dep - dependency to vet
Returns:
vet result
Throws:
VersionException

equals

public boolean equals(java.lang.Object obj)
Overrides:
equals in class java.lang.Object

hashCode

public int hashCode()
Overrides:
hashCode in class java.lang.Object

getDependencies

public java.util.List<ArtifactMetadata> getDependencies()

setDependencies

public void setDependencies(java.util.List<ArtifactMetadata> dependencies)

getArtifactUri

public java.lang.String getArtifactUri()

setArtifactUri

public void setArtifactUri(java.lang.String artifactUri)

getDatum

public java.lang.Object getDatum()

setDatum

public void setDatum(java.lang.Object datum)


Copyright © 2002-2011 Apache Software Foundation. All Rights Reserved.