com.allanbank.mongodb.client

Class VersionRange

java.lang.Object

com.allanbank.mongodb.client.VersionRange

All Implemented Interfaces:

Serializable

public class VersionRange
extends Object
implements Serializable

VersionRange provides a simple class to hold a range of versions.

See Also:

Serialized Form

API Warning:

This class is NOT part of the drivers API. This class may be mutated in incompatible ways between any two releases of the driver.

Copyright ©:

2014, Allanbank Consulting, Inc., All Rights Reserved

Method Summary

Methods

Modifier and Type	Method and Description
boolean	contains(Version version) Returns true if the version is within the bounds of this VersionRange.
boolean	equals(Object object)
Version	getLowerBounds() Returns the lower, inclusive, bounds of the range.
Version	getUpperBounds() Returns the upper, exclusive, bounds of the range.
int	hashCode()
static VersionRange	maximum(Version maxVersion) Returns a VersionRange that is only limited by a maximum version.
static VersionRange	minimum(Version minVersion) Returns a VersionRange that is only limited by a minimum version.
static VersionRange	range(Version minVersion, Version maxVersion) Returns a VersionRange based on the minimum and maximum versions provided.
String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

maximum

public static VersionRange maximum(Version maxVersion)

Returns a VersionRange that is only limited by a maximum version. The minimum version is set to Version.VERSION_0.

Parameters:

maxVersion - The maximum version in the range. If null then null is returned.

Returns:

The version range with only a maximum value.

minimum

public static VersionRange minimum(Version minVersion)

Returns a VersionRange that is only limited by a minimum version. The maximum version is set to Version.UNKNOWN.

Parameters:

minVersion - The minimum version in the range. If null then null is returned.

Returns:

The version range with only a minimum value.

range

public static VersionRange range(Version minVersion,
                 Version maxVersion)

Returns a VersionRange based on the minimum and maximum versions provided.

If minVersion and maxVersion are both null then null is returned.

If only minVersion is null then the lower bound is set to Version.VERSION_0.

If only maxVersion is null then the upper bound is set to Version.UNKNOWN.

Parameters:

minVersion - The minimum version in the range. If null then null is returned.

maxVersion - The maximum version in the range. If null then null is returned.

Returns:

The version range with only a minimum value.

contains

public boolean contains(Version version)

Returns true if the version is within the bounds of this VersionRange.

Parameters:

version - The version to check if it is within range.

Returns:

True if the version is within the bounds of this VersionRange.

equals

public boolean equals(Object object)

Overridden to compare this VersionRange to the other.

Overrides:

equals in class Object

getLowerBounds

public Version getLowerBounds()

Returns the lower, inclusive, bounds of the range.

Returns:

The lower, inclusive, bounds of the range.

getUpperBounds

public Version getUpperBounds()

Returns the upper, exclusive, bounds of the range.

Returns:

The upper, exclusive, bounds of the range.

hashCode

public int hashCode()

Overridden to hash the version range.

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object