com.google.common.collect

Class DiscreteDomain.IntegerDomain

java.lang.Object

com.google.common.collect.DiscreteDomain<java.lang.Integer>

com.google.common.collect.DiscreteDomain.IntegerDomain

All Implemented Interfaces:

java.io.Serializable

Enclosing class:

DiscreteDomain<C extends java.lang.Comparable>

private static final class DiscreteDomain.IntegerDomain
extends DiscreteDomain<java.lang.Integer>
implements java.io.Serializable

Field Summary

Fields

Modifier and Type	Field and Description
private static DiscreteDomain.IntegerDomain	INSTANCE
private static long	serialVersionUID

Constructor Summary

Constructors

Modifier	Constructor and Description
private	IntegerDomain()

Method Summary

Modifier and Type	Method and Description
long	distance(java.lang.Integer start, java.lang.Integer end) Returns a signed value indicating how many nested invocations of DiscreteDomain.next(C) (if positive) or DiscreteDomain.previous(C) (if negative) are needed to reach end starting from start.
java.lang.Integer	maxValue() Returns the maximum value of type C, if it has one.
java.lang.Integer	minValue() Returns the minimum value of type C, if it has one.
java.lang.Integer	next(java.lang.Integer value) Returns the unique least value of type C that is greater than value, or null if none exists.
java.lang.Integer	previous(java.lang.Integer value) Returns the unique greatest value of type C that is less than value, or null if none exists.
private java.lang.Object	readResolve()
java.lang.String	toString()

Methods inherited from class com.google.common.collect.DiscreteDomain

bigIntegers, integers, longs

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

INSTANCE

private static final DiscreteDomain.IntegerDomain INSTANCE

serialVersionUID

private static final long serialVersionUID

See Also:

Constant Field Values

Constructor Detail

IntegerDomain

private IntegerDomain()

Method Detail

next

public java.lang.Integer next(java.lang.Integer value)

Description copied from class: DiscreteDomain

Returns the unique least value of type C that is greater than value, or null if none exists. Inverse operation to DiscreteDomain.previous(C).

Specified by:

next in class DiscreteDomain<java.lang.Integer>

Parameters:

value - any value of type C

Returns:

the least value greater than value, or null if value is maxValue()

previous

public java.lang.Integer previous(java.lang.Integer value)

Description copied from class: DiscreteDomain

Returns the unique greatest value of type C that is less than value, or null if none exists. Inverse operation to DiscreteDomain.next(C).

Specified by:

previous in class DiscreteDomain<java.lang.Integer>

Parameters:

value - any value of type C

Returns:

the greatest value less than value, or null if value is minValue()

distance

public long distance(java.lang.Integer start,
                     java.lang.Integer end)

Description copied from class: DiscreteDomain

Returns a signed value indicating how many nested invocations of DiscreteDomain.next(C) (if positive) or DiscreteDomain.previous(C) (if negative) are needed to reach end starting from start. For example, if end = next(next(next(start))), then distance(start, end) == 3 and distance(end, start) == -3. As well, distance(a, a) is always zero.

Note that this function is necessarily well-defined for any discrete type.

Specified by:

distance in class DiscreteDomain<java.lang.Integer>

Returns:

the distance as described above, or Long.MIN_VALUE or Long.MAX_VALUE if the distance is too small or too large, respectively.

minValue

public java.lang.Integer minValue()

Description copied from class: DiscreteDomain

Returns the minimum value of type C, if it has one. The minimum value is the unique value for which Comparable.compareTo(Object) never returns a positive value for any input of type C.

The default implementation throws NoSuchElementException.

Overrides:

minValue in class DiscreteDomain<java.lang.Integer>

Returns:

the minimum value of type C; never null

maxValue

public java.lang.Integer maxValue()

Description copied from class: DiscreteDomain

Returns the maximum value of type C, if it has one. The maximum value is the unique value for which Comparable.compareTo(Object) never returns a negative value for any input of type C.

The default implementation throws NoSuchElementException.

Overrides:

maxValue in class DiscreteDomain<java.lang.Integer>

Returns:

the maximum value of type C; never null

readResolve

private java.lang.Object readResolve()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object