Package com.clickhouse.data.value

Class ClickHouseInstantValue

java.lang.Object

com.clickhouse.data.value.ClickHouseObjectValue<Instant>

com.clickhouse.data.value.ClickHouseInstantValue

All Implemented Interfaces:

ClickHouseValue, Serializable

public class ClickHouseInstantValue
extends ClickHouseObjectValue<Instant>

Wrapper class of Instant.

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final Instant	DEFAULT	Default instant.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	ClickHouseInstantValue(Instant value, int scale, TimeZone tz)

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.
LocalDate	asDate()	Gets value as LocalDate.
LocalDateTime	asDateTime(int scale)	Gets value as LocalDateTime.
double	asDouble()	Gets value as double.
float	asFloat()	Gets value as float.
Instant	asInstant(int scale)	Gets value as Instant.
int	asInteger()	Gets value as integer.
long	asLong()	Gets value as long.
Object	asObject()	Gets value as an object.
OffsetDateTime	asOffsetDateTime(int scale)	Gets value as OffsetDateTime.
short	asShort()	Gets value as short.
String	asString()	Gets value as unbounded string, using default charset(usually UTF-8).
ZonedDateTime	asZonedDateTime(int scale)	Gets value as ZonedDateTime.
ClickHouseInstantValue	copy(boolean deep)	Gets a copy of this value object.
int	getScale()
static ClickHouseInstantValue	of(ClickHouseValue ref, String value, int scale, TimeZone tz)	Update value of the given object or create a new instance if ref is null.
static ClickHouseInstantValue	of(ClickHouseValue ref, Instant value, int scale, TimeZone tz)	Update value of the given object or create a new instance if ref is null.
static ClickHouseInstantValue	of(String value, int scale, TimeZone tz)	Wrap the given getValue().
static ClickHouseInstantValue	of(Instant value, int scale, TimeZone tz)	Wrap the given getValue().
static ClickHouseInstantValue	ofNull(int scale, TimeZone tz)	Create a new instance representing null getValue().
static ClickHouseInstantValue	ofNull(ClickHouseValue ref, int scale, TimeZone tz)	Update given value to null or create a new instance if ref is null.
ClickHouseInstantValue	resetToDefault()	Resets to default value of corresponding data type.
String	toSqlExpression()	Converts the value to escaped SQL expression.
ClickHouseInstantValue	update(byte value)	Updates value.
ClickHouseInstantValue	update(double value)	Updates value.
ClickHouseInstantValue	update(float value)	Updates value.
ClickHouseInstantValue	update(int value)	Updates value.
ClickHouseInstantValue	update(long value)	Updates value.
ClickHouseInstantValue	update(short value)	Updates value.
ClickHouseInstantValue	update(ClickHouseValue value)	Updates value.
ClickHouseInstantValue	update(Enum<?> value)	Updates value.
ClickHouseInstantValue	update(Object value)	Updates value.
ClickHouseInstantValue	update(String value)	Updates value.
ClickHouseInstantValue	update(BigDecimal value)	Updates value.
ClickHouseInstantValue	update(BigInteger value)	Updates value.
ClickHouseInstantValue	update(Instant value)	Updates value.
ClickHouseInstantValue	update(LocalDate value)	Updates value.
ClickHouseInstantValue	update(LocalDateTime value)	Updates value.
ClickHouseInstantValue	update(LocalTime value)	Updates value.
ClickHouseInstantValue	update(OffsetDateTime value)	Updates value.
ClickHouseInstantValue	update(ZonedDateTime value)	Updates value.

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

equals, getValue, hashCode, isNullOrEmpty, resetToNullOrEmpty, set, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.clickhouse.data.ClickHouseValue

asArray, asArray, asBigDecimal, asBinary, asBinary, asBinary, asBinary, asBoolean, asByteStream, asCharacter, asCharacterStream, asDateTime, asEnum, asInet4Address, asInet6Address, asInstant, asMap, asMap, asObject, asOffsetDateTime, asRawObject, asTime, asTime, asTuple, asUuid, asZonedDateTime, copy, isInfinity, isNaN, isNullable, newUnsupportedException, update, update, update, update, update, update, update, update, update, update, update, update, update, update, update, update, update, update, update, updateUnknown

Field Details

DEFAULT

public static final Instant DEFAULT

Default instant.

Constructor Details

ClickHouseInstantValue

