java.lang.Object
- com.clickhouse.client.data.ClickHouseObjectValue<List<Object>>
- - com.clickhouse.client.data.ClickHouseTupleValue

All Implemented Interfaces:

ClickHouseValue, Serializable
```
public class ClickHouseTupleValue
extends ClickHouseObjectValue<List<Object>>
```
Wrapper class of Tuple.

See Also:

Serialized Form

Constructor Summary

Constructors
Modifier Constructor Description

protected ClickHouseTupleValue(List<Object> value)

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`Object[]`	`asArray()`	Gets value as an object array.
`<T> T[]`	`asArray(Class<T> clazz)`	Gets value as an array.
`Map<Object,Object>`	`asMap()`	Gets value as a map.
`<K,V> Map<K,V>`	`asMap(Class<K> keyClass, Class<V> valueClass)`	Gets value as a map.
`String`	`asString(int length, Charset charset)`	Gets value as fixed length(in bytes) string.
`List<Object>`	`asTuple()`	Gets value as ordered list(tuple).
`ClickHouseTupleValue`	`copy(boolean deep)`	Gets a copy of this value object.
`boolean`	`equals(Object obj)`
`protected Object`	`getSingleValue()`
`int`	`hashCode()`
`boolean`	`isNullOrEmpty()`	Checks if the value is null, or empty for non-null types like Array, Tuple and Map.
`static ClickHouseTupleValue`	`of(ClickHouseValue ref, List<Object> value)`	Update value of the given object or create a new instance if `ref` is null.
`static ClickHouseTupleValue`	`of(Object... value)`	Wrap the given value.
`ClickHouseTupleValue`	`resetToNullOrEmpty()`	Resets value to null, or empty when null is not supported(e.g.
`String`	`toSqlExpression()`	Converts the value to escaped SQL expression.
`ClickHouseTupleValue`	`update(boolean[] value)`	Updates value.
`ClickHouseTupleValue`	`update(byte value)`	Updates value.
`ClickHouseTupleValue`	`update(byte[] value)`	Updates value.
`ClickHouseTupleValue`	`update(char[] value)`	Updates value.
`ClickHouseTupleValue`	`update(double value)`	Updates value.
`ClickHouseTupleValue`	`update(double[] value)`	Updates value.
`ClickHouseTupleValue`	`update(float value)`	Updates value.
`ClickHouseTupleValue`	`update(float[] value)`	Updates value.
`ClickHouseTupleValue`	`update(int value)`	Updates value.
`ClickHouseTupleValue`	`update(int[] value)`	Updates value.
`ClickHouseTupleValue`	`update(long value)`	Updates value.
`ClickHouseTupleValue`	`update(long[] value)`	Updates value.
`ClickHouseTupleValue`	`update(short value)`	Updates value.
`ClickHouseTupleValue`	`update(short[] value)`	Updates value.
`ClickHouseTupleValue`	`update(ClickHouseValue value)`	Updates value.
`ClickHouseTupleValue`	`update(Enum<?> value)`	Updates value.
`ClickHouseTupleValue`	`update(Object value)`	Updates value.
`ClickHouseTupleValue`	`update(Object[] value)`	Updates value.
`ClickHouseTupleValue`	`update(String value)`	Updates value.
`ClickHouseTupleValue`	`update(BigDecimal value)`	Updates value.
`ClickHouseTupleValue`	`update(BigInteger value)`	Updates value.
`ClickHouseTupleValue`	`update(Inet4Address value)`	Updates value.
`ClickHouseTupleValue`	`update(Inet6Address value)`	Updates value.
`ClickHouseTupleValue`	`update(LocalDate value)`	Updates value.
`ClickHouseTupleValue`	`update(LocalDateTime value)`	Updates value.
`ClickHouseTupleValue`	`update(LocalTime value)`	Updates value.
`ClickHouseTupleValue`	`update(Collection<?> value)`	Updates value.
`ClickHouseTupleValue`	`update(Enumeration<?> value)`	Updates value.
`ClickHouseTupleValue`	`update(Map<?,?> value)`	Updates value.
`ClickHouseTupleValue`	`update(UUID value)`	Updates value.

Methods inherited from class com.clickhouse.client.data.ClickHouseObjectValue
asBigDecimal, asBigInteger, asByte, asDouble, asFloat, asInteger, asLong, asObject, asShort, getValue, set, toString

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

Methods inherited from interface com.clickhouse.client.ClickHouseValue
asBigDecimal, asBoolean, asByteStream, asCharacter, asCharacterStream, asDate, asDateTime, asDateTime, asEnum, asInet4Address, asInet6Address, asObject, asOffsetDateTime, asOffsetDateTime, asString, asString, asString, asTime, asTime, asUuid, asZonedDateTime, asZonedDateTime, copy, isInfinity, isNaN, newUnsupportedException, update, update, update, update, update, updateUnknown

- Constructor Detail
  - ClickHouseTupleValue
```
protected ClickHouseTupleValue(List<Object> value)
```
- Method Detail
  - of
```
public static ClickHouseTupleValue of(Object... value)
```
    Wrap the given value.
    
    Parameters:
    
    value - value
    
    Returns:
    
    object representing the value
  - of
```
public static ClickHouseTupleValue of(ClickHouseValue ref,
                                      List<Object> value)
```
    Update value of the given object or create a new instance if ref is null.
    
    Parameters:
    
    ref - object to update, could be null
    
    value - value
    
    Returns:
    
    same object as ref or a new instance if it's null
  - getSingleValue
```
protected Object getSingleValue()
```
  - copy
```
public ClickHouseTupleValue copy(boolean deep)
```
    Description copied from interface: ClickHouseValue
    
    Gets a copy of this value object.
    
    Parameters:
    
    deep - true to create a deep copy; false for a shallow copy
    
    Returns:
    
    copy of this value object
  - asArray
```
public Object[] asArray()
```
    Description copied from interface: ClickHouseValue
    
    Gets value as an object array.
    
    Returns:
    
    non-null object array
  - asArray
```
public <T> T[] asArray(Class<T> clazz)
```
    Description copied from interface: ClickHouseValue
    
    Gets value as an array.
    
    Type Parameters:
    
    T - type of the element
    
    Parameters:
    
    clazz - class of the element
    
    Returns:
    
    non-null array
  - asMap
```
public Map<Object,Object> asMap()
```
    Description copied from interface: ClickHouseValue
    
    Gets value as a map.
    
    Returns:
    
    non-null map value
  - asMap
```
public <K,V> Map<K,V> asMap(Class<K> keyClass,
                                        Class<V> valueClass)
```
    Description copied from interface: ClickHouseValue
    
    Gets value as a map.
    
    Type Parameters:
    
    K - type of key
    
    V - type of value
    
    Parameters:
    
    keyClass - non-null class of key
    
    valueClass - non-null class of value
    
    Returns:
    
    non-null map value
  - asString
```
public String asString(int length,
                       Charset charset)
```
    Description copied from interface: ClickHouseValue
    
    Gets value as fixed length(in bytes) string.
    
    Specified by:
    
    asString in interface ClickHouseValue
    
    Overrides:
    
    asString in class ClickHouseObjectValue<List<Object>>
    
    Parameters:
    
    length - byte length of the string, 0 or negative number means unbounded
    
    charset - charset, null is same as default(UTF-8)
    
    Returns:
    
    string value, could be null
  - asTuple
```
public List<Object> asTuple()
```
    Description copied from interface: ClickHouseValue
    
    Gets value as ordered list(tuple).
    
    Returns:
    
    non-null list
  - isNullOrEmpty
```
public boolean isNullOrEmpty()
```
    Description copied from interface: ClickHouseValue
    
    Checks if the value is null, or empty for non-null types like Array, Tuple and Map.
    Please pay attention that only nullability will be considered for String, meaning this method will return false for an empty string. This is because String is treated as value-based type instead of a container like Array.
    
    Specified by:
    
    isNullOrEmpty in interface ClickHouseValue
    
    Overrides:
    
    isNullOrEmpty in class ClickHouseObjectValue<List<Object>>
    
    Returns:
    
    true if the value is null or empty; false otherwise
  - resetToNullOrEmpty
```
public ClickHouseTupleValue resetToNullOrEmpty()
```
    Description copied from interface: ClickHouseValue
    
    Resets value to null, or empty when null is not supported(e.g. Array, Tuple and Map etc.).
    Keep in mind that String is value-based type, so this method will change its value to null instead of an empty string.
    
    Specified by:
    
    resetToNullOrEmpty in interface ClickHouseValue
    
    Overrides:
    
    resetToNullOrEmpty in class ClickHouseObjectValue<List<Object>>
    
    Returns:
    
    this object
  - toSqlExpression
```
public String toSqlExpression()
```
    Description copied from interface: ClickHouseValue
    
    Converts the value to escaped SQL expression. For example, number 123 will be converted to 123, while string "12'3" will be converted to @{code '12\'3'}.
    
    Specified by:
    
    toSqlExpression in interface ClickHouseValue
    
    Overrides:
    
    toSqlExpression in class ClickHouseObjectValue<List<Object>>
    
    Returns:
    
    escaped SQL expression
  - update
```
public ClickHouseTupleValue update(boolean[] value)
```
    Description copied from interface: ClickHouseValue
    
    Updates value.
    
    Parameters:
    
    value - value to update
    
    Returns:
    
    this object
  - update
```
public ClickHouseTupleValue update(char[] value)
```
    Description copied from interface: ClickHouseValue
    
    Updates value.
    
    Parameters:
    
    value - value to update
    
    Returns:
    
    this object
  - update
```
public ClickHouseTupleValue update(byte value)
```
    Description copied from interface: ClickHouseValue
    
    Updates value.
    
    Parameters:
    
    value - value to update
    
    Returns:
    
    this object
  - update
```
public ClickHouseTupleValue update(byte[] value)
```
    Description copied from interface: ClickHouseValue
    
    Updates value.
    
    Parameters:
    
    value - value to update
    
    Returns:
    
    this object
  - update
```
public ClickHouseTupleValue update(short value)
```
    Description copied from interface: ClickHouseValue
    
    Updates value.
    
    Parameters:
    
    value - value to update
    
    Returns:
    
    this object
  - update
```
public ClickHouseTupleValue update(short[] value)
```
    Description copied from interface: ClickHouseValue
    
    Updates value.
    
    Parameters:
    
    value - value to update
    
    Returns:
    
    this object
  - update
```
public ClickHouseTupleValue update(int value)
```
    Description copied from interface: ClickHouseValue
    
    Updates value.
    
    Parameters:
    
    value - value to update
    
    Returns:
    
    this object
  - update
```
public ClickHouseTupleValue update(int[] value)
```
    Description copied from interface: ClickHouseValue
    
    Updates value.
    
    Parameters:
    
    value - value to update
    
    Returns:
    
    this object
  - update
```
public ClickHouseTupleValue update(long value)
```
    Description copied from interface: ClickHouseValue
    
    Updates value.
    
    Parameters:
    
    value - value to update
    
    Returns:
    
    this object
  - update
```
public ClickHouseTupleValue update(long[] value)
```
    Description copied from interface: ClickHouseValue
    
    Updates value.
    
    Parameters:
    
    value - value to update
    
    Returns:
    
    this object
  - update
```
public ClickHouseTupleValue update(float value)
```
    Description copied from interface: ClickHouseValue
    
    Updates value.
    
    Parameters:
    
    value - value to update
    
    Returns:
    
    this object
  - update
```
public ClickHouseTupleValue update(float[] value)
```
    Description copied from interface: ClickHouseValue
    
    Updates value.
    
    Parameters:
    
    value - value to update
    
    Returns:
    
    this object
  - update
```
public ClickHouseTupleValue update(double value)
```
    Description copied from interface: ClickHouseValue
    
    Updates value.
    
    Parameters:
    
    value - value to update
    
    Returns:
    
    this object
  - update
```
public ClickHouseTupleValue update(double[] value)
```
    Description copied from interface: ClickHouseValue
    
    Updates value.
    
    Parameters:
    
    value - value to update
    
    Returns:
    
    this object
  - update
```
public ClickHouseTupleValue update(BigInteger value)
```
    Description copied from interface: ClickHouseValue
    
    Updates value.
    
    Parameters:
    
    value - value to update
    
    Returns:
    
    this object
  - update
```
public ClickHouseTupleValue update(BigDecimal value)
```
    Description copied from interface: ClickHouseValue
    
    Updates value.
    
    Parameters:
    
    value - value to update
    
    Returns:
    
    this object
  - update
```
public ClickHouseTupleValue update(Enum<?> value)
```
    Description copied from interface: ClickHouseValue
    
    Updates value.
    
    Parameters:
    
    value - value to update
    
    Returns:
    
    this object
  - update
```
public ClickHouseTupleValue update(Inet4Address value)
```
    Description copied from interface: ClickHouseValue
    
    Updates value.
    
    Parameters:
    
    value - value to update
    
    Returns:
    
    this object
  - update
```
public ClickHouseTupleValue update(Inet6Address value)
```
    Description copied from interface: ClickHouseValue
    
    Updates value.
    
    Parameters:
    
    value - value to update
    
    Returns:
    
    this object
  - update
```
public ClickHouseTupleValue update(LocalDate value)
```
    Description copied from interface: ClickHouseValue
    
    Updates value.
    
    Parameters:
    
    value - value to update
    
    Returns:
    
    this object
  - update
```
public ClickHouseTupleValue update(LocalTime value)
```
    Description copied from interface: ClickHouseValue
    
    Updates value.
    
    Parameters:
    
    value - value to update
    
    Returns:
    
    this object
  - update
```
public ClickHouseTupleValue update(LocalDateTime value)
```
    Description copied from interface: ClickHouseValue
    
    Updates value.
    
    Parameters:
    
    value - value to update
    
    Returns:
    
    this object
  - update
```
public ClickHouseTupleValue update(Collection<?> value)
```
    Description copied from interface: ClickHouseValue
    
    Updates value.
    
    Parameters:
    
    value - value to update
    
    Returns:
    
    this object
  - update
```
public ClickHouseTupleValue update(Enumeration<?> value)
```
    Description copied from interface: ClickHouseValue
    
    Updates value.
    
    Parameters:
    
    value - value to update
    
    Returns:
    
    this object
  - update
```
public ClickHouseTupleValue update(Map<?,?> value)
```
    Description copied from interface: ClickHouseValue
    
    Updates value.
    
    Parameters:
    
    value - value to update
    
    Returns:
    
    this object
  - update
```
public ClickHouseTupleValue update(String value)
```
    Description copied from interface: ClickHouseValue
    
    Updates value.
    
    Parameters:
    
    value - value to update
    
    Returns:
    
    this object
  - update
```
public ClickHouseTupleValue update(UUID value)
```
    Description copied from interface: ClickHouseValue
    
    Updates value.
    
    Parameters:
    
    value - value to update
    
    Returns:
    
    this object
  - update
```
public ClickHouseTupleValue update(ClickHouseValue value)
```
    Description copied from interface: ClickHouseValue
    
    Updates value.
    
    Parameters:
    
    value - value to update
    
    Returns:
    
    this object
  - update
```
public ClickHouseTupleValue update(Object[] value)
```
    Description copied from interface: ClickHouseValue
    
    Updates value.
    
    Parameters:
    
    value - value to update
    
    Returns:
    
    this object
  - update
```
public ClickHouseTupleValue update(Object value)
```
    Description copied from interface: ClickHouseValue
    
    Updates value. This method tries to identify type of value and then use corresponding update method to proceed. Unknown value will be passed to ClickHouseValue.updateUnknown(Object).
    
    Specified by:
    
    update in interface ClickHouseValue
    
    Overrides:
    
    update in class ClickHouseObjectValue<List<Object>>
    
    Parameters:
    
    value - value to update, could be null
    
    Returns:
    
    this object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class ClickHouseObjectValue<List<Object>>
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class ClickHouseObjectValue<List<Object>>

Class ClickHouseTupleValue

Constructor Summary

Method Summary

Methods inherited from class com.clickhouse.client.data.ClickHouseObjectValue

Methods inherited from class java.lang.Object

Methods inherited from interface com.clickhouse.client.ClickHouseValue

Constructor Detail

ClickHouseTupleValue

Method Detail

of

of

getSingleValue

copy

asArray

asArray

asMap

asMap

asString

asTuple

isNullOrEmpty

resetToNullOrEmpty

toSqlExpression

update

update

update

update

update

update

update

update

update

update

update

update

update

update

update

update

update

update

update

update

update

update

update

update

update

update

update

update

update

update

equals

hashCode