com.allanbank.mongodb

Class Version

java.lang.Object

com.allanbank.mongodb.Version

All Implemented Interfaces:

Serializable, Comparable<Version>

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

Version provides a class to handle version numbers and provide the version of the driver in use.

See Also:

Serialized Form

Copyright ©:

2013, Allanbank Consulting, Inc., All Rights Reserved

Field Summary

Fields

Modifier and Type	Field and Description
static Version	UNKNOWN A version to use when we don't know the version.
static Version	VERSION The driver's version.
static Version	VERSION_0 The "zero" version which should be before all other versions.
static Version	VERSION_2_0 Version 2.0
static Version	VERSION_2_2 Version 2.2
static Version	VERSION_2_4 Version 2.4
protected static Version	VERSION_2_5_2 Version 2.5.2 - Wire Protocol version = 1.
protected static Version	VERSION_2_5_4 Version 2.5.4 - Wire Protocol version = 2.
static Version	VERSION_2_6 Version 2.6

Method Summary

Methods

Modifier and Type	Method and Description
protected int	compare(int x, int y) Compares two int values numerically.
int	compareTo(Version other)
static Version	earlier(Version lhs, Version rhs) Returns the earlier of the two versions.
boolean	equals(Object object) Determines if the passed object is of this same type as this object and if so that its fields are equal.
static Version	forWireVersion(int wireVersion) Returns the best guess at the version of the server based on the wire protocol version number.
int	hashCode() Computes a reasonable hash code.
static Version	later(Version lhs, Version rhs) Returns the later of the two versions.
static Version	parse(List<NumericElement> versionArray) Parses a version from a version array.
static Version	parse(String version) Parses a version of the general format 'int.int.int-suffix'.
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

UNKNOWN

public static final Version UNKNOWN

A version to use when we don't know the version. This version will always compare greater than (higher, more recent) than all other versions.

VERSION

public static final Version VERSION

The driver's version.

VERSION_0

public static final Version VERSION_0

The "zero" version which should be before all other versions.

VERSION_2_0

public static final Version VERSION_2_0

Version 2.0

VERSION_2_2

public static final Version VERSION_2_2

Version 2.2

VERSION_2_4

public static final Version VERSION_2_4

Version 2.4

VERSION_2_6

public static final Version VERSION_2_6

Version 2.6

VERSION_2_5_2

protected static final Version VERSION_2_5_2

Version 2.5.2 - Wire Protocol version = 1.

VERSION_2_5_4

protected static final Version VERSION_2_5_4

Version 2.5.4 - Wire Protocol version = 2.

Method Detail

earlier

public static Version earlier(Version lhs,
              Version rhs)

Returns the earlier of the two versions. If either version is null then the other version is returned. Only if both version are null will null be returned.

Parameters:

lhs - The first version to compare.

rhs - The second version to compare.

Returns:

The earlier (lesser) version of the two.

forWireVersion

public static Version forWireVersion(int wireVersion)

Returns the best guess at the version of the server based on the wire protocol version number. Returns the first version of the server to support the wire protocol version.

Parameters:

wireVersion - Wire protocol version.

Returns:

The best guess at the version of the server based on the wire protocol version number. Returns null if the version cannot be determined.

later

public static Version later(Version lhs,
            Version rhs)

Returns the later of the two versions. If either version is null then the other version is returned. Only if both version are null will null be returned.

Parameters:

lhs - The first version to compare.

rhs - The second version to compare.

Returns:

The later (greater) version of the two.

parse

public static Version parse(List<NumericElement> versionArray)

Parses a version from a version array. The values in the array are assumed to be NumericElements.

Parameters:

versionArray - The version array to parse.

Returns:

The version.

parse

public static Version parse(String version)

Parses a version of the general format 'int.int.int-suffix'.

Parameters:

version - The version string to parse.

Returns:

The version.

compareTo

public int compareTo(Version other)

Overridden to compare the two versions.

Specified by:

compareTo in interface Comparable<Version>

equals

public boolean equals(Object object)

Determines if the passed object is of this same type as this object and if so that its fields are equal.

Overrides:

equals in class Object

Parameters:

object - The object to compare to.

See Also:

Object.equals(java.lang.Object)

hashCode

public int hashCode()

Computes a reasonable hash code.

Overrides:

hashCode in class Object

Returns:

The hash code value.

toString

public String toString()

Overridden to produce a human readable string for the version.

Overrides:

toString in class Object

compare

protected int compare(int x,
          int y)

Compares two int values numerically. The value returned is identical to what would be returned by:

 Integer.valueOf(x).compareTo(Integer.valueOf(y))
 

Parameters:

x - the first int to compare

y - the second int to compare

Returns:

the value 0 if x == y; a value less than 0 if x < y; and a value greater than 0 if x > y

Since:

1.7