com.datastax.oss.driver.api.core.data

Interface AccessibleById

All Superinterfaces:

AccessibleByIndex, Data

All Known Subinterfaces:

Bindable<SelfT>, BoundStatement, GettableById, ReactiveRow, Row, SettableById<SelfT>, UdtValue

All Known Implementing Classes:

BoundStatementBuilder

public interface AccessibleById
extends AccessibleByIndex

A data structure where the values are accessible via a CQL identifier.

In the driver, these data structures are always accessible by index as well.

Method Summary

Modifier and Type	Method and Description
default List<Integer>	allIndicesOf(CqlIdentifier id) Returns all the indices where a given identifier appears.
int	firstIndexOf(CqlIdentifier id) Returns the first index where a given identifier appears (depending on the implementation, identifiers may appear multiple times).
DataType	getType(CqlIdentifier id) Returns the CQL type of the value for the first occurrence of id.

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

getType, size

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

codecRegistry, protocolVersion

Method Detail

allIndicesOf

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

Returns all the indices where a given identifier appears.

Throws:

IllegalArgumentException - if the id is invalid.

API note:

the default implementation only exists for backward compatibility. It wraps the result of firstIndexOf(CqlIdentifier) in a singleton list, which is not entirely correct, as it will only return the first occurrence. Therefore it also logs a warning.

Implementors should always override this method (all built-in driver implementations do).

firstIndexOf

int firstIndexOf(@NonNull
                 CqlIdentifier id)

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

Throws:

IllegalArgumentException - if the id is invalid.

getType

@NonNull
DataType getType(@NonNull
                          CqlIdentifier id)

Returns the CQL type of the value for the first occurrence of id.

If you want to avoid the overhead of building a CqlIdentifier, use the variant of this method that takes a string argument.

Throws:

IllegalArgumentException - if the id is invalid.