TarantoolTuple (Java driver for Picodata 2.0.0 API)

All Superinterfaces:

Iterable<TarantoolField>, Packable, Serializable

All Known Implementing Classes:

TarantoolTupleImpl
```
public interface TarantoolTuple
extends Iterable<TarantoolField>, Packable
```
Basic Tarantool atom of data

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`boolean`	`canGetObject(int fieldPosition, Class<?> objectClass)` Check if a tuple field exists and can be converted to the target value type
`boolean`	`canGetObject(String fieldName, Class<?> objectClass)` Check if a tuple field exists and can be converted to the target value type
`Boolean`	`getBoolean(int fieldPosition)` Get the field value converted to `Boolean`
`Boolean`	`getBoolean(String fieldName)` Get the field value converted to `Boolean`
`byte[]`	`getByteArray(int fieldPosition)` Get the field value converted to `byte[]`
`byte[]`	`getByteArray(String fieldName)` Get the field value converted to `byte[]`
`Character`	`getCharacter(int fieldPosition)` Get the field value converted to `Character`
`Character`	`getCharacter(String fieldName)` Get the field value converted to `Character`
`BigDecimal`	`getDecimal(int fieldPosition)` Get the field value converted to `BigDecimal`
`BigDecimal`	`getDecimal(String fieldName)` Get the field value converted to `BigDecimal`
`Double`	`getDouble(int fieldPosition)` Get the field value converted to `Double`
`Double`	`getDouble(String fieldName)` Get the field value converted to `Double`
`Optional<TarantoolField>`	`getField(int fieldPosition)` Get a tuple field by its position
`Optional<TarantoolField>`	`getField(String fieldName)` Get a tuple field by its name
`List<TarantoolField>`	`getFields()` Get all tuple fields as list
`Float`	`getFloat(int fieldPosition)` Get the field value converted to `Float`
`Float`	`getFloat(String fieldName)` Get the field value converted to `Float`
`Instant`	`getInstant(int fieldPosition)` Get the field value converted to `Instant`
`Instant`	`getInstant(String fieldName)` Get the field value converted to `Instant`
`Integer`	`getInteger(int fieldPosition)` Get the field value converted to `Integer`
`Integer`	`getInteger(String fieldName)` Get the field value converted to `Integer`
`Interval`	`getInterval(int fieldPosition)` Get the field value converted to `Interval`
`Interval`	`getInterval(String fieldName)` Get the field value converted to `Interval`
`List<?>`	`getList(int fieldPosition)` Get the field value converted to `List`
`List<?>`	`getList(String fieldName)` Get the field value converted to `List`
`Long`	`getLong(int fieldPosition)` Get the field value converted to `Long`
`Long`	`getLong(String fieldName)` Get the field value converted to `Long`
`Map<?,?>`	`getMap(int fieldPosition)` Get the field value converted to `Map`
`Map<?,?>`	`getMap(String fieldName)` Get the field value converted to `Map`
`Optional<?>`	`getObject(int fieldPosition)` Get a tuple field value as a raw object
`<O> Optional<O>`	`getObject(int fieldPosition, Class<O> objectClass)` Get a tuple field value by its position specifying the target value type
`Optional<?>`	`getObject(String fieldName)` Get a tuple field value as a raw object
`<O> Optional<O>`	`getObject(String fieldName, Class<O> objectClass)` Get a tuple field value by its name specifying the target value type
`String`	`getString(int fieldPosition)` Get the field value converted to `String`
`String`	`getString(String fieldName)` Get the field value converted to `String`
`UUID`	`getUUID(int fieldPosition)` Get the field value converted to `UUID`
`UUID`	`getUUID(String fieldName)` Get the field value converted to `UUID`
`boolean`	`hasMetadata()` Check whether this tuple includes information about space format
`void`	`putObject(int fieldPosition, Object value)` Set a tuple field value from an object by field position
`void`	`putObject(String fieldName, Object value)` Set a tuple field value from an object by field name
`void`	`setField(int fieldPosition, TarantoolField field)` Set a tuple field by field position
`void`	`setField(String fieldName, TarantoolField field)` Set a tuple field by field name
`int`	`size()` Get the number of fields in this tuple

Methods inherited from interface java.lang.Iterable
forEach, iterator, spliterator

Methods inherited from interface io.picodata.driver.protocol.Packable
toMessagePackValue

- Method Detail
  - hasMetadata
```
boolean hasMetadata()
```
    Check whether this tuple includes information about space format
    
    Returns:
    
    true if we can obtain the tuple fields by names
  - getField
```
Optional<TarantoolField> getField(int fieldPosition)
```
    Get a tuple field by its position
    
    Parameters:
    
    fieldPosition - the field position from the tuple start, starting from 0
    
    Returns:
    
    field or empty optional if the field position is out of tuple length
  - getField
