org.apache.cassandra.db

Class AbstractClusteringPrefix

java.lang.Object

org.apache.cassandra.db.AbstractClusteringPrefix

All Implemented Interfaces:

IMeasurableMemory, Clusterable, ClusteringPrefix

Direct Known Subclasses:

Clustering, Slice.Bound

public abstract class AbstractClusteringPrefix
extends java.lang.Object
implements ClusteringPrefix

Nested Class Summary

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

ClusteringPrefix.Deserializer, ClusteringPrefix.Kind, ClusteringPrefix.Serializer

Field Summary

Fields

Modifier and Type	Field and Description
protected static java.nio.ByteBuffer[]	EMPTY_VALUES_ARRAY
protected ClusteringPrefix.Kind	kind
protected java.nio.ByteBuffer[]	values

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

serializer

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractClusteringPrefix(ClusteringPrefix.Kind kind, java.nio.ByteBuffer[] values)

Method Summary

Modifier and Type	Method and Description
ClusteringPrefix	clustering()
int	dataSize() The size of the data hold by this prefix.
void	digest(java.security.MessageDigest digest) Adds the data of this clustering prefix to the provided digest.
boolean	equals(java.lang.Object o)
java.nio.ByteBuffer	get(int i) Retrieves the ith value of this prefix.
java.nio.ByteBuffer[]	getRawValues() The values of this prefix as an array.
int	hashCode()
ClusteringPrefix.Kind	kind()
int	size() The number of values in this prefix.
long	unsharedHeapSize()
long	unsharedHeapSizeExcludingData()

Methods inherited from class java.lang.Object

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

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

toString

Field Detail

EMPTY_VALUES_ARRAY

protected static final java.nio.ByteBuffer[] EMPTY_VALUES_ARRAY

kind

protected final ClusteringPrefix.Kind kind

values

protected final java.nio.ByteBuffer[] values

Constructor Detail

AbstractClusteringPrefix

protected AbstractClusteringPrefix(ClusteringPrefix.Kind kind,
                                   java.nio.ByteBuffer[] values)

Method Detail

kind

public ClusteringPrefix.Kind kind()

Specified by:

kind in interface ClusteringPrefix

clustering

public ClusteringPrefix clustering()

Specified by:

clustering in interface Clusterable

size

public int size()

Description copied from interface: ClusteringPrefix

The number of values in this prefix. There can't be more values that the this is a prefix of has of clustering columns.

Specified by:

size in interface ClusteringPrefix

Returns:

the number of values in this prefix.

get

public java.nio.ByteBuffer get(int i)

Description copied from interface: ClusteringPrefix

Retrieves the ith value of this prefix.

Specified by:

get in interface ClusteringPrefix

Parameters:

i - the index of the value to retrieve. Must be such that 0 <= i < size().

Returns:

the ith value of this prefix. Note that a value can be null.

getRawValues

public java.nio.ByteBuffer[] getRawValues()

Description copied from interface: ClusteringPrefix

The values of this prefix as an array.

Please note that this may or may not require an array creation. So 1) you should *not* modify the returned array and 2) it's more efficient to use ClusteringPrefix.size() and ClusteringPrefix.get(int) unless you actually need an array.

Specified by:

getRawValues in interface ClusteringPrefix

Returns:

the values for this prefix as an array.

dataSize

public int dataSize()

Description copied from interface: ClusteringPrefix

The size of the data hold by this prefix.

Specified by:

dataSize in interface ClusteringPrefix

Returns:

the size of the data hold by this prefix (this is not the size of the object in memory, just the size of the data it stores).

digest

public void digest(java.security.MessageDigest digest)

Description copied from interface: ClusteringPrefix

Adds the data of this clustering prefix to the provided digest.

Specified by:

digest in interface ClusteringPrefix

Parameters:

digest - the digest to which to add this prefix.

unsharedHeapSize

public long unsharedHeapSize()

Specified by:

unsharedHeapSize in interface IMeasurableMemory

Returns:

the amount of on-heap memory retained by the object that might be reclaimed if the object were reclaimed, i.e. it should try to exclude globally cached data where possible, or counting portions of arrays that are referenced by the object but used by other objects only (e.g. slabbed byte-buffers), etc.

unsharedHeapSizeExcludingData

public long unsharedHeapSizeExcludingData()

hashCode

public final int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public final boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object