org.springframework.cassandra.core.keyspace

Class TableOptionsSpecification<T extends TableOptionsSpecification<T>>

java.lang.Object

org.springframework.cassandra.core.keyspace.TableNameSpecification<TableOptionsSpecification<T>>

org.springframework.cassandra.core.keyspace.TableOptionsSpecification<T>

Type Parameters:

T - The subtype of the TableOptionsSpecification.

Direct Known Subclasses:

AlterTableSpecification, TableSpecification

public abstract class TableOptionsSpecification<T extends TableOptionsSpecification<T>>
extends TableNameSpecification<TableOptionsSpecification<T>>

Abstract builder class to support the construction of table specifications that have table options, that is, those options normally specified by WITH ... AND ....

It is important to note that although this class depends on TableOption for convenient and typesafe use, it ultimately stores its options in a Map for flexibility. This means that with(TableOption) and with(TableOption, Object) delegate to with(String, Object, boolean, boolean). This design allows the API to support new Cassandra options as they are introduced without having to update the code immediately.

Author:

Matthew T. Adams

Field Summary

Fields

Modifier and Type	Field and Description
protected Map<String,Object>	options

Constructor Summary

Constructors

Constructor and Description
TableOptionsSpecification()

Method Summary

Modifier and Type	Method and Description
Map<String,Object>	getOptions()
T	name(CqlIdentifier name)
T	name(String name) Sets the table name.
T	with(String name, Object value, boolean escape, boolean quote) Adds the given option by name to this table's options.
T	with(TableOption option) Convenience method that calls with(option, null).
T	with(TableOption option, Object value) Sets the given table option.

Methods inherited from class org.springframework.cassandra.core.keyspace.TableNameSpecification

getName

Methods inherited from class java.lang.Object

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

Field Detail

options

protected Map<String,Object> options

Constructor Detail

TableOptionsSpecification

public TableOptionsSpecification()

Method Detail

name

public T name(String name)

Description copied from class: TableNameSpecification

Sets the table name.

Overrides:

name in class TableNameSpecification<TableOptionsSpecification<T extends TableOptionsSpecification<T>>>

Returns:

this

name

public T name(CqlIdentifier name)

Overrides:

name in class TableNameSpecification<TableOptionsSpecification<T extends TableOptionsSpecification<T>>>

with

public T with(TableOption option)

Convenience method that calls with(option, null).

Returns:

this

with

public T with(TableOption option,
              Object value)

Sets the given table option. This is a convenience method that calls with(String, Object, boolean, boolean) appropriately from the given TableOption and value for that option.

Parameters:

option - The option to set.

value - The value of the option. Must be type-compatible with the TableOption.

Returns:

this

See Also:

with(String, Object, boolean, boolean)

with

public T with(String name,
              Object value,
              boolean escape,
              boolean quote)

Adds the given option by name to this table's options.

Options that have null values are considered single string options where the name of the option is the string to be used. Otherwise, the result of Object.toString() is considered to be the value of the option with the given name. The value, after conversion to string, may have embedded single quotes escaped according to parameter escape and may be single-quoted according to parameter quote.

Parameters:

name - The name of the option

value - The value of the option. If null, the value is ignored and the option is considered to be composed of only the name, otherwise the value's Object.toString() value is used.

escape - Whether to escape the value via CqlStringUtils.escapeSingle(Object). Ignored if given value is an instance of a Map.

quote - Whether to quote the value via CqlStringUtils.singleQuote(Object). Ignored if given value is an instance of a Map.

Returns:

this

getOptions

public Map<String,Object> getOptions()