TarantoolTupleImpl (Java driver for Picodata 2.0.0 API)

java.lang.Object
- io.picodata.driver.core.tuple.TarantoolTupleImpl

All Implemented Interfaces:

TarantoolTuple, Packable, Serializable, Iterable<TarantoolField>
```
public class TarantoolTupleImpl
extends Object
implements TarantoolTuple
```
Basic Tarantool tuple implementation

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description
`TarantoolTupleImpl(org.msgpack.value.ArrayValue value, MessagePackMapper mapper)` Construct an instance of `TarantoolTuple`
`TarantoolTupleImpl(org.msgpack.value.ArrayValue value, MessagePackMapper mapper, TarantoolSpaceMetadata spaceMetadata)` Basic constructor.
`TarantoolTupleImpl(Collection<?> values, MessagePackMapper mapper)` Construct an instance of `TarantoolTuple` from a list of objects
`TarantoolTupleImpl(Collection<?> values, MessagePackMapper mapper, TarantoolSpaceMetadata metadata)` Construct an instance of `TarantoolTuple` from a list of objects.
`TarantoolTupleImpl(MessagePackMapper mapper)` Constructor for empty tuple
`TarantoolTupleImpl(MessagePackMapper mapper, TarantoolSpaceMetadata metadata)` Constructor for empty tuple with metadata

Method Summary

All Methods Instance Methods Concrete 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`	`equals(Object o)`
`void`	`forEach(Consumer<? super TarantoolField> action)`
`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
`protected int`	`getFieldPositionByName(String fieldName)`
`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`
`int`	`hashCode()`
`boolean`	`hasMetadata()` Check whether this tuple includes information about space format
`Iterator<TarantoolField>`	`iterator()`
`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
`Spliterator<TarantoolField>`	`spliterator()`
`org.msgpack.value.Value`	`toMessagePackValue(MessagePackObjectMapper mapper)` Convert this instance into a corresponding MessagePack `Value`
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - TarantoolTupleImpl
```
public TarantoolTupleImpl(MessagePackMapper mapper)
```
    Constructor for empty tuple
    
    Parameters:
    
    mapper - provides conversion between MessagePack values and Java objects
  - TarantoolTupleImpl
```
public TarantoolTupleImpl(MessagePackMapper mapper,
                          TarantoolSpaceMetadata metadata)
```
    Constructor for empty tuple with metadata
    
    Parameters:
    
    mapper - provides conversion between MessagePack values and Java objects
    
    metadata - provides information about the target space
  - TarantoolTupleImpl
```
public TarantoolTupleImpl(Collection<?> values,
                          MessagePackMapper mapper)
```
    Construct an instance of TarantoolTuple from a list of objects
    
    Parameters:
    
    values - list of tuple fields data
    
    mapper - provides conversion between MessagePack values and Java objects
  - TarantoolTupleImpl
```
public TarantoolTupleImpl(Collection<?> values,
                          MessagePackMapper mapper,
                          TarantoolSpaceMetadata metadata)
```
    Construct an instance of TarantoolTuple from a list of objects. Provides space metadata which adds extra functionality for working with fields and indexes.
    
    Parameters:
    
    values - list of tuple fields data
    
    mapper - provides conversion between MessagePack values and Java objects
    
    metadata - provides information about the target space
  - TarantoolTupleImpl
```
public TarantoolTupleImpl(org.msgpack.value.ArrayValue value,
                          MessagePackMapper mapper)
```
    Construct an instance of TarantoolTuple
    
    Parameters:
    
    value - serialized Tarantool tuple
    
    mapper - provides conversion between MessagePack values and Java objects
  - TarantoolTupleImpl
```
public TarantoolTupleImpl(org.msgpack.value.ArrayValue value,
                          MessagePackMapper mapper,
                          TarantoolSpaceMetadata spaceMetadata)
