T
- The subtype of the TableOptionsSpecification
.public abstract class TableOptionsSpecification<T extends TableOptionsSpecification<T>> extends TableNameSpecification<TableOptionsSpecification<T>>
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.Constructor and Description |
---|
TableOptionsSpecification() |
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.
|
getName
public T name(String name)
TableNameSpecification
name
in class TableNameSpecification<TableOptionsSpecification<T extends TableOptionsSpecification<T>>>
public T name(CqlIdentifier name)
name
in class TableNameSpecification<TableOptionsSpecification<T extends TableOptionsSpecification<T>>>
public T with(TableOption option)
with(option, null)
.public T with(TableOption option, Object value)
with(String, Object, boolean, boolean)
appropriately from the given TableOption
and value for that
option.option
- The option to set.value
- The value of the option. Must be type-compatible with the TableOption
.with(String, Object, boolean, boolean)
public T with(String name, Object value, boolean escape, boolean quote)
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
.name
- The name of the optionvalue
- 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
.Copyright © 2011–2017 Pivotal Software, Inc.. All rights reserved.