Clustering (apache-cassandra API)

All Superinterfaces:

Clusterable<V>, ClusteringPrefix<V>, IMeasurableMemory

All Known Implementing Classes:

ArrayClustering, BufferClustering, NativeClustering
```
public interface Clustering<V>
extends ClusteringPrefix<V>, IMeasurableMemory
```

Nested Class Summary

Nested Classes
Modifier and Type Interface Description

static class Clustering.Serializer
Serializer for Clustering object.
- Nested classes/interfaces inherited from interface org.apache.cassandra.db.ClusteringPrefix
  ClusteringPrefix.Deserializer, ClusteringPrefix.Kind

Field Summary

Fields
Modifier and Type	Field	Description
`static Clustering<java.nio.ByteBuffer>`	`EMPTY`	Empty clustering for tables having no clustering columns.
`static Clustering.Serializer`	`serializer`
`static Clustering<java.nio.ByteBuffer>`	`STATIC_CLUSTERING`	The special cased clustering used by all static rows.

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method	Description
`default Clustering<?>`	`clone(ByteBufferCloner cloner)`
`static Clustering<java.nio.ByteBuffer>`	`make(java.nio.ByteBuffer... values)`
`default java.lang.String`	`toCQLString(TableMetadata metadata)`
`default java.lang.String`	`toString(TableMetadata metadata)`	Generates a proper string representation of the prefix.
`long`	`unsharedHeapSizeExcludingData()`

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

Methods inherited from interface org.apache.cassandra.db.ClusteringPrefix
accessor, bufferAt, dataSize, digest, get, getBufferArray, getRawValues, isBottom, isEmpty, isTop, kind, minimize, serializeAsPartitionKey, size, stringAt, validate

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

- Field Detail
  - serializer
```
static final Clustering.Serializer serializer
```
  - STATIC_CLUSTERING
```
static final Clustering<java.nio.ByteBuffer> STATIC_CLUSTERING
```
    The special cased clustering used by all static rows. It is a special case in the sense that it's always empty, no matter how many clustering columns the table has.
  - EMPTY
```
static final Clustering<java.nio.ByteBuffer> EMPTY
```
    Empty clustering for tables having no clustering columns.
- Method Detail
  - unsharedHeapSizeExcludingData
```
long unsharedHeapSizeExcludingData()
```
  - clone
```
default Clustering<?> clone(ByteBufferCloner cloner)
```
  - toString
```
default java.lang.String toString(TableMetadata metadata)
```
    Description copied from interface: ClusteringPrefix
    
    Generates a proper string representation of the prefix.
    
    Specified by:
    
    toString in interface ClusteringPrefix<V>
    
    Parameters:
    
    metadata - the metadata for the table the clustering prefix is of.
    
    Returns:
    
    a human-readable string representation fo this prefix.
  - toCQLString
```
default java.lang.String toCQLString(TableMetadata metadata)
```
  - make
```
static Clustering<java.nio.ByteBuffer> make(java.nio.ByteBuffer... values)
```