```
    Basic constructor. Used for converting Tarantool server responses into Java entities.
    
    Parameters:
    
    value - serialized Tarantool tuple
    
    mapper - provides conversion between MessagePack values and Java objects
    
    spaceMetadata - provides field names and other metadata
- Method Detail
  - hasMetadata
```
public boolean hasMetadata()
```
    Description copied from interface: TarantoolTuple
    
    Check whether this tuple includes information about space format
    
    Specified by:
    
    hasMetadata in interface TarantoolTuple
    
    Returns:
    
    true if we can obtain the tuple fields by names
  - getField
```
public Optional<TarantoolField> getField(int fieldPosition)
```
    Description copied from interface: TarantoolTuple
    
    Get a tuple field by its position
    
    Specified by:
    
    getField in interface TarantoolTuple
    
    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
```
public Optional<TarantoolField> getField(String fieldName)
```
    Description copied from interface: TarantoolTuple
    
    Get a tuple field by its name
    
    Specified by:
    
    getField in interface TarantoolTuple
    
    Parameters:
    
    fieldName - the field name in space
    
    Returns:
    
    field or empty optional if the field not exist in space
  - getFields
```
public List<TarantoolField> getFields()
```
    Description copied from interface: TarantoolTuple
    
    Get all tuple fields as list
    
    Specified by:
    
    getFields in interface TarantoolTuple
    
    Returns:
    
    all tuple fields as list
  - getObject
```
public <O> Optional<O> getObject(int fieldPosition,
                                 Class<O> objectClass)
```
    Description copied from interface: TarantoolTuple
    
    Get a tuple field value by its position specifying the target value type
    
    Specified by:
    
    getObject in interface TarantoolTuple
    
    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
```
public boolean canGetObject(int fieldPosition,
                            Class<?> objectClass)
```
    Description copied from interface: TarantoolTuple
    
    Check if a tuple field exists and can be converted to the target value type
    
    Specified by:
    
    canGetObject in interface TarantoolTuple
    
    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
```
public <O> Optional<O> getObject(String fieldName,
                                 Class<O> objectClass)
```
    Description copied from interface: TarantoolTuple
    
    Get a tuple field value by its name specifying the target value type
    
    Specified by:
    
    getObject in interface TarantoolTuple
    
    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
```
public boolean canGetObject(String fieldName,
                            Class<?> objectClass)
```
    Description copied from interface: TarantoolTuple
    
    Check if a tuple field exists and can be converted to the target value type
    
    Specified by:
    
    canGetObject in interface TarantoolTuple
    
    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
```
public Optional<?> getObject(int fieldPosition)
```
    Description copied from interface: TarantoolTuple
    
    Get a tuple field value as a raw object
    
    Specified by:
    
    getObject in interface TarantoolTuple
    
    Parameters:
    
    fieldPosition - field position from the tuple start, starting from 0
    
    Returns:
    
    nullable value of a field wrapped in Optional
  - getObject
```
public Optional<?> getObject(String fieldName)
```
    Description copied from interface: TarantoolTuple
    
    Get a tuple field value as a raw object
    
    Specified by:
    
    getObject in interface TarantoolTuple
    
    Parameters:
    
    fieldName - field name, should not be null
    
    Returns:
    
    nullable value of a field wrapped in Optional
  - iterator
```
public Iterator<TarantoolField> iterator()
```
    Specified by:
    
    iterator in interface Iterable<TarantoolField>
  - forEach
```
public void forEach(Consumer<? super TarantoolField> action)
```
    Specified by:
    
    forEach in interface Iterable<TarantoolField>
  - spliterator
```
public Spliterator<TarantoolField> spliterator()
```
    Specified by:
    
    spliterator in interface Iterable<TarantoolField>
  - toMessagePackValue
```
public org.msgpack.value.Value toMessagePackValue(MessagePackObjectMapper mapper)
```
    Description copied from interface: Packable
    
    Convert this instance into a corresponding MessagePack Value
    
    Specified by:
    
    toMessagePackValue in interface Packable
    
    Parameters:
    
    mapper - configured Java objects to entities mapper
    
    Returns:
    
    MessagePack entity
  - size
```
public int size()
```
    Description copied from interface: TarantoolTuple
    
    Get the number of fields in this tuple
    
    Specified by:
    
    size in interface TarantoolTuple
    
    Returns:
    
    the number of fields in this tuple
  - setField
```
public void setField(int fieldPosition,
                     TarantoolField field)
