io.debezium.time

Class ZonedTimestamp

java.lang.Object

io.debezium.time.ZonedTimestamp

public class ZonedTimestamp
extends Object

A utility for converting various Java time representations into the STRING representation of the time and date in a particular time zone, and for defining a Kafka Connect Schema for zoned timestamp values.

The ISO date-time format includes the date, time (including fractional parts), and offset from UTC, such as '2011-12-03T10:15:30+01:00'.

Author:

Randall Hauch

See Also:

Timestamp, MicroTimestamp, NanoTimestamp, ZonedTime

Field Summary

Fields

Modifier and Type	Field and Description
static DateTimeFormatter	FORMATTER The ISO date-time format includes the date, time (including fractional parts), and offset from UTC, such as '2011-12-03T10:15:30.030431+01:00'.
static String	SCHEMA_NAME

Constructor Summary

Constructors

Modifier	Constructor and Description
private	ZonedTimestamp()

Method Summary

Modifier and Type	Method and Description
static org.apache.kafka.connect.data.SchemaBuilder	builder() Returns a SchemaBuilder for a ZonedTimestamp.
static org.apache.kafka.connect.data.Schema	schema() Returns a Schema for a ZonedTimestamp but with all other default Schema settings.
static String	toIsoString(Date timestamp, ZoneId zoneId, TemporalAdjuster adjuster) Get the ISO 8601 formatted representation of the given Date or one of its JDBC subclasses, using the supplied timezone information.
static String	toIsoString(Date date, ZoneId zoneId, TemporalAdjuster adjuster) Get the ISO 8601 formatted representation of the given Date, which contains a date but no time or timezone information.
static String	toIsoString(Object value, ZoneId defaultZone, TemporalAdjuster adjuster) Get the ISO 8601 formatted representation of the given LocalDateTime, LocalDate, LocalTime, Date, Date, Time, Timestamp, OffsetTime, or OffsetDateTime, ignoring any date portions of the supplied value.
static String	toIsoString(OffsetDateTime timestamp, TemporalAdjuster adjuster) Get the ISO 8601 formatted representation of the given OffsetDateTime.
static String	toIsoString(OffsetTime timestamp, TemporalAdjuster adjuster) Get the ISO 8601 formatted representation of the given OffsetTime.
static String	toIsoString(Timestamp timestamp, ZoneId zoneId, TemporalAdjuster adjuster) Get the ISO 8601 formatted representation of the given Timestamp, which contains a date and time but has no timezone information.
static String	toIsoString(Time time, ZoneId zoneId, TemporalAdjuster adjuster) Get the ISO 8601 formatted representation of the given Time, which contains time but no date or timezone information.
static String	toIsoString(ZonedDateTime timestamp, TemporalAdjuster adjuster) Get the ISO 8601 formatted representation of the given ZonedDateTime.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

FORMATTER

public static final DateTimeFormatter FORMATTER

The ISO date-time format includes the date, time (including fractional parts), and offset from UTC, such as '2011-12-03T10:15:30.030431+01:00'.

SCHEMA_NAME

public static final String SCHEMA_NAME

See Also:

Constant Field Values

Constructor Detail

ZonedTimestamp

private ZonedTimestamp()

Method Detail

builder

public static org.apache.kafka.connect.data.SchemaBuilder builder()

Returns a SchemaBuilder for a ZonedTimestamp. You can use the resulting SchemaBuilder to set additional schema settings such as required/optional, default value, and documentation.

Returns:

the schema builder

schema

public static org.apache.kafka.connect.data.Schema schema()

Returns a Schema for a ZonedTimestamp but with all other default Schema settings.

Returns:

the schema

See Also:

builder()

toIsoString

public static String toIsoString(Object value,
                                 ZoneId defaultZone,
                                 TemporalAdjuster adjuster)

Get the ISO 8601 formatted representation of the given LocalDateTime, LocalDate, LocalTime, Date, Date, Time, Timestamp, OffsetTime, or OffsetDateTime, ignoring any date portions of the supplied value.

Parameters:

value - the local or SQL date, time, or timestamp value; may not be null

defaultZone - the time zone that should be used by default if the value does not have timezone information; may not be null

adjuster - the optional component that adjusts the local date value before obtaining the epoch day; may be null if no adjustment is necessary

Returns:

the microseconds past midnight

Throws:

IllegalArgumentException - if the value is not an instance of the acceptable types

toIsoString

public static String toIsoString(OffsetDateTime timestamp,
                                 TemporalAdjuster adjuster)

Get the ISO 8601 formatted representation of the given OffsetDateTime.

Parameters:

timestamp - the timestamp value

adjuster - the optional component that adjusts the local date value before obtaining the epoch day; may be null if no adjustment is necessary

Returns:

the ISO 8601 formatted string

toIsoString

public static String toIsoString(ZonedDateTime timestamp,
                                 TemporalAdjuster adjuster)

Get the ISO 8601 formatted representation of the given ZonedDateTime.

Parameters:

timestamp - the timestamp value

adjuster - the optional component that adjusts the local date value before obtaining the epoch day; may be null if no adjustment is necessary

Returns:

the ISO 8601 formatted string

toIsoString

public static String toIsoString(OffsetTime timestamp,
                                 TemporalAdjuster adjuster)

Get the ISO 8601 formatted representation of the given OffsetTime.

Parameters:

timestamp - the timestamp value

adjuster - the optional component that adjusts the local date value before obtaining the epoch day; may be null if no adjustment is necessary

Returns:

the ISO 8601 formatted string

toIsoString

public static String toIsoString(Date timestamp,
                                 ZoneId zoneId,
                                 TemporalAdjuster adjuster)

Get the ISO 8601 formatted representation of the given Date or one of its JDBC subclasses, using the supplied timezone information.

Parameters:

timestamp - the timestamp value

zoneId - the timezone identifier or offset where the timestamp is defined

adjuster - the optional component that adjusts the local date value before obtaining the epoch day; may be null if no adjustment is necessary

Returns:

the ISO 8601 formatted string

toIsoString

public static String toIsoString(Timestamp timestamp,
                                 ZoneId zoneId,
                                 TemporalAdjuster adjuster)

Get the ISO 8601 formatted representation of the given Timestamp, which contains a date and time but has no timezone information.

Parameters:

timestamp - the JDBC timestamp value

zoneId - the timezone identifier or offset where the timestamp is defined

adjuster - the optional component that adjusts the local date value before obtaining the epoch day; may be null if no adjustment is necessary

Returns:

the ISO 8601 formatted string

toIsoString

public static String toIsoString(Date date,
                                 ZoneId zoneId,
                                 TemporalAdjuster adjuster)

Get the ISO 8601 formatted representation of the given Date, which contains a date but no time or timezone information.

Parameters:

date - the date value

zoneId - the timezone identifier or offset where the date is defined

adjuster - the optional component that adjusts the local date value before obtaining the epoch day; may be null if no adjustment is necessary

Returns:

the ISO 8601 formatted string

toIsoString

public static String toIsoString(Time time,
                                 ZoneId zoneId,
                                 TemporalAdjuster adjuster)

Get the ISO 8601 formatted representation of the given Time, which contains time but no date or timezone information.

Parameters:

time - the JDBC time value

zoneId - the timezone identifier or offset where the time is defined

adjuster - the optional component that adjusts the local date value before obtaining the epoch day; may be null if no adjustment is necessary

Returns:

the ISO 8601 formatted string