java.lang.Object
- com.clickhouse.client.data.ClickHouseEnumValue

All Implemented Interfaces:

ClickHouseValue, Serializable
```
public class ClickHouseEnumValue
extends Object
implements ClickHouseValue
```
Wraper class of enum.

See Also:

Serialized Form

Constructor Summary

Constructors
Modifier Constructor Description

protected ClickHouseEnumValue(ClickHouseEnum type, boolean isNull, int value)

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`BigDecimal`	`asBigDecimal(int scale)`	Gets value as `BigDecimal`.
`BigInteger`	`asBigInteger()`	Gets value as `BigInteger`.
`byte`	`asByte()`	Gets value as byte.
`double`	`asDouble()`	Gets value as double.
`float`	`asFloat()`	Gets value as float.
`int`	`asInteger()`	Gets value as integer.
`long`	`asLong()`	Gets value as long.
`Object`	`asObject()`	Gets value as an object.
`short`	`asShort()`	Gets value as short.
`String`	`asString(int length, Charset charset)`	Gets value as fixed length(in bytes) string.
`ClickHouseEnumValue`	`copy(boolean deep)`	Gets a copy of this value object.
`boolean`	`equals(Object obj)`
`int`	`getValue()`	Gets value.
`int`	`hashCode()`
`boolean`	`isNullOrEmpty()`	Checks if the value is null, or empty for non-null types like Array, Tuple and Map.
`static ClickHouseEnumValue`	`of(ClickHouseEnum type, int value)`	Wrap the given value.
`static ClickHouseEnumValue`	`of(ClickHouseEnum type, Number value)`	Wrap the given value.
`static ClickHouseEnumValue`	`of(ClickHouseValue ref, ClickHouseEnum type, int value)`	Update value of the given object or create a new instance if `ref` is null.
`static ClickHouseEnumValue`	`of(ClickHouseValue ref, Enum<?> value)`	Update value of the given object or create a new instance if `ref` is null.
`static ClickHouseEnumValue`	`of(Enum<?> value)`	Wrap the given value.
`static ClickHouseEnumValue`	`ofNull(ClickHouseEnum type)`	Create a new instance representing null value.
`static ClickHouseEnumValue`	`ofNull(ClickHouseValue ref, ClickHouseEnum type)`	Update given value to null or create a new instance if `ref` is null.
`static ClickHouseEnumValue`	`ofNull(ClickHouseValue ref, Class<? extends Enum> clazz)`	Update given value to null or create a new instance if `ref` is null.
`static ClickHouseEnumValue`	`ofNull(Class<? extends Enum> clazz)`	Create a new instance representing null value.
`ClickHouseEnumValue`	`resetToNullOrEmpty()`	Resets value to null, or empty when null is not supported(e.g.
`protected ClickHouseEnumValue`	`set(boolean isNull, int value)`
`String`	`toSqlExpression()`	Converts the value to escaped SQL expression.
`String`	`toString()`
`ClickHouseEnumValue`	`update(byte value)`	Updates value.
`ClickHouseEnumValue`	`update(char value)`	Updates value.
`ClickHouseEnumValue`	`update(double value)`	Updates value.
`ClickHouseEnumValue`	`update(float value)`	Updates value.
`ClickHouseEnumValue`	`update(int value)`	Updates value.
`ClickHouseEnumValue`	`update(long value)`	Updates value.
`ClickHouseEnumValue`	`update(short value)`	Updates value.
`ClickHouseEnumValue`	`update(ClickHouseValue value)`	Updates value.
`ClickHouseEnumValue`	`update(Enum<?> value)`	Updates value.
`ClickHouseEnumValue`	`update(Object value)`	Updates value.
`ClickHouseEnumValue`	`update(String value)`	Updates value.
`ClickHouseEnumValue`	`update(BigDecimal value)`	Updates value.
`ClickHouseEnumValue`	`update(BigInteger value)`	Updates value.

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

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

- Constructor Detail
  - ClickHouseEnumValue
```
protected ClickHouseEnumValue(ClickHouseEnum type,
                              boolean isNull,
                              int value)
```
- Method Detail
  - ofNull
```
public static ClickHouseEnumValue ofNull(Class<? extends Enum> clazz)
```
    Create a new instance representing null value.
    
    Parameters:
    
    clazz - enum class
    
    Returns:
    
    new instance representing null value
  - ofNull
```
public static ClickHouseEnumValue ofNull(ClickHouseEnum type)
```
    Create a new instance representing null value.
    
    Parameters:
    
    type - enum type, null is same as ClickHouseEnum.EMPTY
    
    Returns:
    
    new instance representing null value
  - ofNull
```
public static ClickHouseEnumValue ofNull(ClickHouseValue ref,
                                         Class<? extends Enum> clazz)
```
    Update given value to null or create a new instance if ref is null.
    
    Parameters:
    
    ref - object to update, could be null
    
    clazz - enum class
    
    Returns:
    
    same object as ref or a new instance if it's null
  - ofNull
```
public static ClickHouseEnumValue ofNull(ClickHouseValue ref,
                                         ClickHouseEnum type)
```
    Update given value to null or create a new instance if ref is null.
    
    Parameters:
    
    ref - object to update, could be null
    
    type - enum type, null is same as ClickHouseEnum.EMPTY
    
    Returns:
    
    same object as ref or a new instance if it's null
  - of
```
public static ClickHouseEnumValue of(Enum<?> value)
```
    Wrap the given value.
    
    Parameters:
    
    value - value
    
    Returns:
    
    object representing the value
  - of
```
public static ClickHouseEnumValue of(ClickHouseEnum type,
                                     int value)
```
    Wrap the given value.
    
    Parameters:
    
    value - value
    
    type - enum type
    
    Returns:
    
    object representing the value
  - of
```
public static ClickHouseEnumValue of(ClickHouseEnum type,
                                     Number value)
```
    Wrap the given value.
    
    Parameters:
    
    value - value
    
    type - enum type
    
    Returns:
    
    object representing the value
  - of
```
public static ClickHouseEnumValue of(ClickHouseValue ref,
                                     Enum<?> 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
  - of
```
public static ClickHouseEnumValue of(ClickHouseValue ref,
                                     ClickHouseEnum type,
                                     int value)
```
    Update value of the given object or create a new instance if ref is null.
    
    Parameters:
    
    ref - object to update, could be null
    
    type - enum type, null is same as ClickHouseEnum.EMPTY
    
    value - value
    
    Returns:
    
    same object as ref or a new instance if it's null
  - set
```
protected ClickHouseEnumValue set(boolean isNull,
                                  int value)
```
  - getValue
```
public int getValue()
```
    Gets value.
    
    Returns:
    
    value
  - copy
```
public ClickHouseEnumValue copy(boolean deep)
```
    Description copied from interface: ClickHouseValue
    
    Gets a copy of this value object.
    
    Specified by:
    
    copy in interface ClickHouseValue
    
    Parameters:
    
    deep - true to create a deep copy; false for a shallow copy
    
    Returns:
    
    copy of this value object
  - 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
    
    Returns:
    
    true if the value is null or empty; false otherwise
  - asByte
```
public byte asByte()
```
    Description copied from interface: ClickHouseValue
    
    Gets value as byte.
    
    Specified by:
    
    asByte in interface ClickHouseValue
    
    Returns:
    
    byte value
  - asShort
```
public short asShort()
```
    Description copied from interface: ClickHouseValue
    
    Gets value as short.
    
    Specified by:
    
    asShort in interface ClickHouseValue
    
    Returns:
    
    short value
  - asInteger
```
public int asInteger()
```
    Description copied from interface: ClickHouseValue
    
    Gets value as integer.
    
    Specified by:
    
    asInteger in interface ClickHouseValue
    
    Returns:
    
    integer value
  - asLong
```
public long asLong()
```
    Description copied from interface: ClickHouseValue
    
    Gets value as long.
    
    Specified by:
    
    asLong in interface ClickHouseValue
    
    Returns:
    
    long value
  - asBigInteger
```
public BigInteger asBigInteger()
```
    Description copied from interface: ClickHouseValue
    
    Gets value as BigInteger.
    
    Specified by:
    
    asBigInteger in interface ClickHouseValue
    
    Returns:
    
    big integer, could be null
  - asFloat
```
public float asFloat()
```
    Description copied from interface: ClickHouseValue
    
    Gets value as float.
    
    Specified by:
    
    asFloat in interface ClickHouseValue
    
    Returns:
    
    float value
  - asDouble
```
public double asDouble()
```
    Description copied from interface: ClickHouseValue
    
    Gets value as double.
    
    Specified by:
    
    asDouble in interface ClickHouseValue
    
    Returns:
    
    double value
  - asBigDecimal
```
public BigDecimal asBigDecimal(int scale)
```
    Description copied from interface: ClickHouseValue
    
    Gets value as BigDecimal.
    
    Specified by:
    
    asBigDecimal in interface ClickHouseValue
    
    Parameters:
    
    scale - scale of the decimal
    
    Returns:
    
    big decimal, could be null
  - asObject
```
public Object asObject()
```
    Description copied from interface: ClickHouseValue
    
    Gets value as an object.
    
    Specified by:
    
    asObject in interface ClickHouseValue
    
    Returns:
    
    an object representing the value, could be null
  - 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
    
    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
  - resetToNullOrEmpty
```
public ClickHouseEnumValue 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
    
    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
    
    Returns:
    
    escaped SQL expression
  - update
```
public ClickHouseEnumValue update(char value)
```
    Description copied from interface: ClickHouseValue
    
    Updates value.
    
    Specified by:
    
    update in interface ClickHouseValue
    
    Parameters:
    
    value - value to update
    
    Returns:
    
    this object
  - update
```
public ClickHouseEnumValue update(byte value)
```
    Description copied from interface: ClickHouseValue
    
    Updates value.
    
    Specified by:
    
    update in interface ClickHouseValue
    
    Parameters:
    
    value - value to update
    
    Returns:
    
    this object
  - update
```
public ClickHouseEnumValue update(short value)
```
    Description copied from interface: ClickHouseValue
    
    Updates value.
    
    Specified by:
    
    update in interface ClickHouseValue
    
    Parameters:
    
    value - value to update
    
    Returns:
    
    this object
  - update
```
public ClickHouseEnumValue update(int value)
```
    Description copied from interface: ClickHouseValue
    
    Updates value.
    
    Specified by:
    
    update in interface ClickHouseValue
    
    Parameters:
    
    value - value to update
    
    Returns:
    
    this object
  - update
```
public ClickHouseEnumValue update(long value)
```
    Description copied from interface: ClickHouseValue
    
    Updates value.
    
    Specified by:
    
    update in interface ClickHouseValue
    
    Parameters:
    
    value - value to update
    
    Returns:
    
    this object
  - update
```
public ClickHouseEnumValue update(float value)
```
    Description copied from interface: ClickHouseValue
    
    Updates value.
    
    Specified by:
    
    update in interface ClickHouseValue
    
    Parameters:
    
    value - value to update
    
    Returns:
    
    this object
  - update
```
public ClickHouseEnumValue update(double value)
```
    Description copied from interface: ClickHouseValue
    
    Updates value.
    
    Specified by:
    
    update in interface ClickHouseValue
    
    Parameters:
    
    value - value to update
    
    Returns:
    
    this object
  - update
```
public ClickHouseEnumValue update(BigInteger value)
```
    Description copied from interface: ClickHouseValue
    
    Updates value.
    
    Specified by:
    
    update in interface ClickHouseValue
    
    Parameters:
    
    value - value to update
    
    Returns:
    
    this object
  - update
```
public ClickHouseEnumValue update(BigDecimal value)
```
    Description copied from interface: ClickHouseValue
    
    Updates value.
    
    Specified by:
    
    update in interface ClickHouseValue
    
    Parameters:
    
    value - value to update
    
    Returns:
    
    this object
  - update
```
public ClickHouseEnumValue update(Enum<?> value)
```
    Description copied from interface: ClickHouseValue
    
    Updates value.
    
    Specified by:
    
    update in interface ClickHouseValue
    
    Parameters:
    
    value - value to update
    
    Returns:
    
    this object
  - update
```
public ClickHouseEnumValue update(String value)
```
    Description copied from interface: ClickHouseValue
    
    Updates value.
    
    Specified by:
    
    update in interface ClickHouseValue
    
    Parameters:
    
    value - value to update
    
    Returns:
    
    this object
  - update
```
public ClickHouseEnumValue update(ClickHouseValue value)
```
    Description copied from interface: ClickHouseValue
    
    Updates value.
    
    Specified by:
    
    update in interface ClickHouseValue
    
    Parameters:
    
    value - value to update
    
    Returns:
    
    this object
  - update
```
public ClickHouseEnumValue 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
    
    Parameters:
    
    value - value to update, could be null
    
    Returns:
    
    this object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class ClickHouseEnumValue

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface com.clickhouse.client.ClickHouseValue

Constructor Detail

ClickHouseEnumValue

Method Detail

ofNull

ofNull

ofNull

ofNull

of

of

of

of

of

set

getValue

copy

isNullOrEmpty

asByte

asShort

asInteger

asLong

asBigInteger

asFloat

asDouble

asBigDecimal

asObject

asString

resetToNullOrEmpty

toSqlExpression

update

update

update

update

update

update

update

update

update

update

update

update

update

equals

hashCode

toString