biz.massivedynamics.versioneer.version

Class Version

java.lang.Object

biz.massivedynamics.versioneer.version.Version

All Implemented Interfaces:

Cloneable, Comparable<Version>

Direct Known Subclasses:

GenericVersion, NumericVersion, ThreePartVersion, TwoPartVersion

public abstract class Version
extends Object
implements Comparable<Version>, Cloneable

An abstract class that defines the skeleton of a Version

All Version classes must have this class as their parent

Since:

1.2.0.0

Author:

Cruz Bishop

Constructor Summary

Constructors

Constructor and Description
Version() Creates a new Version with the default VersionType of STABLE
Version(VersionType type) Creates a new Version
Version(VersionType type, String codeName) Creates a new Version

Method Summary

Methods

Modifier and Type	Method and Description
abstract Version	clone() Clones this Version
boolean	equals(Object obj) Compares this Version with another Version for equality
static Version	get(String versionAsString) Gets a Version from a String
String	getCodeName() Gets the code name of this Version
VersionType	getType() Gets this Version's VersionType
abstract int	hashCode() Gets this Version's hashcode
void	setCodeName(String codeName) Sets the code name of this Version
void	setType(VersionType type) Sets this Version's VersionType
abstract GenericVersion	toGenericVersion() Converts this Version to a GenericVersion
abstract String	toString() Convert this Version to a String

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Comparable

compareTo

Constructor Detail

Version

public Version()

Creates a new Version with the default VersionType of STABLE

Since:

1.2.0.0

Version

public Version(VersionType type)

Creates a new Version

Parameters:

type - The VersionType to use

Since:

1.2.0.0

Version

public Version(VersionType type,
       String codeName)

Creates a new Version

Parameters:

type - The VersionType to use

codeName - The code name to use

Since:

1.2.0.0

Method Detail

getType

public final VersionType getType()

Gets this Version's VersionType

Returns:

The VersionType

Since:

1.2.0.0

setType

public final void setType(VersionType type)

Sets this Version's VersionType

Parameters:

type - The VersionType to set

Since:

1.2.0.0

getCodeName

public final String getCodeName()

Gets the code name of this Version

Returns:

The code name

Since:

1.2.0.0

setCodeName

public final void setCodeName(String codeName)

Sets the code name of this Version

Parameters:

codeName - The code name

Since:

1.2.0.0

toGenericVersion

public abstract GenericVersion toGenericVersion()

Converts this Version to a GenericVersion

Returns:

The GenericVersion representing this Version

Since:

1.2.0.0

toString

public abstract String toString()

Convert this Version to a String

Overrides:

toString in class Object

Returns:

A String

Since:

1.2.0.0

equals

public final boolean equals(Object obj)

Compares this Version with another Version for equality

Overrides:

equals in class Object

Parameters:

obj - The other object, preferably a Version!

Returns:

True if equal, otherwise false

Since:

1.2.0.0

hashCode

public abstract int hashCode()

Gets this Version's hashcode

Overrides:

hashCode in class Object

Returns:

The hashcode

Since:

1.2.0.0

clone

public abstract Version clone()

Clones this Version

Overrides:

clone in class Object

Returns:

The cloned Version

Since:

1.2.0.0

get

public static Version get(String versionAsString)
                   throws InvalidVersionException,
                          IllegalArgumentException,
                          NumberFormatException

Gets a Version from a String

Parameters:

versionAsString - The Version as a String

Returns:

The Version

Throws:

InvalidVersionException - The Version could not be decoded

IllegalArgumentException - The VersionType could not be decoded

NumberFormatException - There was an invalid Version number (!3, for example, instead of 13)

Since:

1.2.0.0