com.datastax.oss.driver.api.core.cql

Class BoundStatementBuilder

java.lang.Object

com.datastax.oss.driver.api.core.cql.StatementBuilder<BoundStatementBuilder,BoundStatement>

com.datastax.oss.driver.api.core.cql.BoundStatementBuilder

All Implemented Interfaces:

Bindable<BoundStatementBuilder>, AccessibleById, AccessibleByIndex, AccessibleByName, Data, GettableById, GettableByIndex, GettableByName, SettableById<BoundStatementBuilder>, SettableByIndex<BoundStatementBuilder>, SettableByName<BoundStatementBuilder>

@NotThreadSafe
public class BoundStatementBuilder
extends StatementBuilder<BoundStatementBuilder,BoundStatement>
implements Bindable<BoundStatementBuilder>

A builder to create a bound statement.

This class is mutable and not thread-safe.

Field Summary

Fields inherited from class com.datastax.oss.driver.api.core.cql.StatementBuilder

consistencyLevel, executionProfile, executionProfileName, idempotent, node, nowInSeconds, pageSize, pagingState, routingKey, routingKeyspace, routingToken, serialConsistencyLevel, timeout, timestamp, tracing

Constructor Summary

Constructors

Constructor and Description
BoundStatementBuilder(BoundStatement template)
BoundStatementBuilder(PreparedStatement preparedStatement, ColumnDefinitions variableDefinitions, ByteBuffer[] values, String executionProfileName, DriverExecutionProfile executionProfile, CqlIdentifier routingKeyspace, ByteBuffer routingKey, Token routingToken, Map<String,ByteBuffer> customPayload, Boolean idempotent, boolean tracing, long timestamp, ByteBuffer pagingState, int pageSize, ConsistencyLevel consistencyLevel, ConsistencyLevel serialConsistencyLevel, Duration timeout, CodecRegistry codecRegistry, ProtocolVersion protocolVersion)

Method Summary

Modifier and Type	Method and Description
List<Integer>	allIndicesOf(CqlIdentifier id) Returns all the indices where a given identifier appears.
List<Integer>	allIndicesOf(String name) Returns all the indices where a given identifier appears.
BoundStatement	build()
CodecRegistry	codecRegistry() Returns the registry of all the codecs currently available to convert values for this instance.
int	firstIndexOf(CqlIdentifier id) Returns the first index where a given identifier appears (depending on the implementation, identifiers may appear multiple times).
int	firstIndexOf(String name) Returns the first index where a given identifier appears (depending on the implementation, identifiers may appear multiple times).
ByteBuffer	getBytesUnsafe(int i) Returns the raw binary representation of the ith value.
PreparedStatement	getPreparedStatement() The prepared statement that was used to create this statement.
DataType	getType(int i) Returns the CQL type of the ith value.
ProtocolVersion	protocolVersion() Returns the protocol version that is currently used to convert values for this instance.
BoundStatementBuilder	setBytesUnsafe(int i, ByteBuffer v) Sets the raw binary representation of the ith value.
int	size() Returns the number of values.

Methods inherited from class com.datastax.oss.driver.api.core.cql.StatementBuilder

addCustomPayload, buildCustomPayload, clearCustomPayload, disableTracing, enableTracing, setConsistencyLevel, setDefaultTimestamp, setExecutionProfile, setExecutionProfileName, setFetchSize, setIdempotence, setNode, setNowInSeconds, setPageSize, setPagingState, setQueryTimestamp, setRoutingKey, setRoutingKey, setRoutingKeyspace, setRoutingKeyspace, setRoutingToken, setSerialConsistencyLevel, setTimeout, setTracing, setTracing

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.datastax.oss.driver.api.core.cql.Bindable

isSet, isSet, isSet, unset, unset, unset

Methods inherited from interface com.datastax.oss.driver.api.core.data.GettableById

get, get, get, getBigDecimal, getBigInteger, getBool, getBoolean, getByte, getByteBuffer, getBytesUnsafe, getCqlDuration, getDouble, getFloat, getInetAddress, getInstant, getInt, getList, getLocalDate, getLocalTime, getLong, getMap, getObject, getSet, getShort, getString, getToken, getTupleValue, getUdtValue, getUuid, isNull

Methods inherited from interface com.datastax.oss.driver.api.core.data.GettableByName

get, get, get, getBigDecimal, getBigInteger, getBool, getBoolean, getByte, getByteBuffer, getBytesUnsafe, getCqlDuration, getDouble, getFloat, getInetAddress, getInstant, getInt, getList, getLocalDate, getLocalTime, getLong, getMap, getObject, getSet, getShort, getString, getToken, getTupleValue, getUdtValue, getUuid, isNull

Methods inherited from interface com.datastax.oss.driver.api.core.data.GettableByIndex

get, get, get, getBigDecimal, getBigInteger, getBool, getBoolean, getByte, getByteBuffer, getCqlDuration, getDouble, getFloat, getInetAddress, getInstant, getInt, getList, getLocalDate, getLocalTime, getLong, getMap, getObject, getSet, getShort, getString, getToken, getTupleValue, getUdtValue, getUuid, isNull

Methods inherited from interface com.datastax.oss.driver.api.core.data.SettableById

getType, set, set, set, setBigDecimal, setBigInteger, setBool, setBoolean, setByte, setByteBuffer, setBytesUnsafe, setCqlDuration, setDouble, setFloat, setInetAddress, setInstant, setInt, setList, setLocalDate, setLocalTime, setLong, setMap, setSet, setShort, setString, setToken, setToNull, setTupleValue, setUdtValue, setUuid

Methods inherited from interface com.datastax.oss.driver.api.core.data.SettableByName

