net.openhft.chronicle.wire

Class AbstractTimestampLongConverter

java.lang.Object

net.openhft.chronicle.wire.AbstractTimestampLongConverter

All Implemented Interfaces:

LongConverter

Direct Known Subclasses:

MicroTimestampLongConverter, MilliTimestampLongConverter, NanoTimestampLongConverter

public abstract class AbstractTimestampLongConverter
extends Object
implements LongConverter

This abstract class serves as the base for LongConverters that handle timestamp values. The timezone can be set for the subclasses of this converter, and this will be applied to the timestamp values when they are output. When no timezone is specified, the system will default to the one specified by the `timestampLongConverters.zoneId` system property. If this system property is not set, the default will be UTC.

All long values that are handled by this converter are assumed to be timestamps in UTC.

Parsing of ISO dates, with or without timestamps, is supported. If an ISO date is read with no timezone, it is assumed to be in the converter's zone.

As of x.26, the property `timestampLongConverters.includeZoneSuffixWhenZoneIsUTC` will be deprecated and UTC dates will always be written with a 'Z' suffix.

See Also:

for the interface this abstract class implements.

Field Summary

Fields

Modifier and Type	Field and Description
static String	INCLUDE_ZONE_SUFFIX_WHEN_ZONE_IS_UTC_SYSTEM_PROPERTY System property to specify whether to include the 'Z' suffix for UTC zone timestamps.
static String	TIMESTAMP_LONG_CONVERTERS_ZONE_ID_SYSTEM_PROPERTY System property to specify the ZoneId for timestamp conversion.
static ZoneId	UTC Universal Time Coordinated (UTC) timezone

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractTimestampLongConverter(String zoneId, TimeUnit timeUnit) Constructs a new AbstractTimestampLongConverter with the specified zone ID and time unit.
protected	AbstractTimestampLongConverter(String zoneId, TimeUnit timeUnit, boolean includeZoneSuffixForUTC) Deprecated.
protected	AbstractTimestampLongConverter(TimeUnit timeUnit) Constructs a new AbstractTimestampLongConverter with the specified time unit.

Method Summary

Modifier and Type	Method and Description
void	append(Appendable text, long value)
void	append(net.openhft.chronicle.bytes.Bytes<?> bytes, long value) Appends the provided long value to the given Bytes.
void	append(StringBuilder text, long value) Appends the provided long value to the given StringBuilder.
protected abstract void	appendFraction(DateTimeFormatterBuilder builder) Appends the fraction of the second to the provided DateTimeFormatterBuilder.
long	parse(CharSequence text) Parses the provided text and converts it into a long timestamp.
protected abstract long	parseFormattedDate(ZonedDateTime value) Interpret formatted date
protected abstract long	parseTimestamp(long value, CharSequence text) Interpret long timestamp

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.openhft.chronicle.wire.LongConverter

addEncode, allSafeChars, asString, asText, asText, forSymbols, lengthCheck, maxParseLength, maxParseLength

Field Detail

UTC

public static final ZoneId UTC

Universal Time Coordinated (UTC) timezone

TIMESTAMP_LONG_CONVERTERS_ZONE_ID_SYSTEM_PROPERTY

public static final String TIMESTAMP_LONG_CONVERTERS_ZONE_ID_SYSTEM_PROPERTY

System property to specify the ZoneId for timestamp conversion.

See Also:

Constant Field Values

INCLUDE_ZONE_SUFFIX_WHEN_ZONE_IS_UTC_SYSTEM_PROPERTY

public static final String INCLUDE_ZONE_SUFFIX_WHEN_ZONE_IS_UTC_SYSTEM_PROPERTY

System property to specify whether to include the 'Z' suffix for UTC zone timestamps. To be deprecated in x.26 version.

See Also:

Constant Field Values

Constructor Detail

AbstractTimestampLongConverter

protected AbstractTimestampLongConverter(TimeUnit timeUnit)

Constructs a new AbstractTimestampLongConverter with the specified time unit. The zone ID is fetched from the system property. If the system property is not set, UTC is used.

Parameters:

timeUnit - the time unit for the conversion of long values

AbstractTimestampLongConverter

protected AbstractTimestampLongConverter(String zoneId,
                                         TimeUnit timeUnit)

Constructs a new AbstractTimestampLongConverter with the specified zone ID and time unit. The flag for including zone suffix for UTC is fetched from the system property.

Parameters:

zoneId - the zone ID to be used for the conversion of long values

timeUnit - the time unit for the conversion of long values

AbstractTimestampLongConverter

@Deprecated
protected AbstractTimestampLongConverter(String zoneId,
                                                     TimeUnit timeUnit,
                                                     boolean includeZoneSuffixForUTC)

Deprecated.

Constructs a new AbstractTimestampLongConverter with the specified zone ID, time unit and flag for including zone suffix for UTC. This constructor is set to be deprecated in x.26 version.

Parameters:

zoneId - the zone ID to be used for the conversion of long values

timeUnit - the time unit for the conversion of long values

includeZoneSuffixForUTC - the flag to indicate if 'Z' suffix should be included for UTC zone timestamps

Method Detail

parse

public long parse(CharSequence text)

Parses the provided text and converts it into a long timestamp. The text can be an ISO date or a timestamp. If the text includes a timezone, it's used for conversion; otherwise, the converter's timezone is used.

Specified by:

parse in interface LongConverter

Parameters:

text - the text to be parsed

Returns:

a long value representing the parsed timestamp

parseFormattedDate

protected abstract long parseFormattedDate(ZonedDateTime value)

Interpret formatted date

Parameters:

value - The parsed formatted date (in UTC zone)

Returns:

The value as a long timestamp

parseTimestamp

protected abstract long parseTimestamp(long value,
                                       CharSequence text)

Interpret long timestamp

Parameters:

value - The parsed timestamp

Returns:

The value as a long timestamp

appendFraction

protected abstract void appendFraction(DateTimeFormatterBuilder builder)

Appends the fraction of the second to the provided DateTimeFormatterBuilder.

Parameters:

builder - The builder after the initial date format has been added

append

public void append(Appendable text,
                   long value)

append

public void append(StringBuilder text,
                   long value)

Appends the provided long value to the given StringBuilder. This method delegates to append(Appendable, long).

Specified by:

append in interface LongConverter

Parameters:

text - the StringBuilder to append to

value - the long value to be appended

append

public void append(net.openhft.chronicle.bytes.Bytes<?> bytes,
                   long value)

Appends the provided long value to the given Bytes. This method delegates to append(Appendable, long).

Specified by:

append in interface LongConverter

Parameters:

bytes - the Bytes to append to

value - the long value to be appended