org.springframework.data.cassandra.core.cql.keyspace

Enum TableOption.CompressionOption

java.lang.Object

java.lang.Enum<TableOption.CompressionOption>

org.springframework.data.cassandra.core.cql.keyspace.TableOption.CompressionOption

All Implemented Interfaces:

Serializable, Comparable<TableOption.CompressionOption>, Option

Enclosing class:

TableOption

public static enum TableOption.CompressionOption
extends Enum<TableOption.CompressionOption>
implements Option

Known compression options.

Author:

Matthew T. Adams

Enum Constant Summary

Enum Constants

Enum Constant and Description
CHUNK_LENGTH_KB chunk_length_kb
CRC_CHECK_CHANCE crc_check_chance
SSTABLE_COMPRESSION sstable_compression

Method Summary

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.CompressionOption	valueOf(String name) Returns the enum constant of this type with the specified name.
static TableOption.CompressionOption[]	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

SSTABLE_COMPRESSION

public static final TableOption.CompressionOption SSTABLE_COMPRESSION

sstable_compression

CHUNK_LENGTH_KB

public static final TableOption.CompressionOption CHUNK_LENGTH_KB

chunk_length_kb

CRC_CHECK_CHANCE

public static final TableOption.CompressionOption CRC_CHECK_CHANCE

crc_check_chance

Method Detail

values

public static TableOption.CompressionOption[] 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.CompressionOption c : TableOption.CompressionOption.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.CompressionOption 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.CompressionOption>

toString

public String toString(@Nullable
                       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 an empty string.

Specified by:

toString in interface Option

See Also:

Option.escapesValue(), Option.quotesValue()