org.oddjob

Class Version

java.lang.Object

org.oddjob.Version

All Implemented Interfaces:

java.lang.Comparable<Version>

public class Version
extends java.lang.Object
implements java.lang.Comparable<Version>

Oddjob's version. Comparison and Equality are only based on the major minor and patch versions, not on the snapshot or date properties.

Author:

rob

Constructor Summary

Constructors

Constructor and Description
Version(int major, int minor, int patch) Create a new instance.
Version(int major, int minor, int patch, boolean snapshot, java.util.Date buildDate) Create a new instance.

Method Summary

Modifier and Type	Method and Description
int	compareTo(Version o)
static Version	current() Get the current version of this build.
boolean	equals(java.lang.Object obj)
java.util.Date	getBuildDate() Get the build date and time if one was provided.
static java.lang.String	getCurrentFullBuildMessage()
static java.lang.String	getCurrentVersionAndBuildDate()
static java.lang.String	getCurrentVersionText()
int	getMajor() Get the major version.
int	getMinor() Get the minor version.
int	getPatch() Get the patch version.
int	hashCode()
boolean	isSnapshot() Is this build version representing a snapshot version.
static void	main(java.lang.Object... args)
java.lang.String	toString()
static Version	versionFor(java.lang.String version, java.lang.String date) Create a version for the given version text and date text.

Methods inherited from class java.lang.Object

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

Constructor Detail

Version

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

Create a new instance. The snapshot property will be false and the date property will be null.

Parameters:

major -

minor -

patch -

Version

public Version(int major,
               int minor,
               int patch,
               boolean snapshot,
               java.util.Date buildDate)

Create a new instance.

Parameters:

major -

minor -

patch -

snapshot -

buildDate -

Method Detail

getMajor

public int getMajor()

Get the major version.

Returns:

getMinor

public int getMinor()

Get the minor version.

Returns:

getPatch

public int getPatch()

Get the patch version.

Returns:

isSnapshot

public boolean isSnapshot()

Is this build version representing a snapshot version.

Returns:

true if this version is a snapshot, otherwise false.

getBuildDate

public java.util.Date getBuildDate()

Get the build date and time if one was provided.

Returns:

A date or null.

compareTo

public int compareTo(Version o)

Specified by:

compareTo in interface java.lang.Comparable<Version>

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

current

public static Version current()

Get the current version of this build. The current version might be 0.0.0-SNAPSHOT if the version text couldn't be parsed - i.e. it wasn't built with ant.

Returns:

A version. Never null.

versionFor

public static Version versionFor(java.lang.String version,
                                 java.lang.String date)

Create a version for the given version text and date text.

The version is expected to be in the form major.minor.patch or major.minor.patch-SNAPSHOT. If the version is not in this form null will be returned.

The date is expected to be one of the standard date time formats as specified in ArooaConstants. If it is not in this format a version with a null date property will be returned.

Parameters:

version - The version as text. Must not be null.

date - The date as text. May be null.

Returns:

A version or null.

getCurrentVersionText

public static java.lang.String getCurrentVersionText()

getCurrentVersionAndBuildDate

public static java.lang.String getCurrentVersionAndBuildDate()

getCurrentFullBuildMessage

public static java.lang.String getCurrentFullBuildMessage()

main

public static void main(java.lang.Object... args)