co.codewizards.cloudstore.core.updater

Class Version

java.lang.Object

co.codewizards.cloudstore.core.updater.Version

All Implemented Interfaces:

Serializable, Comparable<Version>

public class Version
extends Object
implements Comparable<Version>, Serializable

This class is used to version the client plugins of JFire and may be used to act as a version identifier in any project. The pattern a version String is: majorminor release[patchLevel [suffix]]
The suffix may consist of 'a-zA-Z0-9#$!_-'. Additionally the following version string is also valid: '

1.2.3.test

'.

Examples of valid versions are:

• 1.2.3

• 1.2.3.4

• 1.2.3.4.test

• 1.2.3.t_e!st

Note: This class is immutable!

Author:

Marius Heinzmann marius[AT]NightLabs[DOT]de, Marco Schulze marco@nightlabs.de, Niklas Schiffler

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static Version	MAX_VERSION The maximum Version possible.
static Version	MIN_VERSION The minimum Version that can exist.
static Pattern	validityCheck A regex that is used to check the suffix for valid characters.

Constructor Summary

Constructors

Constructor and Description
Version(int major, int minor, int release, int patchLevel)
Version(int major, int minor, int release, int patchLevel, String suffix)
Version(String versionStr) Creates a new instance from the given versionStr.

Method Summary

Methods

Modifier and Type	Method and Description
Version	changeMajor(int major)
Version	changeMinor(int minor)
Version	changePatchLevel(int patchLevel)
Version	changeRelease(int release)
Version	changeSuffix(String suffix)
int	compareTo(Version other) Compares this Version object to another one.
boolean	equals(Object other)
int	getMajor()
int	getMinor()
int	getPatchLevel()
int	getRelease()
String	getSuffix()
int	hashCode()
String	toString() Returns the String representation of this version, which is defined as: majorminor release[patchLevel [suffix]] The suffix may consist of 'a-zA-Z0-9#$!_-'.

Methods inherited from class java.lang.Object

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

Field Detail

MIN_VERSION

public static final Version MIN_VERSION

The minimum Version that can exist.

MAX_VERSION

public static final Version MAX_VERSION

The maximum Version possible.

validityCheck

public static Pattern validityCheck

A regex that is used to check the suffix for valid characters.

Constructor Detail

Version

public Version(String versionStr)
        throws MalformedVersionException

Creates a new instance from the given versionStr.

Parameters:

versionStr - the version encoded as a String.

Throws:

MalformedVersionException

Version

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

Parameters:

major -

minor -

release -

patchLevel -

Version

public Version(int major,
       int minor,
       int release,
       int patchLevel,
       String suffix)

Parameters:

major -

minor -

release -

patchLevel -

suffix -

Method Detail

getMajor

public int getMajor()

Returns:

Returns the major.

changeMajor

public Version changeMajor(int major)

Parameters:

major - The major with which to create a new Version.

Returns:

A copy of this Version except for the given new major.

getMinor

public int getMinor()

Returns:

Returns the minor.

changeMinor

public Version changeMinor(int minor)

Parameters:

minor - The minor with which to create a new Version.

Returns:

A copy of this Version except for the given new minor.

getPatchLevel

public int getPatchLevel()

Returns:

Returns the patchLevel.

changePatchLevel

public Version changePatchLevel(int patchLevel)

Parameters:

patchLevel - The patchLevel with which to create a new Version.

Returns:

A copy of this Version except for the given new patchLevel.

getRelease

public int getRelease()

Returns:

Returns the release.

changeRelease

public Version changeRelease(int release)

Parameters:

release - The release with which to create a new Version.

Returns:

A copy of this Version except for the given new release.

getSuffix

public String getSuffix()

Returns:

Returns the suffix.

changeSuffix

public Version changeSuffix(String suffix)

Parameters:

suffix - The suffix with which to create a new Version.

Returns:

A copy of this Version except for the given new suffix.

toString

public String toString()

Returns the String representation of this version, which is defined as: majorminor release[patchLevel [suffix]]
The suffix may consist of 'a-zA-Z0-9#$!_-'. Additionally the following version string is also valid: '

1.2.3.test

'.

Overrides:

toString in class Object

Returns:

the String representation of this version.

equals

public boolean equals(Object other)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

compareTo

public int compareTo(Version other)

Compares this Version object to another one.

A version is considered to be less than another version if its major component is less than the other version's major component, or the major components are equal and its minor component is less than the other version's minor component, or the major and minor components are equal and its release component is less than the other version's release component. The suffix is not relevant for the natural ordering of Versions, though for equality.

Note: Given two version v1,v2 and v1.compareTo(Version v2) = 0, this does not imply that v1 and v2 are equal according to equals!

A version is considered to be equal to another version if the major, minor and micro components are equal and the qualifier component is equal (see equals(Object)).

Specified by:

compareTo in interface Comparable<Version>

Parameters:

other - The Version object to be compared.

Returns:

A negative integer, zero, or a positive integer if this object is less than, equal to, or greater than the specified Version object.