Package com.clickhouse.client.data

Class ClickHouseEmptyValue

java.lang.Object

com.clickhouse.client.data.ClickHouseEmptyValue

All Implemented Interfaces:

ClickHouseValue, Serializable

public final class ClickHouseEmptyValue
extends Object
implements ClickHouseValue

Wrapper class of Nothing.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static ClickHouseEmptyValue	INSTANCE	Singleton.

Method Summary

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.
ClickHouseValue	copy(boolean deep)	Gets a copy of this value object.
boolean	isNullOrEmpty()	Checks if the value is null, or empty for non-null types like Array, Tuple and Map.
ClickHouseValue	resetToNullOrEmpty()	Resets value to null, or empty when null is not supported(e.g.
String	toSqlExpression()	Converts the value to escaped SQL expression.
String	toString()
ClickHouseValue	update(byte value)	Updates value.
ClickHouseValue	update(double value)	Updates value.
ClickHouseValue	update(float value)	Updates value.
ClickHouseValue	update(int value)	Updates value.
ClickHouseValue	update(long value)	Updates value.
ClickHouseValue	update(short value)	Updates value.
ClickHouseValue	update(ClickHouseValue value)	Updates value.
ClickHouseValue	update(String value)	Updates value.
ClickHouseValue	update(BigDecimal value)	Updates value.
ClickHouseValue	update(BigInteger value)	Updates value.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, 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, asMap, asMap, asObject, asOffsetDateTime, asOffsetDateTime, asString, 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, update, updateUnknown

Field Detail

INSTANCE

public static final ClickHouseEmptyValue INSTANCE

Singleton.

Method Detail

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

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

asByte

public byte asByte()

Description copied from interface: ClickHouseValue

Gets value as byte.

Specified by:

asByte in interface ClickHouseValue

Returns:

byte value

asDouble

public double asDouble()

Description copied from interface: ClickHouseValue

Gets value as double.

Specified by:

asDouble in interface ClickHouseValue

Returns:

double value

asFloat

public float asFloat()

Description copied from interface: ClickHouseValue

Gets value as float.

Specified by:

asFloat in interface ClickHouseValue

Returns:

float 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

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

asShort

public short asShort()

Description copied from interface: ClickHouseValue

Gets value as short.

Specified by:

asShort in interface ClickHouseValue

Returns:

short value

copy

public ClickHouseValue 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

resetToNullOrEmpty

public ClickHouseValue 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 ClickHouseValue 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 ClickHouseValue 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 ClickHouseValue 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 ClickHouseValue 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 ClickHouseValue 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 ClickHouseValue 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 ClickHouseValue 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 ClickHouseValue 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 ClickHouseValue 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 ClickHouseValue update(ClickHouseValue value)

Description copied from interface: ClickHouseValue

Updates value.

Specified by:

update in interface ClickHouseValue

Parameters:

value - value to update

Returns:

this object

toString

public String toString()

Overrides:

toString in class Object