org.geotoolkit.util
Class Version

Object
  Version

All Implemented Interfaces:

Serializable, CharSequence, Comparable<Version>

@Immutable
public class Version
extends Object
implements CharSequence, Comparable<Version>, Serializable

Holds a version number as a sequence of strings separated by either a dot or a dash. The first three strings, usually numbers, are called respectively major, minor and revision. For example an EPSG database version code, such as "6.11.2", will have major number 6, minor number 11 and revision number 2. Alternatively a Maven version code, such as "3.18-SNAPSHOT", will have major version number 3, minor version number 18 and revision string "SNAPSHOT".

This class provides methods for performing comparisons of Version objects where major, minor and revision parts are compared as numbers when possible, or as strings otherwise.

Since:

2.4

Version:

3.00

Author:

Martin Desruisseaux (IRD)

See Also:

Versioned, Serialized Form

Module:

utility/geotk-utility (download)

View source code for this class

Field Summary

static Version	GEOTOOLKIT The version of this Geotoolkit.org distribution.
static String	SEPARATORS The separator characters between major, minor and revision components.

Constructor Summary

Version(String version)
Creates a new version object from the supplied string.

Method Summary

char	charAt(int index) Returns the char value at the specified index.
int	compareTo(Version other) Compares this version with an other version object.
int	compareTo(Version other, int limit) Compares this version with an other version object, up to the specified limit.
boolean	equals(Object other) Compare this version string with the specified object for equality.
Comparable<?>	getComponent(int index) Returns the specified components of this version string.
Comparable<?>	getMajor() Returns the major version number.
Comparable<?>	getMinor() Returns the minor version number.
Comparable<?>	getRevision() Returns the revision number.
int	hashCode() Returns a hash code value for this version.
int	length() Returns the length of the version string.
CharSequence	subSequence(int start, int end) Returns a new version string that is a subsequence of this sequence.
String	toString() Returns the version string.

Methods inherited from class Object

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

Field Detail

GEOTOOLKIT

public static final Version GEOTOOLKIT

The version of this Geotoolkit.org distribution.

SEPARATORS

public static final String SEPARATORS

The separator characters between major, minor and revision components. Any character in this string fits.

See Also:

Constant Field Values

Constructor Detail

Version

public Version(String version)

Creates a new version object from the supplied string.

Parameters:

version - The version as a string.

Method Detail

getMajor

public Comparable<?> getMajor()

Returns the major version number. This method returns an Integer if possible, or a String otherwise.

Returns:

The major version number.

getMinor

public Comparable<?> getMinor()

Returns the minor version number. This method returns an Integer if possible, or a String otherwise. If there is no minor version number, then this method returns null.

Returns:

The minor version number, or null if none.

getRevision

public Comparable<?> getRevision()

Returns the revision number. This method returns an Integer if possible, or a String otherwise. If there is no revision number, then this method returns null.

Returns:

The revision number, or null if none.

getComponent

public Comparable<?> getComponent(int index)

Returns the specified components of this version string. For a version of the major.minor.revision form, index 0 stands for the major version number, 1 stands for the minor version number and 2 stands for the revision number.

The return value is an Integer if the component is parsable as an integer, or a String otherwise. If there is no component at the specified index, then this method returns null.

Parameters:

index - The index of the component to fetch.

Returns:

The value at the specified index, or null if none.

Throws:

IndexOutOfBoundsException - if index is negative.

compareTo

public int compareTo(Version other,
                     int limit)

Compares this version with an other version object, up to the specified limit. A limit of 1 compares only the major version number. A limit of 2 compares the major and minor version numbers, etc. The comparisons are performed as Integer object if possible, or as String otherwise.

Parameters:

other - The other version object to compare with.

limit - The maximum number of components to compare.

Returns:

A negative value if this version is lower than the supplied version, a positive value if it is higher, or 0 if they are equal.

compareTo

public int compareTo(Version other)

Compares this version with an other version object. This method performs the same comparison than compareTo(Version, int) with no limit.

Specified by:

compareTo in interface Comparable<Version>

Parameters:

other - The other version object to compare with.

Returns:

A negative value if this version is lower than the supplied version, a positive value if it is higher, or 0 if they are equal.

equals

public boolean equals(Object other)

Compare this version string with the specified object for equality. Two version are considered equal if compareTo(other) == 0.

Overrides:

equals in class Object

Parameters:

other - The object to compare with this version for equality.

length

public int length()

Returns the length of the version string.

Specified by:

length in interface CharSequence

charAt

public char charAt(int index)

Returns the char value at the specified index.

Specified by:

charAt in interface CharSequence

subSequence

public CharSequence subSequence(int start,
                                int end)

Returns a new version string that is a subsequence of this sequence.

Specified by:

subSequence in interface CharSequence

toString

public String toString()

Returns the version string. This is the string specified at construction time.

Specified by:

toString in interface CharSequence

Overrides:

toString in class Object

hashCode

public int hashCode()

Returns a hash code value for this version.

Overrides:

hashCode in class Object