org.springframework.roo.project

Class Dependency

java.lang.Object

org.springframework.roo.project.Dependency

All Implemented Interfaces:

Comparable<Dependency>

public class Dependency
extends Object
implements Comparable<Dependency>

Simplified immutable representation of a dependency.

Structured after the model used by Maven. This may be replaced in a future release with a more OSGi-centric model.

According to the Maven docs, "the minimal set of information for matching a dependency reference against a dependencyManagement section is actually {groupId, artifactId, type, classifier}"; see http://maven.apache.org/guides/introduction /introduction-to-dependency-mechanism.html#Dependency_Scope

Since:

1.0

Author:

Ben Alex, Stefan Schmidt, Alan Stewart, Andrew Swan, Juan Carlos García

Constructor Summary

Constructors

Constructor and Description
Dependency(Element dependency) Constructs a Dependency from a Maven-style <dependency> element.
Dependency(GAV gav, DependencyType type, DependencyScope scope) Constructor for a dependency with the given attributes.
Dependency(String groupId, String artifactId, String version) Constructs a compile-scoped JAR dependency.
Dependency(String groupId, String artifactId, String version, Collection<? extends Dependency> exclusions) Constructs a compile-scoped JAR dependency with optional exclusions.
Dependency(String groupId, String artifactId, String version, DependencyType type, DependencyScope scope) Constructs a dependency with the given type and scope.
Dependency(String groupId, String artifactId, String version, DependencyType type, DependencyScope scope, String classifier) Creates an immutable Dependency.

Method Summary

Modifier and Type	Method and Description
void	addExclusion(String exclusionGroupId, String exclusionArtifactId) Adds the given exclusion to this dependency
int	compareTo(Dependency o)
boolean	equals(Object obj)
String	getArtifactId()
String	getClassifier()
Element	getElement(Document document) Returns the XML element for this dependency
List<Dependency>	getExclusions()
String	getGroupId()
DependencyScope	getScope()
String	getSimpleDescription()
String	getSystemPath()
DependencyType	getType()
String	getVersion()
String	getVersionId() Deprecated.
int	hashCode()
boolean	hasSameCoordinates(Dependency dependency) Indicates whether the given Dependency has the same Maven coordinates as this one; this is not necessarily the same as calling equals(Object), which may compare more fields beyond the basic coordinates.
static boolean	isHigherLevel(String type1, String type2) Indicates whether one dependency type is at a higher logical level than another.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

Dependency

public Dependency(Element dependency)

Constructs a Dependency from a Maven-style <dependency> element.

Parameters:

dependency - to parse (required)

Dependency

public Dependency(GAV gav,
                  DependencyType type,
                  DependencyScope scope)

Constructor for a dependency with the given attributes.

Parameters:

gav - the coordinates to use (required)

type - the dependency type (required)

scope - the dependency scope (required)

Since:

1.2.1

Dependency

public Dependency(String groupId,
                  String artifactId,
                  String version)

Constructs a compile-scoped JAR dependency.

Parameters:

groupId - the group ID (required)

artifactId - the artifact ID (required)

version - the version (required)

Dependency

public Dependency(String groupId,
                  String artifactId,
                  String version,
                  Collection<? extends Dependency> exclusions)

Constructs a compile-scoped JAR dependency with optional exclusions.

Parameters:

groupId - the group ID (required)

artifactId - the artifact ID (required)

version - the version ID (required)

exclusions - the exclusions for this dependency (can be null)

Dependency

public Dependency(String groupId,
                  String artifactId,
                  String version,
                  DependencyType type,
                  DependencyScope scope)

Constructs a dependency with the given type and scope.

Parameters:

groupId - the group ID (required)

artifactId - the artifact ID (required)

version - the version ID (required)

type - the dependency type (required)

scope - the dependency scope (required)

Dependency

public Dependency(String groupId,
                  String artifactId,
                  String version,
                  DependencyType type,
                  DependencyScope scope,
                  String classifier)

Creates an immutable Dependency.

Parameters:

groupId - the group ID (required)

artifactId - the artifact ID (required)

version - the version ID (required)

type - the dependency type (required)

scope - the dependency scope (required)

classifier - the dependency classifier (required)

Method Detail

isHigherLevel

public static boolean isHigherLevel(String type1,
                                    String type2)

Indicates whether one dependency type is at a higher logical level than another.

Parameters:

type1 - the first dependency type to compare (required)

type2 - the second dependency type to compare (required)

Returns:

false if they are at the same level or the first is at a lower level

Since:

1.2.1

addExclusion

public void addExclusion(String exclusionGroupId,
                         String exclusionArtifactId)

Adds the given exclusion to this dependency

Parameters:

exclusionGroupId - the groupId of the dependency to exclude (required)

exclusionArtifactId - the artifactId of the dependency to exclude (required)

compareTo

public int compareTo(Dependency o)

Specified by:

compareTo in interface Comparable<Dependency>

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

getArtifactId

public String getArtifactId()

getClassifier

public String getClassifier()

getElement

public Element getElement(Document document)

Returns the XML element for this dependency

Parameters:

document - the parent XML document

Returns:

a non-null element

Since:

1.2.0

getExclusions

public List<Dependency> getExclusions()

Returns:

list of exclusions (never null)

getGroupId

public String getGroupId()

getScope

public DependencyScope getScope()

getSimpleDescription

public String getSimpleDescription()

Returns:

a simple description, as would be used for console output

getSystemPath

public String getSystemPath()

getType

public DependencyType getType()

getVersion

public String getVersion()

getVersionId

@Deprecated
public String getVersionId()

Deprecated.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

hasSameCoordinates

public boolean hasSameCoordinates(Dependency dependency)

Indicates whether the given Dependency has the same Maven coordinates as this one; this is not necessarily the same as calling equals(Object), which may compare more fields beyond the basic coordinates.

Parameters:

dependency - the dependency to check (can be null)

Returns:

false if any coordinates are different

toString

public String toString()

Overrides:

toString in class Object