org.apache.cassandra.schema

Enum ColumnMetadata.Kind

java.lang.Object

java.lang.Enum<ColumnMetadata.Kind>

org.apache.cassandra.schema.ColumnMetadata.Kind

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<ColumnMetadata.Kind>

Enclosing class:

ColumnMetadata

public static enum ColumnMetadata.Kind
extends java.lang.Enum<ColumnMetadata.Kind>

The type of CQL3 column this definition represents. There is 4 main type of CQL3 columns: those parts of the partition key, those parts of the clustering columns and amongst the others, regular and static ones. IMPORTANT: this enum is serialized as toString() and deserialized by calling Kind.valueOf(), so do not override toString() or rename existing values.

Enum Constant Summary

Enum Constants

Enum Constant and Description
CLUSTERING
PARTITION_KEY
REGULAR
STATIC

Method Summary

Modifier and Type	Method and Description
boolean	isPrimaryKeyKind()
static ColumnMetadata.Kind	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static ColumnMetadata.Kind[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

PARTITION_KEY

public static final ColumnMetadata.Kind PARTITION_KEY

CLUSTERING

public static final ColumnMetadata.Kind CLUSTERING

REGULAR

public static final ColumnMetadata.Kind REGULAR

STATIC

public static final ColumnMetadata.Kind STATIC

Method Detail

values

public static ColumnMetadata.Kind[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (ColumnMetadata.Kind c : ColumnMetadata.Kind.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static ColumnMetadata.Kind valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

isPrimaryKeyKind

public boolean isPrimaryKeyKind()