org.jboss.shrinkwrap.resolver.impl.maven.coordinate

Class MavenDependencyImpl

java.lang.Object

org.jboss.shrinkwrap.resolver.impl.maven.coordinate.MavenDependencyImpl

All Implemented Interfaces:

MavenCoordinate, MavenDependency, MavenDependencySPI

public final class MavenDependencyImpl
extends Object
implements MavenDependencySPI

Immutable, thread-safe implementation of a MavenDependency

Author:

Andrew Lee Rubinger

Constructor Summary

Constructors

Constructor and Description
MavenDependencyImpl(MavenCoordinate coordinate, ScopeType scope, boolean optional, boolean undeclaredScope, MavenDependencyExclusion... exclusions) Creates a new instance with the specified properties.
MavenDependencyImpl(MavenCoordinate coordinate, ScopeType scope, boolean optional, MavenDependencyExclusion... exclusions) Creates a new instance with the specified properties.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj) Determines whether two MavenCoordinate instances are equal by value; all fields are considered except for version
String	getArtifactId() Returns the "artifactId" portion of this artifact's coordinates
String	getClassifier() Returns the "classifier" portion of this artifact's coordinates.
Set<MavenDependencyExclusion>	getExclusions() Returns the exclusions defined for this MavenDependency in an immutable, read-only view.
String	getGroupId() Returns the "groupId" portion of this artifact's coordinates
PackagingType	getPackaging() Returns the "packaging" portion of this artifact's coordinates; always returns a value.
ScopeType	getScope() Returns the scope for this MavenDependency.
PackagingType	getType() Alias to MavenCoordinate.getPackaging().
String	getVersion() Returns the declared "version" portion of this artifact's coordinates, for instance "1.2.0-alpha-2" or "1.2.0-SNAPSHOT".
int	hashCode()
boolean	isOptional() Returns whether or not this MavenDependency has been marked as optional; defaults to false
boolean	isUndeclaredScope() Denotes that the scope defined here should be treated as undeclared (as brought in via <dependencyManagement with no scope associated)
String	toCanonicalForm() Returns the canonical form of this Coordinate
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

MavenDependencyImpl

public MavenDependencyImpl(MavenCoordinate coordinate,
                           ScopeType scope,
                           boolean optional,
                           MavenDependencyExclusion... exclusions)

Creates a new instance with the specified properties. If no ScopeType is specified, default will be ScopeType.COMPILE. undeclaredScope will be set to false

Parameters:

coordinate - A coordinate Delegate, required

scope - A scope

optional - Whether or not this MavenDependency has been marked as optional.

exclusions - MavenDependencyExclusions, if null will be ignored

MavenDependencyImpl

public MavenDependencyImpl(MavenCoordinate coordinate,
                           ScopeType scope,
                           boolean optional,
                           boolean undeclaredScope,
                           MavenDependencyExclusion... exclusions)

Creates a new instance with the specified properties. If no ScopeType is specified, default will be ScopeType.COMPILE.

Parameters:

coordinate - A coordinate Delegate, required

scope - A scope

optional - Whether or not this MavenDependency has been marked as optional.

undeclaredScope - Whether there is no scope

exclusions - MavenDependencyExclusions, if null will be ignored

Method Detail

getGroupId

public String getGroupId()

Returns the "groupId" portion of this artifact's coordinates see: org.jboss.shrinkwrap.resolver.api.maven.coordinate.MavenGABaseImpl#getGroupId()

Returns:

The "groupId" portion of this artifact's coordinates

toCanonicalForm

public String toCanonicalForm()

Returns the canonical form of this Coordinate

Returns:

the canonical form of this Coordinate

See Also:

Coordinate.toCanonicalForm()

getArtifactId

public String getArtifactId()

Returns the "artifactId" portion of this artifact's coordinates see: org.jboss.shrinkwrap.resolver.api.maven.coordinate.MavenGABaseImpl#getArtifactId()

Returns:

The "artifactId" portion of this artifact's coordinates

getPackaging

public PackagingType getPackaging()

Returns the "packaging" portion of this artifact's coordinates; always returns a value. Defaults to PackagingType.JAR.

Specified by:

getPackaging in interface MavenCoordinate

Returns:

The "packaging" portion of this artifact's coordinates

See Also:

MavenCoordinate.getPackaging()

getType

public PackagingType getType()

Alias to MavenCoordinate.getPackaging().

Specified by:

getType in interface MavenCoordinate

Returns:

The "packaging" portion of this artifact's coordinates

See Also:

MavenCoordinate.getType()

getClassifier

public String getClassifier()

Returns the "classifier" portion of this artifact's coordinates.

Specified by:

getClassifier in interface MavenCoordinate

Returns:

The "classifier" portion of this artifact's coordinates.

See Also:

MavenCoordinate.getClassifier()

getVersion

public String getVersion()

Returns the declared "version" portion of this artifact's coordinates, for instance "1.2.0-alpha-2" or "1.2.0-SNAPSHOT". This is the value of the "version" field as declared in the POM. During artifact resolution, SNAPSHOT versions may be set to a fixed SNAPSHOT as represented by MavenArtifactInfo.getResolvedVersion().

Specified by:

getVersion in interface MavenCoordinate

Returns:

The base version, never null.

See Also:

MavenCoordinate.getVersion()

getExclusions

public Set<MavenDependencyExclusion> getExclusions()

Returns the exclusions defined for this MavenDependency in an immutable, read-only view. If no exclusions are defined, an empty Set will be returned.

Specified by:

getExclusions in interface MavenDependency

Returns:

The exclusions defined for this MavenDependency in an immutable, read-only view. An empty Set if no exclusions are defined.

See Also:

MavenDependency.getExclusions()

getScope

public ScopeType getScope()

Returns the scope for this MavenDependency. Never returns null; if no scope has been explicitly-defined, the default ScopeType.COMPILE will be returned.

Specified by:

getScope in interface MavenDependency

Returns:

The scope for this MavenDependency. The default ScopeType.COMPILE if no scope has been explicitly-defined. Never returns null.

See Also:

MavenDependency.getScope()

isOptional

public boolean isOptional()

Returns whether or not this MavenDependency has been marked as optional; defaults to false

Specified by:

isOptional in interface MavenDependency

Returns:

Whether or not this MavenDependency has been marked as optional. Defaults to false

See Also:

MavenDependency.isOptional()

isUndeclaredScope

public boolean isUndeclaredScope()

Denotes that the scope defined here should be treated as undeclared (as brought in via <dependencyManagement with no scope associated)

Specified by:

isUndeclaredScope in interface MavenDependencySPI

Returns:

Whether the scope defined here should be treated as undeclared

See Also:

MavenDependencySPI.isUndeclaredScope()

hashCode

public int hashCode()

Specified by:

hashCode in interface MavenCoordinate

Overrides:

hashCode in class Object

See Also:

Object.hashCode()

equals

public boolean equals(Object obj)

Determines whether two MavenCoordinate instances are equal by value; all fields are considered except for version

Specified by:

equals in interface MavenCoordinate

Overrides:

equals in class Object

See Also:

Object.equals(java.lang.Object)

toString

public String toString()

Overrides:

toString in class Object

See Also:

Object.toString()