protected ClickHouseInstantValue(Instant value,
 int scale,
 TimeZone tz)

Method Details

ofNull

public static ClickHouseInstantValue ofNull(int scale,
 TimeZone tz)

Create a new instance representing null getValue().

Parameters:

scale - scale

tz - time zone, null is treated as UTC

Returns:

new instance representing null value

ofNull

public static ClickHouseInstantValue ofNull(ClickHouseValue ref,
 int scale,
 TimeZone tz)

Update given value to null or create a new instance if ref is null.

Parameters:

ref - object to update, could be null

scale - scale, only used when ref is null

tz - time zone, null is treated as UTC

Returns:

same object as ref or a new instance if it's null

of

public static ClickHouseInstantValue of(Instant value,
 int scale,
 TimeZone tz)

Wrap the given getValue().

Parameters:

value - value

scale - scale

tz - time zone, null is treated as UTC

Returns:

object representing the value

of

public static ClickHouseInstantValue of(String value,
 int scale,
 TimeZone tz)

Wrap the given getValue().

Parameters:

value - UTC date time in string

scale - scale

tz - time zone, null is treated as UTC

Returns:

object representing the value

of

public static ClickHouseInstantValue of(ClickHouseValue ref,
 Instant value,
 int scale,
 TimeZone tz)

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

scale - scale, only used when ref is null

tz - time zone, null is treated as UTC

Returns:

same object as ref or a new instance if it's null

of

public static ClickHouseInstantValue of(ClickHouseValue ref,
 String value,
 int scale,
 TimeZone tz)

Update value of the given object or create a new instance if ref is null.

Parameters:

ref - object to update, could be null

value - UTC date time in string

scale - scale

tz - time zone, null is treated as UTC

Returns:

same object as ref or a new instance if it's null

getScale

public int getScale()

copy

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

asByte

public byte asByte()

Description copied from interface: ClickHouseValue

Gets value as byte.

Specified by:

asByte in interface ClickHouseValue

Overrides:

asByte in class ClickHouseObjectValue<Instant>

Returns:

byte value

asShort

public short asShort()

Description copied from interface: ClickHouseValue

Gets value as short.

Specified by:

asShort in interface ClickHouseValue

Overrides:

asShort in class ClickHouseObjectValue<Instant>

Returns:

short value

asInteger

public int asInteger()

Description copied from interface: ClickHouseValue

Gets value as integer.

Specified by:

asInteger in interface ClickHouseValue

Overrides:

asInteger in class ClickHouseObjectValue<Instant>

Returns:

integer value

asLong

public long asLong()

Description copied from interface: ClickHouseValue

Gets value as long.

Specified by:

asLong in interface ClickHouseValue

Overrides:

asLong in class ClickHouseObjectValue<Instant>

Returns:

long value

asFloat

public float asFloat()

Description copied from interface: ClickHouseValue

Gets value as float.

Specified by:

asFloat in interface ClickHouseValue

Overrides:

asFloat in class ClickHouseObjectValue<Instant>

Returns:

float value

asDouble

public double asDouble()

Description copied from interface: ClickHouseValue

Gets value as double.

Specified by:

asDouble in interface ClickHouseValue

Overrides:

asDouble in class ClickHouseObjectValue<Instant>

Returns:

double value

asBigInteger

public BigInteger asBigInteger()

Description copied from interface: ClickHouseValue

Gets value as BigInteger.

Specified by:

asBigInteger in interface ClickHouseValue

Overrides:

asBigInteger in class ClickHouseObjectValue<Instant>

Returns:

big integer, could be null

asBigDecimal

public BigDecimal asBigDecimal(int scale)

Description copied from interface: ClickHouseValue

Gets value as BigDecimal.

Specified by:

asBigDecimal in interface ClickHouseValue

Overrides:

asBigDecimal in class ClickHouseObjectValue<Instant>

Parameters:

scale - scale of the decimal

Returns:

big decimal, could be null

asDate

public LocalDate asDate()

Description copied from interface: ClickHouseValue

Gets value as LocalDate.

Returns:

date, could be null

asDateTime

public LocalDateTime asDateTime(int scale)

Description copied from interface: ClickHouseValue

Gets value as LocalDateTime.

Parameters:

scale - scale of the date time, between 0 (second) and 9 (nano second)

Returns:

date time, could be null

asInstant

public Instant asInstant(int scale)

Description copied from interface: ClickHouseValue

