org.rhq.core.db.ant.dbupgrade

Class SchemaVersion

java.lang.Object

org.rhq.core.db.ant.dbupgrade.SchemaVersion

All Implemented Interfaces:

Comparable

public class SchemaVersion
extends Object
implements Comparable

Object that encapsulates and compares database schema version strings. A version string follows the format major[.minor[.patch]] where the minor and patch numbers are optional. Examples are 1, 1.0, 2.1.1.

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEV_VERSION Defines the development version string - this is the schema version on development builds.
static String	LATEST_VERSION Defines the version string that indicates this is the latest schema version.

Constructor Summary

Constructors

Constructor and Description
SchemaVersion(String version_string) Creates a new SchemaVersion object.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	between(SchemaVersion start_exclusive, SchemaVersion end_inclusive) Determines if this version is newer than start_exclusive but equal to or older than end_inclusive.
int	compareTo(Object o)
boolean	equals(Object o)
boolean	getIsLatest() Returns true if this version is to be considered the latest schema version; no other schema versions are considered newer than the version this object represents.
int	getMajorVersion() The major version number, which is the left most number in the X.X.X version string.
int	getMinorVersion() The minor version number, which is the second number in the X.X.X version string.
int	getPatchVersion() The patch version number, which is the third number in the X.X.X version string.
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

DEV_VERSION

public static final String DEV_VERSION

Defines the development version string - this is the schema version on development builds. The development schema version is considered the latest version.

See Also:

Constant Field Values

LATEST_VERSION

public static final String LATEST_VERSION

Defines the version string that indicates this is the latest schema version. There are no other versions that are newer than this one and thus doing a DB upgrade will have no effect on the schema.

See Also:

Constant Field Values

Constructor Detail

SchemaVersion

public SchemaVersion(String version_string)
              throws IllegalArgumentException

Creates a new SchemaVersion object. If the version_string is null, it will be considered the latest version.

Parameters:

version_string -

Throws:

IllegalArgumentException - if the string was not a valid version

Method Detail

getMajorVersion

public int getMajorVersion()

The major version number, which is the left most number in the X.X.X version string.

Returns:

major version number

getMinorVersion

public int getMinorVersion()

The minor version number, which is the second number in the X.X.X version string.

Returns:

minor version number

getPatchVersion

public int getPatchVersion()

The patch version number, which is the third number in the X.X.X version string.

Returns:

patch version number

getIsLatest

public boolean getIsLatest()

Returns true if this version is to be considered the latest schema version; no other schema versions are considered newer than the version this object represents.

Returns:

true if this version string represents the newest version.

compareTo

public int compareTo(Object o)

Specified by:

compareTo in interface Comparable

See Also:

Comparable.compareTo(java.lang.Object)

toString

public String toString()

Overrides:

toString in class Object

See Also:

Object.toString()

equals

public boolean equals(Object o)

Overrides:

equals in class Object

See Also:

Object.equals(java.lang.Object)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

See Also:

Object.hashCode()

between

public boolean between(SchemaVersion start_exclusive,
              SchemaVersion end_inclusive)

Determines if this version is newer than start_exclusive but equal to or older than end_inclusive.

Parameters:

start_exclusive - the version that this version should be newer than

end_inclusive - the version that this version should equal or be older than

Returns:

true if this version is between the two given versions