org.springframework.data.domain

Class Range<T extends Comparable<T>>

java.lang.Object

org.springframework.data.domain.Range<T>

public final class Range<T extends Comparable<T>>
extends Object

Simple value object to work with ranges and boundaries.

Since:

1.10

Author:

Oliver Gierke, Mark Paluch

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Range.Bound<T extends Comparable<T>> Value object representing a boundary.
static class	Range.RangeBuilder<T extends Comparable<T>> Builder for Range allowing to specify the upper boundary.

Constructor Summary

Constructors

Constructor and Description
Range(T lowerBound, T upperBound) Deprecated. since 2.0 in favor of of(Bound, Bound).
Range(T lowerBound, T upperBound, boolean lowerInclusive, boolean upperInclusive) Deprecated. since 2.0. Use of(Bound, Bound) and Range.Bound factory methods: Range.Bound.inclusive(Comparable), Range.Bound.exclusive(Comparable)/Range.Bound.unbounded().

Method Summary

Modifier and Type	Method and Description
boolean	contains(T value) Returns whether the Range contains the given value.
boolean	equals(Object o)
static <T extends Comparable<T>> Range.RangeBuilder<T>	from(Range.Bound<T> lower) Create a Range.RangeBuilder given the lower Range.Bound.
@NonNull Range.Bound<T>	getLowerBound() The lower bound of the range.
@NonNull Range.Bound<T>	getUpperBound() The upper bound of the range.
int	hashCode()
boolean	isLowerInclusive() Deprecated. since 2.0, use getLowerBound() and Range.Bound.isInclusive().
boolean	isUpperInclusive() Deprecated. since 2.0, use getUpperBound() and Range.Bound.isInclusive().
static <T extends Comparable<T>> Range<T>	of(Range.Bound<T> lowerBound, Range.Bound<T> upperBound) Creates a new Range with the given lower and upper bound.
String	toString()
static <T extends Comparable<T>> Range<T>	unbounded() Returns an unbounded Range.

Methods inherited from class java.lang.Object

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

Constructor Detail

Range

@Deprecated
public Range(T lowerBound,
                         T upperBound)

Deprecated. since 2.0 in favor of of(Bound, Bound).

Creates a new Range with the given lower and upper bound. Treats the given values as inclusive bounds. Use Range(Comparable, Comparable, boolean, boolean) to configure different bound behavior.

Parameters:

lowerBound - can be null in case upperBound is not null.

upperBound - can be null in case lowerBound is not null.

See Also:

of(Bound, Bound)

Range

@Deprecated
public Range(T lowerBound,
                         T upperBound,
                         boolean lowerInclusive,
                         boolean upperInclusive)

Deprecated. since 2.0. Use of(Bound, Bound) and Range.Bound factory methods: Range.Bound.inclusive(Comparable), Range.Bound.exclusive(Comparable)/Range.Bound.unbounded().

Creates a new Range with the given lower and upper bound as well as the given inclusive/exclusive semantics.

Parameters:

lowerBound - can be null.

upperBound - can be null.

lowerInclusive -

upperInclusive -

Method Detail

unbounded

public static <T extends Comparable<T>> Range<T> unbounded()

Returns an unbounded Range.

Returns:

Since:

2.0

from

public static <T extends Comparable<T>> Range.RangeBuilder<T> from(Range.Bound<T> lower)

Create a Range.RangeBuilder given the lower Range.Bound.

Parameters:

lower - must not be null.

Returns:

Since:

2.0

of

public static <T extends Comparable<T>> Range<T> of(Range.Bound<T> lowerBound,
                                                    Range.Bound<T> upperBound)

Creates a new Range with the given lower and upper bound.

Parameters:

lowerBound - must not be null.

upperBound - must not be null.

Since:

2.0

isLowerInclusive

@Deprecated
public boolean isLowerInclusive()

Deprecated. since 2.0, use getLowerBound() and Range.Bound.isInclusive().

Returns:

isUpperInclusive

@Deprecated
public boolean isUpperInclusive()

Deprecated. since 2.0, use getUpperBound() and Range.Bound.isInclusive().

Returns:

contains

public boolean contains(T value)

Returns whether the Range contains the given value.

Parameters:

value - must not be null.

Returns:

toString

public String toString()

Overrides:

toString in class Object

getLowerBound

@NonNull
public @NonNull Range.Bound<T> getLowerBound()

The lower bound of the range.

getUpperBound

@NonNull
public @NonNull Range.Bound<T> getUpperBound()

The upper bound of the range.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object