org.jminor.common

Class Version

java.lang.Object

org.jminor.common.Version

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<Version>

public final class Version
extends java.lang.Object
implements java.lang.Comparable<Version>, java.io.Serializable

A simple version class

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	VERSION_FILE The name of the file containing the current version information

Constructor Summary

Constructors

Constructor and Description
Version(int major) Instantiates a new version [major].0.0
Version(int major, int minor) Instantiates a new version [major].[minor].0
Version(int major, int minor, int patch) Instantiates a new version [major].[minor].[patch]
Version(int major, int minor, int patch, java.lang.String metadata) Instantiates a new version [major].[minor].[patch]-[metadata]

Method Summary

Modifier and Type	Method and Description
int	compareTo(Version version)
boolean	equals(java.lang.Object obj)
int	getMajor()
java.lang.String	getMetadata()
int	getMinor()
int	getPatch()
static Version	getVersion()
static java.lang.String	getVersionAndBuildNumberString()
static java.lang.String	getVersionString()
int	hashCode()
static Version	parse(java.lang.String versionString) Parses a string on the form x.y.z-metadata
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

VERSION_FILE

public static final java.lang.String VERSION_FILE

The name of the file containing the current version information

See Also:

Constant Field Values

Constructor Detail

Version

public Version(int major)

Instantiates a new version [major].0.0

Parameters:

major - the major version

Version

public Version(int major,
               int minor)

Instantiates a new version [major].[minor].0

Parameters:

major - the major version

minor - the minor version

Version

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

Instantiates a new version [major].[minor].[patch]

Parameters:

major - the major version

minor - the minor version

patch - the patch version

Version

public Version(int major,
               int minor,
               int patch,
               java.lang.String metadata)

Instantiates a new version [major].[minor].[patch]-[metadata]

Parameters:

major - the major version

minor - the minor version

patch - the patch version

metadata - the metadata, fx. build information

Method Detail

getMajor

public int getMajor()

Returns:

the major part of this version

getMinor

public int getMinor()

Returns:

the minor part of this version

getPatch

public int getPatch()

Returns:

the patch part of this version

getMetadata

public java.lang.String getMetadata()

Returns:

the metadata part of this version

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

compareTo

public int compareTo(Version version)

Specified by:

compareTo in interface java.lang.Comparable<Version>

getVersionString

public static java.lang.String getVersionString()

Returns:

a string containing the framework version number, without any version metadata (fx. build no.)

getVersionAndBuildNumberString

public static java.lang.String getVersionAndBuildNumberString()

Returns:

a string containing the framework version and version metadata

getVersion

public static Version getVersion()

Returns:

the framework Version

parse

public static Version parse(java.lang.String versionString)

Parses a string on the form x.y.z-metadata

Parameters:

versionString - the version string

Returns:

a Version based on the given string