Package org.apache.maven.artifact.resolver

Class ArtifactResolutionResult

java.lang.Object

org.apache.maven.artifact.resolver.ArtifactResolutionResult

public class ArtifactResolutionResult
extends Object

Specific problems during resolution that we want to account for:

• missing metadata
• version range violations
• version circular dependencies
• missing artifacts
• network/transfer errors
• file system errors: permissions

Author:

Jason van Zyl TODO carlos: all these possible has*Exceptions and get*Exceptions methods make the clients too complex requiring a long list of checks, need to create a parent/interface/encapsulation for the types of exceptions

Constructor Summary

Constructors

Constructor	Description
ArtifactResolutionResult()

Method Summary

Modifier and Type	Method	Description
void	addArtifact(Artifact artifact)
ArtifactResolutionResult	addCircularDependencyException(CyclicDependencyException e)
ArtifactResolutionResult	addErrorArtifactException(ArtifactResolutionException e)
ArtifactResolutionResult	addMetadataResolutionException(ArtifactResolutionException e)
ArtifactResolutionResult	addMissingArtifact(Artifact artifact)
ArtifactResolutionResult	addVersionRangeViolation(Exception e)	TODO this needs to accept a OverConstrainedVersionException as returned by getVersionRangeViolation(int) but it's not used like that in DefaultLegacyArtifactCollector
Set<ResolutionNode>	getArtifactResolutionNodes()
Set<Artifact>	getArtifacts()
CyclicDependencyException	getCircularDependencyException(int i)
List<CyclicDependencyException>	getCircularDependencyExceptions()
List<ArtifactResolutionException>	getErrorArtifactExceptions()
List<Exception>	getExceptions()
ArtifactResolutionException	getMetadataResolutionException(int i)
List<ArtifactResolutionException>	getMetadataResolutionExceptions()
List<Artifact>	getMissingArtifacts()
Artifact	getOriginatingArtifact()
List<ArtifactRepository>	getRepositories()
OverConstrainedVersionException	getVersionRangeViolation(int i)
List<Exception>	getVersionRangeViolations()
boolean	hasCircularDependencyExceptions()
boolean	hasErrorArtifactExceptions()
boolean	hasExceptions()
boolean	hasMetadataResolutionExceptions()
boolean	hasMissingArtifacts()
boolean	hasVersionRangeViolations()
boolean	isSuccess()
void	setArtifactResolutionNodes(Set<ResolutionNode> resolutionNodes)
void	setArtifacts(Set<Artifact> artifacts)
ArtifactResolutionResult	setOriginatingArtifact(Artifact originatingArtifact)
ArtifactResolutionResult	setRepositories(List<ArtifactRepository> repositories)
ArtifactResolutionResult	setUnresolvedArtifacts(List<Artifact> unresolvedArtifacts)
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

ArtifactResolutionResult

public ArtifactResolutionResult()

Method Details

getOriginatingArtifact

public Artifact getOriginatingArtifact()

setOriginatingArtifact

public ArtifactResolutionResult setOriginatingArtifact(Artifact originatingArtifact)

addArtifact

public void addArtifact(Artifact artifact)

getArtifacts

public Set<Artifact> getArtifacts()

setArtifacts

public void setArtifacts(Set<Artifact> artifacts)

getArtifactResolutionNodes

public Set<ResolutionNode> getArtifactResolutionNodes()

setArtifactResolutionNodes

public void setArtifactResolutionNodes(Set<ResolutionNode> resolutionNodes)

hasMissingArtifacts

public boolean hasMissingArtifacts()

getMissingArtifacts

public List<Artifact> getMissingArtifacts()

addMissingArtifact

public ArtifactResolutionResult addMissingArtifact(Artifact artifact)

setUnresolvedArtifacts

public ArtifactResolutionResult setUnresolvedArtifacts(List<Artifact> unresolvedArtifacts)

isSuccess

public boolean isSuccess()

hasExceptions

public boolean hasExceptions()

getExceptions

public List<Exception> getExceptions()

hasVersionRangeViolations

public boolean hasVersionRangeViolations()

addVersionRangeViolation

public ArtifactResolutionResult addVersionRangeViolation(Exception e)

TODO this needs to accept a OverConstrainedVersionException as returned by getVersionRangeViolation(int) but it's not used like that in DefaultLegacyArtifactCollector

Parameters:

e - an exception

Returns:

this

getVersionRangeViolation

public OverConstrainedVersionException getVersionRangeViolation(int i)

getVersionRangeViolations

public List<Exception> getVersionRangeViolations()

hasMetadataResolutionExceptions

public boolean hasMetadataResolutionExceptions()

addMetadataResolutionException

public ArtifactResolutionResult addMetadataResolutionException(ArtifactResolutionException e)

getMetadataResolutionException

public ArtifactResolutionException getMetadataResolutionException(int i)

getMetadataResolutionExceptions

public List<ArtifactResolutionException> getMetadataResolutionExceptions()

hasErrorArtifactExceptions

public boolean hasErrorArtifactExceptions()

addErrorArtifactException

public ArtifactResolutionResult addErrorArtifactException(ArtifactResolutionException e)

getErrorArtifactExceptions

public List<ArtifactResolutionException> getErrorArtifactExceptions()

hasCircularDependencyExceptions

public boolean hasCircularDependencyExceptions()

addCircularDependencyException

public ArtifactResolutionResult addCircularDependencyException(CyclicDependencyException e)

getCircularDependencyException

public CyclicDependencyException getCircularDependencyException(int i)

getCircularDependencyExceptions

public List<CyclicDependencyException> getCircularDependencyExceptions()

getRepositories

public List<ArtifactRepository> getRepositories()

setRepositories

public ArtifactResolutionResult setRepositories(List<ArtifactRepository> repositories)

toString

public String toString()

Overrides:

toString in class Object