Package org.apache.cassandra.db

Interface ClusteringBound<V>

All Superinterfaces:

Clusterable<V>, ClusteringBoundOrBoundary<V>, ClusteringPrefix<V>, IMeasurableMemory

All Known Implementing Classes:

ArrayClusteringBound, BufferClusteringBound

public interface ClusteringBound<V>
extends ClusteringBoundOrBoundary<V>

The start or end of a range of clusterings, either inclusive or exclusive.

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.cassandra.db.ClusteringBoundOrBoundary

ClusteringBoundOrBoundary.Serializer

Nested classes/interfaces inherited from interface org.apache.cassandra.db.ClusteringPrefix

ClusteringPrefix.Deserializer, ClusteringPrefix.Kind

Field Summary

Fields

Modifier and Type	Field	Description
static ClusteringBound<?>	BOTTOM	The smallest start bound, i.e.
static ClusteringBound<?>	MAX_START	The biggest start bound, i.e.
static ClusteringBound<?>	MIN_END	The smallest end bound, i.e.
static ClusteringBound<?>	TOP	The biggest end bound, i.e.

Fields inherited from interface org.apache.cassandra.db.ClusteringBoundOrBoundary

serializer

Method Summary

Modifier and Type	Method	Description
default ClusteringBound<V>	artificialLowerBound(boolean isReversed)
default ClusteringBound<V>	asEndBound()	Returns this prefix as an end bound.
default ClusteringBound<V>	asStartBound()	Returns this prefix as a start bound.
static ClusteringPrefix.Kind	boundKind(boolean isStart, boolean isInclusive)
ClusteringBound<java.nio.ByteBuffer>	clone(ByteBufferCloner cloner)
static ClusteringBound<?>	create(ClusteringComparator comparator, boolean isStart, boolean isInclusive, java.lang.Object... values)
static <V> ClusteringBound<V>	create(ClusteringPrefix.Kind kind, ClusteringPrefix<V> from)
static <V> ClusteringBound<V>	exclusiveEndOf(ClusteringPrefix<V> from)
static <V> ClusteringBound<V>	exclusiveStartOf(ClusteringPrefix<V> from)
static <V> ClusteringBound<V>	inclusiveEndOf(ClusteringPrefix<V> from)
static <V> ClusteringBound<V>	inclusiveStartOf(ClusteringPrefix<V> from)
ClusteringBound<V>	invert()	Returns the inverse of the current bound.
default boolean	isArtificial()
default boolean	isEnd()
default boolean	isExclusive()
default boolean	isInclusive()
default boolean	isStart()

Methods inherited from interface org.apache.cassandra.db.Clusterable

clustering

Methods inherited from interface org.apache.cassandra.db.ClusteringBoundOrBoundary

isBoundary, isClose, isOpen, toString, toString

Methods inherited from interface org.apache.cassandra.db.ClusteringPrefix

accessor, bufferAt, clusteringString, dataSize, digest, get, getBufferArray, getRawValues, isBottom, isEmpty, isTop, kind, retainable, serializeAsPartitionKey, size, stringAt, validate, validate

Methods inherited from interface org.apache.cassandra.cache.IMeasurableMemory

unsharedHeapSize

Field Detail

BOTTOM

static final ClusteringBound<?> BOTTOM

The smallest start bound, i.e. the one that starts before any row.

TOP

static final ClusteringBound<?> TOP

The biggest end bound, i.e. the one that ends after any row.

MAX_START

static final ClusteringBound<?> MAX_START

The biggest start bound, i.e. the one that starts after any row.

MIN_END

static final ClusteringBound<?> MIN_END

The smallest end bound, i.e. the one that end before any row.

Method Detail

boundKind

static ClusteringPrefix.Kind boundKind(boolean isStart,
                                       boolean isInclusive)

invert

ClusteringBound<V> invert()

Description copied from interface: ClusteringBoundOrBoundary

Returns the inverse of the current bound.

This invert both start into end (and vice-versa) and inclusive into exclusive (and vice-versa).

Specified by:

invert in interface ClusteringBoundOrBoundary<V>

Returns:

the invert of this bound. For instance, if this bound is an exlusive start, this return an inclusive end with the same values.

clone

ClusteringBound<java.nio.ByteBuffer> clone(ByteBufferCloner cloner)

Specified by:

clone in interface ClusteringBoundOrBoundary<V>

isStart

default boolean isStart()

isEnd

default boolean isEnd()

isInclusive

default boolean isInclusive()

isExclusive

default boolean isExclusive()

isArtificial

default boolean isArtificial()

artificialLowerBound

default ClusteringBound<V> artificialLowerBound(boolean isReversed)

create

static <V> ClusteringBound<V> create(ClusteringPrefix.Kind kind,
                                     ClusteringPrefix<V> from)

inclusiveStartOf

static <V> ClusteringBound<V> inclusiveStartOf(ClusteringPrefix<V> from)

inclusiveEndOf

static <V> ClusteringBound<V> inclusiveEndOf(ClusteringPrefix<V> from)

exclusiveStartOf

static <V> ClusteringBound<V> exclusiveStartOf(ClusteringPrefix<V> from)

exclusiveEndOf

static <V> ClusteringBound<V> exclusiveEndOf(ClusteringPrefix<V> from)

create

static ClusteringBound<?> create(ClusteringComparator comparator,
                                 boolean isStart,
                                 boolean isInclusive,
                                 java.lang.Object... values)

asStartBound

default ClusteringBound<V> asStartBound()

Description copied from interface: ClusteringPrefix

Returns this prefix as a start bound. If this prefix is a bound, just returns it asserting that it is a start bound. If this prefix is a clustering, returns an included start bound. If this prefix is a boundary, returns an open bound of it

Specified by:

asStartBound in interface ClusteringPrefix<V>

asEndBound

default ClusteringBound<V> asEndBound()

Description copied from interface: ClusteringPrefix

Returns this prefix as an end bound. If this prefix is a bound, just returns it asserting that it is an end bound. If this prefix is a clustering, returns an included end bound. In this prefix is a boundary, returns a close bound of it.

Specified by:

asEndBound in interface ClusteringPrefix<V>