org.azyva.dragom.model

Class Version

java.lang.Object

org.azyva.dragom.model.Version

public final class Version
extends Object

Version of a Module at the source level.

Implements value semantics. Instances are immutable.

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

Two types of Version's are recognized:

• Dynamic: Refers to a state of something that can change. This type of Version is generally called a branch.
• Static: Refers to a state of something that is fixed, immutable. This type of Version is generally called a tag.

Version support the literal form [D|S]/<version>, where the D or S prefix differentiates between a dynamic and static Version. This format is Dragom-specific and SCM independent. It is up to ScmPlugin to interpret Version's in a way that can be handled by the SCM. For example a Version such as D/develop-my-project could be mapped to refs/heads/develop-my-project for Git and branches/develop-my-project for Subversion.

Author:

David Raymond

Constructor Summary

Constructors

Constructor and Description
Version(String stringVersion) Constructor using a Version literal.
Version(VersionType versionType, String version) Constructor using the individual fields.

Method Summary

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

Methods inherited from class java.lang.Object

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

Constructor Detail

Version

public Version(VersionType versionType,
               String version)

Constructor using the individual fields.

Parameters:

versionType - VersionType.

version - String part of the Version.

Version

public Version(String stringVersion)

Constructor using a Version literal.

Throws RuntimeException if parsing fails.

Parameters:

stringVersion - Version literal.

Method Detail

parse

public static Version parse(String stringVersion)
                     throws ParseException

Parses a Version literal.

Parameters:

stringVersion - Version literal.

Returns:

Version.

Throws:

ParseException - If parsing fails.

getVersionType

public VersionType getVersionType()

Returns:

VersionType.

getVersion

public String getVersion()

Returns:

String part of the Version, without the VersionType information.

getCorrespondingArtifactVersion

public ArtifactVersion getCorrespondingArtifactVersion()

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

Note that the mapping between Version and ArtifactVersion 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:

ArtifactVersion.

toString

public String toString()

Overrides:

toString in class Object

Returns:

Version literal.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object other)

Overrides:

equals in class Object