org.azyva.dragom.model

Class ArtifactVersion

java.lang.Object

org.azyva.dragom.model.ArtifactVersion

public final class ArtifactVersion
extends Object

Version of an artifact produced by the build of a Module.

Implements value semantics. Instances are immutable.

Implements hashCode() and equals(java.lang.Object) so that instances can be used as Map keys.

This class is essentially the artifact counterpart of the source-level Version. One reason for having two separate classes is to help avoid type mismatch and ensuring type safety.

As for Version, two types of ArtifactVersion's are recognized:

• Dynamic: Refers to a state of something that can change. This type of ArtifactVersion is generally called a SNAPSHOT.
• Static: Refers to a state of something that is fixed, immutable. This type of ArtifactVersion is generally called a release.

An ArtifactVersion is essentially a String. This class offers additional methods which handle the distinction between dynamic and static ArtifactVersion's.

ArtifactVersion's are assumed to be of the form <version>[-SNAPSHOT]. If the -SNAPSHOT suffix is present the ArtifactVersion is considered dynamic. If the -SNAPSHOT suffix is not present, it is considered static.

No other assumption is made on the format of ArtifactVersion's (numeric, semantic, date-based, etc.).

The -SNAPSHOT convention is borrowed from Maven so it could be said that this implementation is somewhat Maven-specific. But we assume that this convention is sufficiently generic to not be considered Maven-specific. Time and experience will tell if this proves wrong and adjustments may be required in the future to keep things clean.

Author:

David Raymond

Field Summary

Fields

Modifier and Type	Field and Description
static String	DYNAMIC_VERSION_SUFFIX Suffix for dynamic ArtifactVersion.

Constructor Summary

Constructors

Constructor and Description
ArtifactVersion(String stringArtifactVersion) Constructor using an ArtifactVersion literal.
ArtifactVersion(VersionType versionType, String version) Constructor using the individual fields.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object other)
Version	getCorrespondingVersion() Returns a Version corresponding to this ArtifactVersion assuming a direct equivalence between the two.
String	getVersion()
VersionType	getVersionType()
int	hashCode()
static ArtifactVersion	parse(String stringArtifactVersion) Parses an ArtifactVersion literal.
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

DYNAMIC_VERSION_SUFFIX

public static final String DYNAMIC_VERSION_SUFFIX

Suffix for dynamic ArtifactVersion.

See Also:

Constant Field Values

Constructor Detail

ArtifactVersion

public ArtifactVersion(VersionType versionType,
                       String version)

Constructor using the individual fields.

Parameters:

versionType - VersionType.

version - Version string, without the -SNAPSHOT suffix for a dynamic version.

ArtifactVersion

public ArtifactVersion(String stringArtifactVersion)

Constructor using an ArtifactVersion literal.

Throws RuntimeException if parsing fails.

Parameters:

stringArtifactVersion - ArtifactVersion literal.

Method Detail

parse

public static ArtifactVersion parse(String stringArtifactVersion)
                             throws ParseException

Parses an ArtifactVersion literal.

Parameters:

stringArtifactVersion - ArtifactVersion literal.

Returns:

ArtifactVersion.

Throws:

ParseException - If parsing fails.

getVersionType

public VersionType getVersionType()

Returns:

VersionType.

getVersion

public String getVersion()

Returns:

Version string, without the -SNAPSHOT suffix for a dynamic version.

getCorrespondingVersion

public Version getCorrespondingVersion()

Returns a Version corresponding to this ArtifactVersion assuming a direct equivalence between the two.

Note that the mapping between ArtifactVersion and Version during tool execution is generally handled by ArtifactVersionMapperPlugin. This method implements a very simple mapping which is only one possible mapping. ArtifactVersionMapperPlugin must generally be used so that module-specific mapping algorithms can be honored.

Returns:

Version.

toString

public String toString()

Overrides:

toString in class Object

Returns:

ArtifactVersion literal.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object other)

Overrides:

equals in class Object