net.mountainblade.modular

Class Version

java.lang.Object

net.mountainblade.modular.Version

All Implemented Interfaces:

Comparable<Version>

public final class Version
extends Object
implements Comparable<Version>

Represents a class that parses and stores version information using the extended semantic version format (with pre-release and build labels).

Version:

1.0

Author:

spaceemotion

Field Summary

Fields

Modifier and Type	Field and Description
static Pattern	SEMVER_DETECT
static Pattern	SEMVER_FORMAT
static String	SNAPSHOT

Constructor Summary

Constructors

Constructor and Description
Version(int major) Creates a new version.
Version(int major, int minor) Creates a new version.
Version(int major, int minor, int patch) Creates a new version.
Version(int major, int minor, int patch, boolean snapshot) Creates a new version.
Version(int major, int minor, int patch, String preRelease, String build) Creates a new version.
Version(String text) Creates a new version from the given text.

Method Summary

Modifier and Type	Method and Description
int	compareTo(Version other)
boolean	equals(Object o)
String	getBuild() Gets the build label extension.
int	getMajor() Gets the major version label representing incompatible API changes.
int	getMinor() Gets the minor version label for functionality in a backwards-compatible manner.
int	getPatch() Gets the patch label representing backwards-compatible bug fixes.
String	getPreRelease() Gets the pre-release label extension.
int	hashCode()
boolean	isSnapshot() Indicates whether or not the version represents a snapshot version (indicated by the "SNAPSHOT" suffix in the pre-release label).
static Version	parse(String version) Parses the given string and tries to return only one version instance.
static Version[]	parseMulti(String... versions) Tries to find as many version tags within the given text and returns the result as an array.
String	toString() Converts this version to a usable version tag.

Methods inherited from class java.lang.Object

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

Field Detail

SEMVER_DETECT

public static final Pattern SEMVER_DETECT

SEMVER_FORMAT

public static final Pattern SEMVER_FORMAT

SNAPSHOT

public static final String SNAPSHOT

See Also:

Constant Field Values

Constructor Detail

Version

public Version(int major)

Creates a new version.

Parameters:

major - The major version (for incompatible API changes)

Version

public Version(int major,
               int minor)

Creates a new version.

Parameters:

major - The major version (for incompatible API changes)

minor - The minor version (functionality in a backwards-compatible manner)

Version

public Version(int major,
               int minor,
               int patch)

Creates a new version.

Parameters:

major - The major version (for incompatible API changes)

minor - The minor version (functionality in a backwards-compatible manner)

patch - The patch version (backwards-compatible bug fixes)

Version

public Version(int major,
               int minor,
               int patch,
               boolean snapshot)

Creates a new version.

Parameters:

major - The major version (for incompatible API changes)

minor - The minor version (functionality in a backwards-compatible manner)

patch - The patch version (backwards-compatible bug fixes)

snapshot - True if the version represents a snapshot, false if not

Version

public Version(int major,
               int minor,
               int patch,
               String preRelease,
               String build)

Creates a new version.

Parameters:

major - The major version (for incompatible API changes)

minor - The minor version (functionality in a backwards-compatible manner)

patch - The patch version (backwards-compatible bug fixes)

preRelease - The pre-release tag

build - The build identifier

Version

public Version(String text)
        throws IllegalArgumentException

Creates a new version from the given text.

Parameters:

text - The version text

Throws:

IllegalArgumentException - When the given text does not contain a valid version tag

Method Detail

getMajor

public int getMajor()

Gets the major version label representing incompatible API changes.

Returns:

The major version

getMinor

public int getMinor()

Gets the minor version label for functionality in a backwards-compatible manner.

Returns:

The minor version

getPatch

public int getPatch()

Gets the patch label representing backwards-compatible bug fixes.

Returns:

The patch version

getPreRelease

public String getPreRelease()

Gets the pre-release label extension.

Returns:

The pre-release tag

getBuild

public String getBuild()

Gets the build label extension.

Returns:

The pre-release tag

isSnapshot

public boolean isSnapshot()

Indicates whether or not the version represents a snapshot version (indicated by the "SNAPSHOT" suffix in the pre-release label).

Returns:

True if the version represents a snapshot, false if not

toString

public String toString()

Converts this version to a usable version tag. Its output is as follows:

• The MAJOR, MINOR and PATCH labels delimited by a dot
• If set, the Pre-Release label suffixed by a dash ("-")
• If set, the build label suffixed by a plus sign ("+")

If the version describes a snapshot version the "SNAPSHOT" tag will be written all uppercase. e.g: "1.0.2-SNAPSHOT+b10031".

Overrides:

toString in class Object

Returns:

The full version tag

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

compareTo

public int compareTo(Version other)

Specified by:

compareTo in interface Comparable<Version>

parseMulti

public static Version[] parseMulti(String... versions)

Tries to find as many version tags within the given text and returns the result as an array.

Parameters:

versions - The text to look through

Returns:

All found version tags. Can be empty.

parse

public static Version parse(String version)
                     throws IllegalArgumentException

Parses the given string and tries to return only one version instance.

Parameters:

version - The version text to parse

Returns:

The parsed version, can be empty

Throws:

IllegalArgumentException - when the given string contains no, or more than one version