```
Optional<TarantoolField> getField(String fieldName)
```
    Get a tuple field by its name
    
    Parameters:
    
    fieldName - the field name in space
    
    Returns:
    
    field or empty optional if the field not exist in space
  - getFields
```
List<TarantoolField> getFields()
```
    Get all tuple fields as list
    
    Returns:
    
    all tuple fields as list
  - getObject
```
<O> Optional<O> getObject(int fieldPosition,
                          Class<O> objectClass)
```
    Get a tuple field value by its position specifying the target value type
    
    Type Parameters:
    
    O - target value type
    
    Parameters:
    
    fieldPosition - field position from the tuple start, starting from 0
    
    objectClass - target value type class
    
    Returns:
    
    nullable value of a field wrapped in Optional, possibly converted to a Java type
  - canGetObject
```
boolean canGetObject(int fieldPosition,
                     Class<?> objectClass)
```
    Check if a tuple field exists and can be converted to the target value type
    
    Parameters:
    
    fieldPosition - field position from the tuple start, starting from 0
    
    objectClass - target value type class
    
    Returns:
    
    true, if the field exists and can be converted to the given type, false otherwise
  - getObject
```
<O> Optional<O> getObject(String fieldName,
                          Class<O> objectClass)
```
    Get a tuple field value by its name specifying the target value type
    
    Type Parameters:
    
    O - target value type
    
    Parameters:
    
    fieldName - field name, should not be null
    
    objectClass - target value type class
    
    Returns:
    
    nullable value of a field wrapped in Optional, possibly converted to a Java type
  - canGetObject
```
boolean canGetObject(String fieldName,
                     Class<?> objectClass)
```
    Check if a tuple field exists and can be converted to the target value type
    
    Parameters:
    
    fieldName - field name, should not be null
    
    objectClass - target value type class
    
    Returns:
    
    true, if the field exists and can be converted to the given type, false otherwise
  - getObject
```
Optional<?> getObject(int fieldPosition)
```
    Get a tuple field value as a raw object
    
    Parameters:
    
    fieldPosition - field position from the tuple start, starting from 0
    
    Returns:
    
    nullable value of a field wrapped in Optional
  - getObject
```
Optional<?> getObject(String fieldName)
```
    Get a tuple field value as a raw object
    
    Parameters:
    
    fieldName - field name, should not be null
    
    Returns:
    
    nullable value of a field wrapped in Optional
  - size
```
int size()
```
    Get the number of fields in this tuple
    
    Returns:
    
    the number of fields in this tuple
  - setField
```
void setField(int fieldPosition,
              TarantoolField field)
```
    Set a tuple field by field position
    
    Parameters:
    
    fieldPosition - the field position from the tuple start, starting from 0
    
    field - new field
  - setField
```
void setField(String fieldName,
              TarantoolField field)
```
    Set a tuple field by field name
    
    Parameters:
    
    fieldName - the field name, must be not null
    
    field - new field
  - putObject
```
void putObject(int fieldPosition,
               Object value)
```
    Set a tuple field value from an object by field position
    
    Parameters:
    
    fieldPosition - the field position from the tuple start, starting from 0
    
    value - new field value
  - putObject
```
void putObject(String fieldName,
               Object value)
```
    Set a tuple field value from an object by field name
    
    Parameters:
    
    fieldName - the field name, must not be null
    
    value - new field value
  - getByteArray
```
byte[] getByteArray(int fieldPosition)
```
    Get the field value converted to byte[]
    
    Parameters:
    
    fieldPosition - the field position from the tuple start, starting from 0
    
    Returns:
    
    value
  - getByteArray
```
byte[] getByteArray(String fieldName)
```
    Get the field value converted to byte[]
    
    Parameters:
    
    fieldName - the field name, must not be null
    
    Returns:
    
    value
  - getBoolean
```
Boolean getBoolean(int fieldPosition)
```
    Get the field value converted to Boolean
    
    Parameters:
    
    fieldPosition - the field position from the tuple start, starting from 0
    
    Returns:
    
    value
  - getBoolean
```
Boolean getBoolean(String fieldName)
```
    Get the field value converted to Boolean
    
    Parameters:
    
    fieldName - the field name, must not be null
    
    Returns:
    
    value
  - getDouble
```
Double getDouble(int fieldPosition)
```
    Get the field value converted to Double
    
    Parameters:
    
    fieldPosition - the field position from the tuple start, starting from 0
    
    Returns:
    
    value
  - getDouble
```
Double getDouble(String fieldName)
```
    Get the field value converted to Double
    
    Parameters:
    
    fieldName - the field name, must not be null
    
    Returns:
    
    value
  - getFloat
```
Float getFloat(int fieldPosition)
```
    Get the field value converted to Float
    
    Parameters:
    
    fieldPosition - the field position from the tuple start, starting from 0
    
    Returns:
    
    value
  - getFloat
```
Float getFloat(String fieldName)
```
    Get the field value converted to Float
    
    Parameters:
    
    fieldName - the field name, must not be null
    
    Returns:
    
    value
  - getInteger