Gets value as Instant.

Parameters:

scale - scale of the date time, between 0 (second) and 9 (nano second)

Returns:

instant, could be null

asOffsetDateTime

public OffsetDateTime asOffsetDateTime(int scale)

Description copied from interface: ClickHouseValue

Gets value as OffsetDateTime.

Parameters:

scale - scale of the date time, between 0 (second) and 9 (nano second)

Returns:

date time, could be null

asZonedDateTime

public ZonedDateTime asZonedDateTime(int scale)

Description copied from interface: ClickHouseValue

Gets value as ZonedDateTime.

Parameters:

scale - scale of the date time, between 0 (second) and 9 (nano second)

Returns:

date time, could be null

asObject

public Object asObject()

Description copied from interface: ClickHouseValue

Gets value as an object.

Specified by:

asObject in interface ClickHouseValue

Overrides:

asObject in class ClickHouseObjectValue<Instant>

Returns:

an object representing the value, could be null

asString

public String asString()

Description copied from interface: ClickHouseValue

Gets value as unbounded string, using default charset(usually UTF-8).

Specified by:

asString in interface ClickHouseValue

Overrides:

asString in class ClickHouseObjectValue<Instant>

Returns:

string value, could be null

resetToDefault

public ClickHouseInstantValue resetToDefault()

Description copied from interface: ClickHouseValue

Resets to default value of corresponding data type.

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<Instant>

Returns:

escaped SQL expression

update

public ClickHouseInstantValue update(byte value)

Description copied from interface: ClickHouseValue

Updates value.

Parameters:

value - value to update

Returns:

this object

update

public ClickHouseInstantValue update(short value)

Description copied from interface: ClickHouseValue

Updates value.

Parameters:

value - value to update

Returns:

this object

update

public ClickHouseInstantValue update(int value)

Description copied from interface: ClickHouseValue

Updates value.

Parameters:

value - value to update

Returns:

this object

update

public ClickHouseInstantValue update(long value)

Description copied from interface: ClickHouseValue

Updates value.

Parameters:

value - value to update

Returns:

this object

update

public ClickHouseInstantValue update(float value)

Description copied from interface: ClickHouseValue

Updates value.

Parameters:

value - value to update

Returns:

this object

update

public ClickHouseInstantValue update(double value)

Description copied from interface: ClickHouseValue

Updates value.

Parameters:

value - value to update

Returns:

this object

update

public ClickHouseInstantValue update(BigInteger value)

Description copied from interface: ClickHouseValue

Updates value.

Parameters:

value - value to update

Returns:

this object

update

public ClickHouseInstantValue update(BigDecimal value)

Description copied from interface: ClickHouseValue

Updates value.

Parameters:

value - value to update

Returns:

this object

update

public ClickHouseInstantValue update(Enum<?> value)

Description copied from interface: ClickHouseValue

Updates value.

Parameters:

value - value to update

Returns:

this object

update

public ClickHouseInstantValue update(LocalDate value)

Description copied from interface: ClickHouseValue

Updates value.

Parameters:

value - value to update

Returns:

this object

update

public ClickHouseInstantValue update(LocalTime value)

Description copied from interface: ClickHouseValue

Updates value.

Parameters:

value - value to update

Returns:

this object

update

public ClickHouseInstantValue update(LocalDateTime value)

Description copied from interface: ClickHouseValue

Updates value.

Parameters:

value - value to update

Returns:

this object

update

public ClickHouseInstantValue update(Instant value)

Description copied from interface: ClickHouseValue

Updates value.

Parameters:

value - value to update

Returns:

this object

update

public ClickHouseInstantValue update(OffsetDateTime value)

Description copied from interface: ClickHouseValue

Updates value.

Parameters:

value - value to update

Returns:

this object

update

public ClickHouseInstantValue update(ZonedDateTime value)

Description copied from interface: ClickHouseValue

Updates value.

Parameters:

value - value to update

Returns:

this object

update

public ClickHouseInstantValue update(String value)

Description copied from interface: ClickHouseValue

Updates value.

Parameters:

value - value to update

Returns:

this object

update

public ClickHouseInstantValue update(ClickHouseValue value)

Description copied from interface: ClickHouseValue

Updates value.

Parameters:

value - value to update

Returns:

this object

update

public ClickHouseInstantValue 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<Instant>

Parameters:

value - value to update, could be null

Returns:

this object