getType, set, set, set, setBigDecimal, setBigInteger, setBool, setBoolean, setByte, setByteBuffer, setBytesUnsafe, setCqlDuration, setDouble, setFloat, setInetAddress, setInstant, setInt, setList, setLocalDate, setLocalTime, setLong, setMap, setSet, setShort, setString, setToken, setToNull, setTupleValue, setUdtValue, setUuid

Methods inherited from interface com.datastax.oss.driver.api.core.data.SettableByIndex

set, set, set, setBigDecimal, setBigInteger, setBool, setBoolean, setByte, setByteBuffer, setCqlDuration, setDouble, setFloat, setInetAddress, setInstant, setInt, setList, setLocalDate, setLocalTime, setLong, setMap, setSet, setShort, setString, setToken, setToNull, setTupleValue, setUdtValue, setUuid

Constructor Detail

BoundStatementBuilder

public BoundStatementBuilder(@NonNull
                             PreparedStatement preparedStatement,
                             @NonNull
                             ColumnDefinitions variableDefinitions,
                             @NonNull
                             ByteBuffer[] values,
                             @Nullable
                             String executionProfileName,
                             @Nullable
                             DriverExecutionProfile executionProfile,
                             @Nullable
                             CqlIdentifier routingKeyspace,
                             @Nullable
                             ByteBuffer routingKey,
                             @Nullable
                             Token routingToken,
                             @NonNull
                             Map<String,ByteBuffer> customPayload,
                             @Nullable
                             Boolean idempotent,
                             boolean tracing,
                             long timestamp,
                             @Nullable
                             ByteBuffer pagingState,
                             int pageSize,
                             @Nullable
                             ConsistencyLevel consistencyLevel,
                             @Nullable
                             ConsistencyLevel serialConsistencyLevel,
                             @Nullable
                             Duration timeout,
                             @NonNull
                             CodecRegistry codecRegistry,
                             @NonNull
                             ProtocolVersion protocolVersion)

BoundStatementBuilder

public BoundStatementBuilder(@NonNull
                             BoundStatement template)

Method Detail

getPreparedStatement

@NonNull
public PreparedStatement getPreparedStatement()

The prepared statement that was used to create this statement.

allIndicesOf

@NonNull
public List<Integer> allIndicesOf(@NonNull
                                           CqlIdentifier id)

Description copied from interface: AccessibleById

Returns all the indices where a given identifier appears.

Specified by:

allIndicesOf in interface AccessibleById

firstIndexOf

public int firstIndexOf(@NonNull
                        CqlIdentifier id)

Description copied from interface: AccessibleById

Returns the first index where a given identifier appears (depending on the implementation, identifiers may appear multiple times).

Specified by:

firstIndexOf in interface AccessibleById

allIndicesOf

@NonNull
public List<Integer> allIndicesOf(@NonNull
                                           String name)

Description copied from interface: AccessibleByName

Returns all the indices where a given identifier appears.

Specified by:

allIndicesOf in interface AccessibleByName

firstIndexOf

public int firstIndexOf(@NonNull
                        String name)

Description copied from interface: AccessibleByName

Returns the first index where a given identifier appears (depending on the implementation, identifiers may appear multiple times).

Specified by:

firstIndexOf in interface AccessibleByName

setBytesUnsafe

@NonNull
public BoundStatementBuilder setBytesUnsafe(int i,
                                                     ByteBuffer v)

Description copied from interface: SettableByIndex

Sets the raw binary representation of the ith value.

This is primarily for internal use; you'll likely want to use one of the typed setters instead, to pass a higher-level Java representation.

Specified by:

setBytesUnsafe in interface SettableByIndex<BoundStatementBuilder>

v - the raw value, or null to set the CQL value NULL. For performance reasons, this is the actual instance used internally. If pass in a buffer that you're going to modify elsewhere in your application, make sure to duplicate it beforehand. If you change the buffer's index or its contents in any way, further usage of this data will have unpredictable results.

getBytesUnsafe

public ByteBuffer getBytesUnsafe(int i)

Description copied from interface: GettableByIndex

Returns the raw binary representation of the ith value.

This is primarily for internal use; you'll likely want to use one of the typed getters instead, to get a higher-level Java representation.

Specified by:

getBytesUnsafe in interface GettableByIndex

Returns:

the raw value, or null if the CQL value is NULL. For performance reasons, this is the actual instance used internally. If you read data from the buffer, make sure to duplicate it beforehand, or only use relative methods. If you change the buffer's index or its contents in any way, any other getter invocation for this value will have unpredictable results.

size

public int size()

Description copied from interface: AccessibleByIndex

Returns the number of values.

Specified by:

size in interface AccessibleByIndex

getType

@NonNull
public DataType getType(int i)

Description copied from interface: AccessibleByIndex

Returns the CQL type of the ith value.

Specified by:

getType in interface AccessibleByIndex

codecRegistry

@NonNull
public CodecRegistry codecRegistry()

Description copied from interface: Data

Returns the registry of all the codecs currently available to convert values for this instance.

If you obtained this object from the driver, this will be set automatically. If you created it manually, or just deserialized it, it is set to CodecRegistry.DEFAULT. You can reattach this object to an existing driver instance to use its codec registry.

Specified by:

codecRegistry in interface Data

See Also:

Detachable

protocolVersion

@NonNull
public ProtocolVersion protocolVersion()

Description copied from interface: Data

Returns the protocol version that is currently used to convert values for this instance.

If you obtained this object from the driver, this will be set automatically. If you created it manually, or just deserialized it, it is set to ProtocolVersion.DEFAULT. You can reattach this object to an existing driver instance to use its protocol version.

Specified by:

protocolVersion in interface Data

See Also:

Detachable

build

@NonNull
public BoundStatement build()

Specified by:

build in class StatementBuilder<BoundStatementBuilder,BoundStatement>