```
Integer getInteger(int fieldPosition)
```
    Get the field value converted to Integer
    
    Parameters:
    
    fieldPosition - the field position from the tuple start, starting from 0
    
    Returns:
    
    value
  - getInteger
```
Integer getInteger(String fieldName)
```
    Get the field value converted to Integer
    
    Parameters:
    
    fieldName - the field name, must not be null
    
    Returns:
    
    value
  - getLong
```
Long getLong(int fieldPosition)
```
    Get the field value converted to Long
    
    Parameters:
    
    fieldPosition - the field position from the tuple start, starting from 0
    
    Returns:
    
    value
  - getLong
```
Long getLong(String fieldName)
```
    Get the field value converted to Long
    
    Parameters:
    
    fieldName - the field name, must not be null
    
    Returns:
    
    value
  - getString
```
String getString(int fieldPosition)
```
    Get the field value converted to String
    
    Parameters:
    
    fieldPosition - the field position from the tuple start, starting from 0
    
    Returns:
    
    value
  - getString
```
String getString(String fieldName)
```
    Get the field value converted to String
    
    Parameters:
    
    fieldName - the field name, must not be null
    
    Returns:
    
    value
  - getCharacter
```
Character getCharacter(int fieldPosition)
```
    Get the field value converted to Character
    
    Parameters:
    
    fieldPosition - the field position from the tuple start, starting from 0
    
    Returns:
    
    value
  - getCharacter
```
Character getCharacter(String fieldName)
```
    Get the field value converted to Character
    
    Parameters:
    
    fieldName - the field name, must not be null
    
    Returns:
    
    value
  - getUUID
```
UUID getUUID(int fieldPosition)
```
    Get the field value converted to UUID
    
    Parameters:
    
    fieldPosition - the field position from the tuple start, starting from 0
    
    Returns:
    
    value
  - getUUID
```
UUID getUUID(String fieldName)
```
    Get the field value converted to UUID
    
    Parameters:
    
    fieldName - the field name, must not be null
    
    Returns:
    
    value
  - getInstant
```
Instant getInstant(int fieldPosition)
```
    Get the field value converted to Instant
    
    Parameters:
    
    fieldPosition - the field position from the tuple start, starting from 0
    
    Returns:
    
    value
  - getInstant
```
Instant getInstant(String fieldName)
```
    Get the field value converted to Instant
    
    Parameters:
    
    fieldName - the field name, must not be null
    
    Returns:
    
    value
  - getInterval
```
Interval getInterval(int fieldPosition)
```
    Get the field value converted to Interval
    
    Parameters:
    
    fieldPosition - the field position from the tuple start, starting from 0
    
    Returns:
    
    value
  - getInterval
```
Interval getInterval(String fieldName)
```
    Get the field value converted to Interval
    
    Parameters:
    
    fieldName - the field name, must not be null
    
    Returns:
    
    value
  - getDecimal
```
BigDecimal getDecimal(int fieldPosition)
```
    Get the field value converted to BigDecimal
    
    Parameters:
    
    fieldPosition - the field position from the tuple start, starting from 0
    
    Returns:
    
    value
  - getDecimal
```
BigDecimal getDecimal(String fieldName)
```
    Get the field value converted to BigDecimal
    
    Parameters:
    
    fieldName - the field name, must not be null
    
    Returns:
    
    value
  - getList
```
List<?> getList(int fieldPosition)
```
    Get the field value converted to List
    
    Parameters:
    
    fieldPosition - the field position from the tuple start, starting from 0
    
    Returns:
    
    value
  - getList
```
List<?> getList(String fieldName)
```
    Get the field value converted to List
    
    Parameters:
    
    fieldName - the field name, must not be null
    
    Returns:
    
    value
  - getMap
```
Map<?,?> getMap(int fieldPosition)
```
    Get the field value converted to Map
    
    Parameters:
    
    fieldPosition - the field position from the tuple start, starting from 0
    
    Returns:
    
    value
  - getMap
```
Map<?,?> getMap(String fieldName)
```
    Get the field value converted to Map
    
    Parameters:
    
    fieldName - the field name, must not be null
    
    Returns:
    
    value

Interface TarantoolTuple

Method Summary

Methods inherited from interface java.lang.Iterable

Methods inherited from interface io.picodata.driver.protocol.Packable

Method Detail

hasMetadata

getField

getField

getFields

getObject

canGetObject

getObject

canGetObject

getObject

getObject

size

setField

setField

putObject

putObject

getByteArray

getByteArray

getBoolean

getBoolean

getDouble

getDouble

getFloat

getFloat

getInteger

getInteger

getLong

getLong

getString

getString

getCharacter

getCharacter

getUUID

getUUID

getInstant

getInstant

getInterval

getInterval

getDecimal

getDecimal

getList

getList

getMap

getMap