org.azyva.dragom.reference

Class Reference

java.lang.Object

org.azyva.dragom.reference.Reference

public final class Reference
extends Object

Class representing a reference.

Although this class is final so that it cannot be derived, extra implementation data can be attached using the implData property. This is useful since References are generally specific to some build tool and build-tool-specific NodePlugin's such as ReferenceManagerPlugin may need to include extra implementation data.

When implData is specified, it is used in the following way by this class:

• It is included in equality tests (equals and equalsNoVersion method). The equals method should not consider any version information so that it can be used by equals and equalsNoVersion. If ever extra implementation data contains version information, it should be the same as that maintained by this class, which considers it for equals;
• Its hashCode is used to compute this class' hashCode;
• Its string representation (toString method) is included in the string representation of this class, unless it is null or the empty string. In turn, the string representation of this class is used in various messages provided to the user;
• It is intended to be useful to implementations of plugins which use Reference's (e.g. ReferenceManagerPlugin in order to map them to internal references that are specific to various SCM.

This class implements value semantics and is immutable.

Constructor Summary

Constructors

Constructor and Description
Reference(ModuleVersion moduleVersion) Constructor for a source-level reference, or when artifact-level reference is not important.
Reference(ModuleVersion moduleVersion, ArtifactGroupId artifactGroupId, ArtifactVersion artifactVersion) Constructor with no extra implementation data.
Reference(ModuleVersion moduleVersion, ArtifactGroupId artifactGroupId, ArtifactVersion artifactVersion, Object implData) Constructor.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object other)
boolean	equalsNoVersion(Reference referenceOther) Tests equality between two Reference without considering the Version and ArtifactVersion.
ArtifactGroupId	getArtifactGroupId()
ArtifactVersion	getArtifactVersion()
Object	getImplData()
ModuleVersion	getModuleVersion()
int	hashCode()
String	toString() Reference's are often displayed to the user and need to be shown in a human- friendly and not too cryptic way.

Methods inherited from class java.lang.Object

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

Constructor Detail

Reference

public Reference(ModuleVersion moduleVersion,
                 ArtifactGroupId artifactGroupId,
                 ArtifactVersion artifactVersion,
                 Object implData)

Constructor.

Parameters:

moduleVersion - ModuleVersion.

artifactGroupId - ArtifactGroupId.

artifactVersion - ArtifactVersion.

implData - Extra implementation data.

Reference

public Reference(ModuleVersion moduleVersion,
                 ArtifactGroupId artifactGroupId,
                 ArtifactVersion artifactVersion)

Constructor with no extra implementation data.

Parameters:

moduleVersion - ModuleVersion.

artifactGroupId - ArtifactGroupId.

artifactVersion - ArtifactVersion.

Reference

public Reference(ModuleVersion moduleVersion)

Constructor for a source-level reference, or when artifact-level reference is not important.

Parameters:

moduleVersion - ModuleVersion.

Method Detail

getModuleVersion

public ModuleVersion getModuleVersion()

Returns:

ModuleVersion.

getArtifactGroupId

public ArtifactGroupId getArtifactGroupId()

Returns:

ArtifactGroupId.

getArtifactVersion

public ArtifactVersion getArtifactVersion()

Returns:

ArtifactVersion.

getImplData

public Object getImplData()

Returns:

Extra implementation data.

toString

public String toString()

Reference's are often displayed to the user and need to be shown in a human- friendly and not too cryptic way.

When Reference's are shown to the user they are generally as part of a ReferencePath which puts the Reference's in context.

Overrides:

toString in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object other)

Overrides:

equals in class Object

equalsNoVersion

public boolean equalsNoVersion(Reference referenceOther)

Tests equality between two Reference without considering the Version and ArtifactVersion. This is useful when the Version of a Reference can change within a collection and we want to find the original Reference.

Parameters:

referenceOther - Other Reference.

Returns:

If the Reference is equal to referenceOther.