```
    Description copied from interface: TarantoolTuple
    
    Set a tuple field by field position
    
    Specified by:
    
    setField in interface TarantoolTuple
    
    Parameters:
    
    fieldPosition - the field position from the tuple start, starting from 0
    
    field - new field
  - setField
```
public void setField(String fieldName,
                     TarantoolField field)
```
    Description copied from interface: TarantoolTuple
    
    Set a tuple field by field name
    
    Specified by:
    
    setField in interface TarantoolTuple
    
    Parameters:
    
    fieldName - the field name, must be not null
    
    field - new field
  - putObject
```
public void putObject(int fieldPosition,
                      Object value)
```
    Description copied from interface: TarantoolTuple
    
    Set a tuple field value from an object by field position
    
    Specified by:
    
    putObject in interface TarantoolTuple
    
    Parameters:
    
    fieldPosition - the field position from the tuple start, starting from 0
    
    value - new field value
  - putObject
```
public void putObject(String fieldName,
                      Object value)
```
    Description copied from interface: TarantoolTuple
    
    Set a tuple field value from an object by field name
    
    Specified by:
    
    putObject in interface TarantoolTuple
    
    Parameters:
    
    fieldName - the field name, must not be null
    
    value - new field value
  - getByteArray
```
public byte[] getByteArray(int fieldPosition)
```
    Description copied from interface: TarantoolTuple
    
    Get the field value converted to byte[]
    
    Specified by:
    
    getByteArray in interface TarantoolTuple
    
    Parameters:
    
    fieldPosition - the field position from the tuple start, starting from 0
    
    Returns:
    
    value
  - getByteArray
```
public byte[] getByteArray(String fieldName)
```
    Description copied from interface: TarantoolTuple
    
    Get the field value converted to byte[]
    
    Specified by:
    
    getByteArray in interface TarantoolTuple
    
    Parameters:
    
    fieldName - the field name, must not be null
    
    Returns:
    
    value
  - getBoolean
```
public Boolean getBoolean(int fieldPosition)
```
    Description copied from interface: TarantoolTuple
    
    Get the field value converted to Boolean
    
    Specified by:
    
    getBoolean in interface TarantoolTuple
    
    Parameters:
    
    fieldPosition - the field position from the tuple start, starting from 0
    
    Returns:
    
    value
  - getBoolean
```
public Boolean getBoolean(String fieldName)
```
    Description copied from interface: TarantoolTuple
    
    Get the field value converted to Boolean
    
    Specified by:
    
    getBoolean in interface TarantoolTuple
    
    Parameters:
    
    fieldName - the field name, must not be null
    
    Returns:
    
    value
  - getDouble
```
public Double getDouble(int fieldPosition)
```
    Description copied from interface: TarantoolTuple
    
    Get the field value converted to Double
    
    Specified by:
    
    getDouble in interface TarantoolTuple
    
    Parameters:
    
    fieldPosition - the field position from the tuple start, starting from 0
    
    Returns:
    
    value
  - getDouble
```
public Double getDouble(String fieldName)
```
    Description copied from interface: TarantoolTuple
    
    Get the field value converted to Double
    
    Specified by:
    
    getDouble in interface TarantoolTuple
    
    Parameters:
    
    fieldName - the field name, must not be null
    
    Returns:
    
    value
  - getFloat
```
public Float getFloat(int fieldPosition)
```
    Description copied from interface: TarantoolTuple
    
    Get the field value converted to Float
    
    Specified by:
    
    getFloat in interface TarantoolTuple
    
    Parameters:
    
    fieldPosition - the field position from the tuple start, starting from 0
    
    Returns:
    
    value
  - getFloat
```
public Float getFloat(String fieldName)
```
    Description copied from interface: TarantoolTuple
    
    Get the field value converted to Float
    
    Specified by:
    
    getFloat in interface TarantoolTuple
    
    Parameters:
    
    fieldName - the field name, must not be null
    
    Returns:
    
    value
  - getInteger
```
public Integer getInteger(int fieldPosition)
```
    Description copied from interface: TarantoolTuple
    
    Get the field value converted to Integer
    
    Specified by:
    
    getInteger in interface TarantoolTuple
    
    Parameters:
    
    fieldPosition - the field position from the tuple start, starting from 0
    
    Returns:
    
    value
  - getInteger
```
public Integer getInteger(String fieldName)
```
    Description copied from interface: TarantoolTuple
    
    Get the field value converted to Integer
    
    Specified by:
    
    getInteger in interface TarantoolTuple
    
    Parameters:
    
    fieldName - the field name, must not be null
    
    Returns:
    
    value
  - getLong
```
public Long getLong(int fieldPosition)
```
    Description copied from interface: TarantoolTuple
    
    Get the field value converted to Long
    
    Specified by:
    
    getLong in interface TarantoolTuple
    
    Parameters:
    
    fieldPosition - the field position from the tuple start, starting from 0
    
    Returns:
    
    value
  - getLong
```
public Long getLong(String fieldName)
```
    Description copied from interface: TarantoolTuple
    
    Get the field value converted to Long
    
    Specified by:
    
    getLong in interface TarantoolTuple
    
    Parameters:
    
    fieldName - the field name, must not be null
    
    Returns:
    
    value
  - getString
```
public String getString(int fieldPosition)
```
    Description copied from interface: TarantoolTuple
    
    Get the field value converted to String
    
    Specified by:
    
    getString in interface TarantoolTuple
    
    Parameters:
    
    fieldPosition - the field position from the tuple start, starting from 0
    
    Returns:
    
    value
  - getString
```
public String getString(String fieldName)
```
    Description copied from interface: TarantoolTuple
    
    Get the field value converted to String
    
    Specified by:
    
    getString in interface TarantoolTuple
    
    Parameters:
    
    fieldName - the field name, must not be null
    
    Returns:
    
    value
  - getCharacter
```
public Character getCharacter(int fieldPosition)
```
    Description copied from interface: TarantoolTuple
    
    Get the field value converted to Character
    
    Specified by:
    
    getCharacter in interface TarantoolTuple
    
    Parameters:
    
    fieldPosition - the field position from the tuple start, starting from 0
    
    Returns:
    
    value
  - getCharacter
```
public Character getCharacter(String fieldName)
```
    Description copied from interface: TarantoolTuple
    
    Get the field value converted to Character
    
    Specified by:
    
    getCharacter in interface TarantoolTuple
    
    Parameters:
    
    fieldName - the field name, must not be null
    
    Returns:
    
    value
  - getUUID
```
public UUID getUUID(int fieldPosition)
```
    Description copied from interface: TarantoolTuple
    
    Get the field value converted to UUID
    
    Specified by:
    
    getUUID in interface TarantoolTuple
    
    Parameters:
    
    fieldPosition - the field position from the tuple start, starting from 0
    
    Returns:
    
    value
  - getUUID
```
public UUID getUUID(String fieldName)
```
    Description copied from interface: TarantoolTuple
    
    Get the field value converted to UUID
    
    Specified by:
    
    getUUID in interface TarantoolTuple
    
    Parameters:
    
    fieldName - the field name, must not be null
    
    Returns:
    
    value
  - getInstant
```
public Instant getInstant(int fieldPosition)
```
    Description copied from interface: TarantoolTuple
    
    Get the field value converted to Instant
    
    Specified by:
    
    getInstant in interface TarantoolTuple
    
    Parameters:
    
    fieldPosition - the field position from the tuple start, starting from 0
    
    Returns:
    
    value
  - getInstant
```
public Instant getInstant(String fieldName)
```
    Description copied from interface: TarantoolTuple
    
    Get the field value converted to Instant
    
    Specified by:
    
    getInstant in interface TarantoolTuple
    
    Parameters:
    
    fieldName - the field name, must not be null
    
    Returns:
    
    value
  - getInterval
```
public Interval getInterval(int fieldPosition)
```
    Description copied from interface: TarantoolTuple
    
    Get the field value converted to Interval
    
    Specified by:
    
    getInterval in interface TarantoolTuple
    
    Parameters:
    
    fieldPosition - the field position from the tuple start, starting from 0
    
    Returns:
    
    value
  - getInterval
```
public Interval getInterval(String fieldName)
```
    Description copied from interface: TarantoolTuple
    
    Get the field value converted to Interval
    
    Specified by:
    
    getInterval in interface TarantoolTuple
    
    Parameters:
    
    fieldName - the field name, must not be null
    
    Returns:
    
    value
  - getDecimal
```
public BigDecimal getDecimal(int fieldPosition)
```
    Description copied from interface: TarantoolTuple
    
    Get the field value converted to BigDecimal
    
    Specified by:
    
    getDecimal in interface TarantoolTuple
    
    Parameters:
    
    fieldPosition - the field position from the tuple start, starting from 0
    
    Returns:
    
    value
  - getDecimal
```
public BigDecimal getDecimal(String fieldName)
```
    Description copied from interface: TarantoolTuple
    
    Get the field value converted to BigDecimal
    
    Specified by:
    
    getDecimal in interface TarantoolTuple
    
    Parameters:
    
    fieldName - the field name, must not be null
    
    Returns:
    
    value
  - getList
```
public List<?> getList(int fieldPosition)
```
    Description copied from interface: TarantoolTuple
    
    Get the field value converted to List
    
    Specified by:
    
    getList in interface TarantoolTuple
    
    Parameters:
    
    fieldPosition - the field position from the tuple start, starting from 0
    
    Returns:
    
    value
  - getList
```
public List<?> getList(String fieldName)
```
    Description copied from interface: TarantoolTuple
    
    Get the field value converted to List
    
    Specified by:
    
    getList in interface TarantoolTuple
    
    Parameters:
    
    fieldName - the field name, must not be null
    
    Returns:
    
    value
  - getMap
```
public Map<?,?> getMap(int fieldPosition)
```
    Description copied from interface: TarantoolTuple
    
    Get the field value converted to Map
    
    Specified by:
    
    getMap in interface TarantoolTuple
    
    Parameters:
    
    fieldPosition - the field position from the tuple start, starting from 0
    
    Returns:
    
    value
  - getMap
```
public Map<?,?> getMap(String fieldName)
```
    Description copied from interface: TarantoolTuple
    
    Get the field value converted to Map
    
    Specified by:
    
    getMap in interface TarantoolTuple
    
    Parameters:
    
    fieldName - the field name, must not be null
    
    Returns:
    
    value
  - getFieldPositionByName
```
protected int getFieldPositionByName(String fieldName)
```
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class TarantoolTupleImpl

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

TarantoolTupleImpl

TarantoolTupleImpl

TarantoolTupleImpl

TarantoolTupleImpl

TarantoolTupleImpl

TarantoolTupleImpl

Method Detail

hasMetadata

getField

getField

getFields

getObject

canGetObject

getObject

canGetObject

getObject

getObject

iterator

forEach

spliterator

toMessagePackValue

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

getFieldPositionByName

equals

hashCode

toString