org.savantbuild.dep.domain

Class Version

java.lang.Object

org.savantbuild.domain.Version

All Implemented Interfaces:

java.lang.Comparable<Version>

public class Version
extends java.lang.Object
implements java.lang.Comparable<Version>

This class models a simple three number version as well as any free form version String. It has two modes of operation, strict and relaxed.

When this class is constructed in it tries everything in its power to figure out what the heck a version string is and will only fail if the version string has two delimiters next to each other or begins/ends with a delimiter.

For the most part, this class correctly implements the Semantic Versioning system. This can be found here:

http://semver.org

The only notable except to this scheme is that Savant supports integration builds, which are not released versions, but are local versions to a single developer or a team. Integration builds are always denoted by an additional version specifier of -{integration}. For example, 1.0.0-{integration} denotes an integration build.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Version.PreRelease Models the PreRelease portion of the Semantic Version String.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	INTEGRATION
int	major
java.lang.String	metaData
int	minor
int	patch
Version.PreRelease	preRelease

Constructor Summary

Constructors

Constructor and Description
Version(int major, int minor, int patch, Version.PreRelease preRelease, java.lang.String metaData) Constructs a version with the given major, minor and patch version numbers.
Version(java.lang.String version) Constructs a version by parsing the given String.

Method Summary

Modifier and Type	Method and Description
int	compareTo(Version other) Returns the value of the comparison between this Version and the given Object.
boolean	equals(java.lang.Object o) Compares the given Object with this Version for equality.
int	hashCode()
boolean	isCompatibleWith(Version other) Performs semantic version compatibility checking.
boolean	isIntegration()
boolean	isMajor()
boolean	isMinor()
boolean	isPatch()
boolean	isPreRelease()
Version	toIntegrationVersion()
java.lang.String	toString() Converts the version number to a string suitable for debugging.

Methods inherited from class java.lang.Object

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

Field Detail

INTEGRATION

public static final java.lang.String INTEGRATION

See Also:

Constant Field Values

major

public final int major

metaData

public final java.lang.String metaData

minor

public final int minor

patch

public final int patch

preRelease

public final Version.PreRelease preRelease

Constructor Detail

Version

public Version(int major,
               int minor,
               int patch,
               Version.PreRelease preRelease,
               java.lang.String metaData)

Constructs a version with the given major, minor and patch version numbers.

Parameters:

major - The major version number.

minor - The minor version number.

patch - The patch version number.

preRelease - The pre-release object.

metaData - The build meta data string.

Version

public Version(java.lang.String version)

Constructs a version by parsing the given String.

Parameters:

version - The version String to parse.

Throws:

VersionException - If the string is incorrectly formatted and does not conform to the semantic versioning scheme (starts with a delimiter (. or -), contains two delimiters in a row, doesn't have proper pre-release or meta-data information).

Method Detail

compareTo

public int compareTo(Version other)

Returns the value of the comparison between this Version and the given Object. This throws an exception if the object given is not a Version.

Specified by:

compareTo in interface java.lang.Comparable<Version>

Parameters:

other - The other Object to compare against.

Returns:

A positive integer if this Version is larger than the given version. Zero if the given Version is the exact same as this Version. A negative integer is this Version is smaller that the given Version.

equals

public boolean equals(java.lang.Object o)

Compares the given Object with this Version for equality.

Overrides:

equals in class java.lang.Object

Parameters:

o - The object to compare with this Version for equality.

Returns:

True if they are both Versions and equal, false otherwise.

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

Returns:

A valid hashcode for the Version.

isCompatibleWith

public boolean isCompatibleWith(Version other)

Performs semantic version compatibility checking. If this version is on the 0.x line, than the other version has to be on the same minor line (e.g. 0.3 is not compatible with 0.4). Otherwise, the two versions have to be on the same major line (e.g. 1.0 is not compatible with 2.0).

Parameters:

other - The other version to check against.

Returns:

True if the versions are compatible, false if they aren't.

isIntegration

public boolean isIntegration()

Returns:

True if this Version is an integration, false for all other types of versions.

isMajor

public boolean isMajor()

Returns:

True if this Version is a major, false for all other types of versions.

isMinor

public boolean isMinor()

Returns:

True if this Version is a minor, false for all other types of versions.

isPatch

public boolean isPatch()

Returns:

True if this Version is a patch, false for all other types of versions.

isPreRelease

public boolean isPreRelease()

Returns:

True if this Version is a snapshot, false for all other types of versions.

toIntegrationVersion

public Version toIntegrationVersion()

toString

public java.lang.String toString()

Converts the version number to a string suitable for debugging.

Overrides:

toString in class java.lang.Object

Returns:

A String of the version number.