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

Class KeyspaceOptionsSpecification<T extends KeyspaceOptionsSpecification<T>>

java.lang.Object

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

org.springframework.data.cassandra.core.cql.keyspace.KeyspaceOptionsSpecification<T>

Type Parameters:

T - the subtype of the KeyspaceOptionsSpecification.

Direct Known Subclasses:

AlterKeyspaceSpecification, CreateKeyspaceSpecification

public abstract class KeyspaceOptionsSpecification<T extends KeyspaceOptionsSpecification<T>>
extends KeyspaceActionSpecification

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 KeyspaceOption for convenient and typesafe use, it ultimately stores its options in a Map<String,Object> for flexibility. This means that with(KeyspaceOption) and with(KeyspaceOption, 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:

John McPeek

Field Summary

Fields

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

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	KeyspaceOptionsSpecification(com.datastax.oss.driver.api.core.CqlIdentifier name)

Method Summary

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

Methods inherited from class org.springframework.data.cassandra.core.cql.keyspace.KeyspaceActionSpecification

canEqual, getName

Methods inherited from class java.lang.Object

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

Field Details

options

protected Map<String,Object> options

Constructor Details

KeyspaceOptionsSpecification

protected KeyspaceOptionsSpecification(com.datastax.oss.driver.api.core.CqlIdentifier name)

Method Details

with

public T with(KeyspaceOption option)

Convenience method that calls with(option, null).

Returns:

this

with

public T with(KeyspaceOption option,
 Object value)

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

Parameters:

option - The option to set.

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

Returns:

this

See Also:

• with(String, Object, boolean, boolean)

with

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

Adds the given option by name to this keyspaces'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()

equals

public boolean equals(@Nullable
 Object o)

Overrides:

equals in class KeyspaceActionSpecification

hashCode

public int hashCode()

Overrides:

hashCode in class KeyspaceActionSpecification