org.fujion.common

Class Version

java.lang.Object

org.fujion.common.Version

All Implemented Interfaces:

Comparable<Version>

public class Version
extends Object
implements Comparable<Version>

Representation of a standard 4-part version number in the format:

major.minor.release.build

where any missing components are assumed to be 0.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Version.VersionPart Specifies a version part.

Field Summary

Fields

Modifier and Type	Field and Description
static int	NOVAL

Constructor Summary

Constructors

Constructor and Description
Version()
Version(int major)
Version(int major, int minor)
Version(int major, int minor, int release)
Version(int major, int minor, int release, int build)
Version(int major, int minor, int release, int build, String classifier)
Version(String value)

Method Summary

Modifier and Type	Method and Description
int	compareTo(Version v) Does a full comparison of all version parts.
int	compareTo(Version v, boolean includeClassifier) Does a full comparison of all version parts.
int	compareTo(Version v, Version.VersionPart part) Compare two versions up to and including the specified version part.
int	compareTo(Version v, Version.VersionPart part, boolean includeClassifier) Compare two versions up to and including the specified version part.
boolean	equals(Object v) Two version are considered equal if all their respective parts are equal and their classifiers are equal.
String	getClassifier() Returns the version classifier, if any.
int	getPart(Version.VersionPart part) Returns the value of the specified part.
Version.VersionPart	getSpecificity() Returns the level of specificity for the version.
int	hashCode()
String	toString()
String	toString(Version.VersionPart part) Returns the text representation of the version up to and including the specified version part.
String	toString(Version.VersionPart part, boolean includeClassifier) Returns the text representation of the version up to and including the specified version part.

Methods inherited from class java.lang.Object

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

Field Detail

NOVAL

public static final int NOVAL

See Also:

Constant Field Values

Constructor Detail

Version

public Version()

Version

public Version(String value)

Version

public Version(int major)

Version

public Version(int major,
               int minor)

Version

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

Version

public Version(int major,
               int minor,
               int release,
               int build)

Version

public Version(int major,
               int minor,
               int release,
               int build,
               String classifier)

Method Detail

getPart

public int getPart(Version.VersionPart part)

Returns the value of the specified part.

Parameters:

part - The part whose value is sought.

Returns:

The value of the specified part, or -1 if no value. Note that the classifier version part will always return -1. To retrieve the classifier part, use getClassifier().

getClassifier

public String getClassifier()

Returns the version classifier, if any.

Returns:

The version classifier, if any.

getSpecificity

public Version.VersionPart getSpecificity()

Returns the level of specificity for the version.

Returns:

Level of specificity, or null if the version was null or empty.

equals

public boolean equals(Object v)

Two version are considered equal if all their respective parts are equal and their classifiers are equal.

Overrides:

equals in class Object

compareTo

public int compareTo(Version v)

Does a full comparison of all version parts. Classifiers are used in the comparison.

Specified by:

compareTo in interface Comparable<Version>

compareTo

public int compareTo(Version v,
                     boolean includeClassifier)

Does a full comparison of all version parts.

Parameters:

v - The version to compare

includeClassifier - If true, include classifiers in the comparison.

Returns:

Result of the comparison.

compareTo

public int compareTo(Version v,
                     Version.VersionPart part)

Compare two versions up to and including the specified version part. Classifiers are not used in the comparison.

Parameters:

v - The version to compare.

part - Compare up to and including this version part.

Returns:

Result of the comparison.

compareTo

public int compareTo(Version v,
                     Version.VersionPart part,
                     boolean includeClassifier)

Compare two versions up to and including the specified version part.

Parameters:

v - The version to compare.

part - Compare up to and including this version part.

includeClassifier - If true, a case-sensitive string comparison of the classifiers will be used in the event that all parts are equal.

Returns:

Result of the comparison.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString(Version.VersionPart part)

Returns the text representation of the version up to and including the specified version part. If the version part exceeds the specificity of the version, the result will be padded with zero values. If a classifier is present and the specified part is null, it will be appended to the end of the returned value.

Parameters:

part - Pad up to and including this version part. Null means no padding.

Returns:

The text representation.

toString

public String toString(Version.VersionPart part,
                       boolean includeClassifier)

Returns the text representation of the version up to and including the specified version part. If the version part exceeds the specificity of the version, the result will be padded with zero values.

Parameters:

part - Pad up to and including this version part. Null means no padding.

includeClassifier - If true, include the classifier, if any.

Returns:

The text representation.

toString

public String toString()

Overrides:

toString in class Object