io.sphere.sdk.search.model

Class FacetRange<T extends Comparable<? super T>>

java.lang.Object

io.sphere.sdk.models.Base

io.sphere.sdk.search.model.FacetRange<T>

Type Parameters:

T - type of the range domain.

public final class FacetRange<T extends Comparable<? super T>>
extends Base

Facet ranges should be of the form [a, b), (-∞, b) or [a, +∞).

Field Summary

Fields

Modifier and Type	Field and Description
protected Bound<T>	lowerBound
protected Bound<T>	upperBound

Method Summary

Modifier and Type	Method and Description
static <T extends Comparable<? super T>> FacetRange<T>	atLeast(T lowerEndpoint) Creates an interval with all values that are greater than or equal to the given endpoint.
boolean	isBounded() Determines whether the range has both bounds.
boolean	isEmpty() Determines whether the range contains no values.
boolean	isLowerBoundExclusive() Determines whether the lower bound is exclusive bounded
boolean	isLowerBoundInclusive() Determines whether the lower bound is inclusive bounded
boolean	isUpperBoundExclusive() Determines whether the upper bound is exclusive bounded
boolean	isUpperBoundInclusive() Determines whether the upper bound is inclusive bounded
static <T extends Comparable<? super T>> FacetRange<T>	lessThan(T upperEndpoint) Creates an interval with all values that are strictly less than the given endpoint.
Bound<T>	lowerBound()
T	lowerEndpoint() Gets the endpoint of the lower bound, if defined.
static <T extends Comparable<? super T>> FacetRange<T>	of(T lowerEndpoint, T upperEndpoint) Creates an interval with the given lower and upper endpoints.
String	serialize(Function<T,String> serializer)
String	toString()
Bound<T>	upperBound()
T	upperEndpoint() Gets the endpoint of the upper bound, if defined.

Methods inherited from class io.sphere.sdk.models.Base

equals, hashCode

Methods inherited from class java.lang.Object

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

Field Detail

lowerBound

@Nullable
protected final Bound<T extends Comparable<? super T>> lowerBound

upperBound

@Nullable
protected final Bound<T extends Comparable<? super T>> upperBound

Method Detail

of

public static <T extends Comparable<? super T>> FacetRange<T> of(T lowerEndpoint,
                                                                 T upperEndpoint)

Creates an interval with the given lower and upper endpoints.

Type Parameters:

T - type of the range domain.

Parameters:

lowerEndpoint - lower endpoint, included in the range.

upperEndpoint - upper endpoint, excluded in the range.

Returns:

the range with the given bounds of the form [a, b).

lessThan

public static <T extends Comparable<? super T>> FacetRange<T> lessThan(T upperEndpoint)

Creates an interval with all values that are strictly less than the given endpoint.

Type Parameters:

T - type of the range domain.

Parameters:

upperEndpoint - upper endpoint, excluded in the range.

Returns:

the range of the form (-∞, b).

atLeast

public static <T extends Comparable<? super T>> FacetRange<T> atLeast(T lowerEndpoint)

Creates an interval with all values that are greater than or equal to the given endpoint.

Type Parameters:

T - type of the range domain.

Parameters:

lowerEndpoint - lower endpoint, included in the range.

Returns:

the range of the form [a, +∞).

lowerBound

@Nullable
public Bound<T> lowerBound()

upperBound

@Nullable
public Bound<T> upperBound()

lowerEndpoint

@Nullable
public T lowerEndpoint()

Gets the endpoint of the lower bound, if defined.

Returns:

the lower endpoint, or absent if the range has no lower bound.

upperEndpoint

@Nullable
public T upperEndpoint()

Gets the endpoint of the upper bound, if defined.

Returns:

the upper endpoint, or absent if the range has no upper bound.

isUpperBoundExclusive

public boolean isUpperBoundExclusive()

Determines whether the upper bound is exclusive bounded

Returns:

true if the upper bound is exclusive, false if the upper bound is inclusive or does not exist

isUpperBoundInclusive

public boolean isUpperBoundInclusive()

Determines whether the upper bound is inclusive bounded

Returns:

true if the upper bound is inclusive, false if the upper bound is exclusive or does not exist

isLowerBoundExclusive

public boolean isLowerBoundExclusive()

Determines whether the lower bound is exclusive bounded

Returns:

true if the lower bound is exclusive, false if the lower bound is inclusive or does not exist

isLowerBoundInclusive

public boolean isLowerBoundInclusive()

Determines whether the lower bound is inclusive bounded

Returns:

true if the lower bound is inclusive, false if the lower bound is exclusive or does not exist

isEmpty

public boolean isEmpty()

Determines whether the range contains no values. A range is empty when it has the form (a, a] or [a, a).

Returns:

true if the range cannot contain any value.

isBounded

public boolean isBounded()

Determines whether the range has both bounds.

Returns:

true if the range has both lower and upper bounds, false otherwise.

serialize

public String serialize(Function<T,String> serializer)

toString

public String toString()

Overrides:

toString in class Base