org.springframework.cassandra.core.keyspace

Enum TableOption

java.lang.Object

java.lang.Enum<TableOption>

org.springframework.cassandra.core.keyspace.TableOption

All Implemented Interfaces:

Serializable, Comparable<TableOption>, Option

public enum TableOption
extends Enum<TableOption>
implements Option

Enumeration that represents all known table options. If a table option is not listed here, but is supported by Cassandra, use the method CreateTableSpecification.with(String, Object, boolean, boolean) to write the raw value. Implements Option via delegation, since Enums can't extend anything.

Author:

Matthew T. Adams

See Also:

TableOption.CompactionOption, TableOption.CompressionOption, TableOption.CachingOption

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TableOption.CachingOption Known caching options.
static class	TableOption.CompactionOption Known compaction options.
static class	TableOption.CompressionOption Known compression options.

Enum Constant Summary

Enum Constants

Enum Constant and Description
BLOOM_FILTER_FP_CHANCE bloom_filter_fp_chance
CACHING caching
COMMENT comment
COMPACT_STORAGE COMPACT STORAGE
COMPACTION compaction.
COMPRESSION compression.
DCLOCAL_READ_REPAIR_CHANCE dclocal_read_repair_chance
GC_GRACE_SECONDS gc_grace_seconds
READ_REPAIR_CHANCE read_repair_chance
REPLICATE_ON_WRITE replicate_on_write

Method Summary

Methods

Modifier and Type	Method and Description
void	checkValue(Object value) Checks that the given value can be coerced into the type given by Option.getType().
boolean	escapesValue() Whether this option should escape single quotes in its value.
String	getName() The (usually lower-cased, underscore-separated) name of this table option.
Class<?>	getType() The type that values must be able to be coerced into for this option.
boolean	isCoerceable(Object value) Tests whether the given value can be coerced into the type given by Option.getType().
boolean	quotesValue() Whether this option's value should be single-quoted.
boolean	requiresValue() Whether this option requires a value.
boolean	takesValue() Whether this option takes a value.
String	toString()
String	toString(Object value) First ensures that the given value is coerceable into the type expected by this option, then returns the result of Object.toString() called on the given value.
static TableOption	valueOf(String name) Returns the enum constant of this type with the specified name.
static TableOption[]	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, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

COMMENT

public static final TableOption COMMENT

comment

COMPACT_STORAGE

public static final TableOption COMPACT_STORAGE

COMPACT STORAGE

COMPACTION

public static final TableOption COMPACTION

compaction. Value is a Map<CompactionOption,Object>.

See Also:

TableOption.CompactionOption

COMPRESSION

public static final TableOption COMPRESSION

compression. Value is a Map<CompressionOption,Object>.

See Also:

CompressionOption}

REPLICATE_ON_WRITE

public static final TableOption REPLICATE_ON_WRITE

replicate_on_write

CACHING

public static final TableOption CACHING

caching

See Also:

TableOption.CachingOption

BLOOM_FILTER_FP_CHANCE

public static final TableOption BLOOM_FILTER_FP_CHANCE

bloom_filter_fp_chance

READ_REPAIR_CHANCE

public static final TableOption READ_REPAIR_CHANCE

read_repair_chance

DCLOCAL_READ_REPAIR_CHANCE

public static final TableOption DCLOCAL_READ_REPAIR_CHANCE

dclocal_read_repair_chance

GC_GRACE_SECONDS

public static final TableOption GC_GRACE_SECONDS

gc_grace_seconds

Method Detail

values

public static TableOption[] 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 (TableOption c : TableOption.values())
    System.out.println(c);

Returns:

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

valueOf

public static TableOption valueOf(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:

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

NullPointerException - if the argument is null

getType

public Class<?> getType()

Description copied from interface: Option

The type that values must be able to be coerced into for this option.

Specified by:

getType in interface Option

takesValue

public boolean takesValue()

Description copied from interface: Option

Whether this option takes a value.

Specified by:

takesValue in interface Option

getName

public String getName()

Description copied from interface: Option

The (usually lower-cased, underscore-separated) name of this table option.

Specified by:

getName in interface Option

escapesValue

public boolean escapesValue()

Description copied from interface: Option

Whether this option should escape single quotes in its value.

Specified by:

escapesValue in interface Option

quotesValue

public boolean quotesValue()

Description copied from interface: Option

Whether this option's value should be single-quoted.

Specified by:

quotesValue in interface Option

requiresValue

public boolean requiresValue()

Description copied from interface: Option

Whether this option requires a value.

Specified by:

requiresValue in interface Option

checkValue

public void checkValue(Object value)

Description copied from interface: Option

Checks that the given value can be coerced into the type given by Option.getType().

Specified by:

checkValue in interface Option

isCoerceable

public boolean isCoerceable(Object value)

Description copied from interface: Option

Tests whether the given value can be coerced into the type given by Option.getType().

Specified by:

isCoerceable in interface Option

toString

public String toString()

Overrides:

toString in class Enum<TableOption>

toString

public String toString(Object value)

Description copied from interface: Option

First ensures that the given value is coerceable into the type expected by this option, then returns the result of Object.toString() called on the given value. If this option is escaping quotes (Option.escapesValue() is true), then single quotes will be escaped, and if this option is quoting values ( Option.quotesValue() is true), then the value will be surrounded by single quotes. Given null, returns null.

Specified by:

toString in interface Option

See Also:

Option.escapesValue(), Option.quotesValue()