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.

See Also:

for the interface this abstract class implements.

Field Summary

Fields

Modifier and Type	Field and Description
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(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) Format the timestamp value and append it to the supplied Appendable.
void	append(net.openhft.chronicle.bytes.Bytes<?> bytes, long value) Convenience overload for appending to a Bytes instance.
void	append(StringBuilder text, long value) Convenience overload that delegates to append(Appendable, long).
protected abstract void	appendFraction(DateTimeFormatterBuilder builder) Append the fraction-of-second pattern to the formatter builder.
long	parse(CharSequence text) Parses the provided text and converts it into a long timestamp.
protected abstract long	parseFormattedDate(ZonedDateTime value) Interpret a formatted date that has already been normalised to UTC.
protected abstract long	parseTimestamp(long value, CharSequence text) Interpret a long value that has been parsed directly from the input text.

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, lengthCheck, maxParseLength, maxParseLength, parse

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

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.

Parameters:

zoneId - The string representation of the ZoneId (for example "UTC" or "Europe/London") used when a parsed date does not contain its own offset. All internal long values are treated as UTC based.

timeUnit - The TimeUnit defining the precision of the long timestamp values handled by this converter.

Method Detail

parse

public long parse(CharSequence text)

Parses the provided text and converts it into a long timestamp. The input may be an ISO-8601 date, a date-time with or without a zone, or a plain numeric timestamp. When no zone is present, the converter's ZoneId is assumed.

Specified by:

parse in interface LongConverter

Parameters:

text - The character sequence representing a date, timestamp or numeric value to be parsed into a UTC long in this converter's TimeUnit.

Returns:

a long value representing the parsed timestamp

parseFormattedDate

protected abstract long parseFormattedDate(ZonedDateTime value)

Interpret a formatted date that has already been normalised to UTC.

Parameters:

value - The ZonedDateTime parsed from the text and adjusted to UTC. The implementation extracts the epoch based long in this converter's TimeUnit.

Returns:

The value as a long timestamp

parseTimestamp

protected abstract long parseTimestamp(long value,
                                       CharSequence text)

Interpret a long value that has been parsed directly from the input text.

Parameters:

value - The numeric value extracted from text before any unit conversion is applied.

text - The original character sequence. Implementations may use it for logging or context when the conversion is ambiguous.

Returns:

The value as a long timestamp

appendFraction

protected abstract void appendFraction(DateTimeFormatterBuilder builder)

Append the fraction-of-second pattern to the formatter builder.

Parameters:

builder - The DateTimeFormatterBuilder after the basic date and time pattern has been added.

append

public void append(Appendable text,
                   long value)

Format the timestamp value and append it to the supplied Appendable.

Parameters:

text - The destination for the formatted date-time, such as a StringBuilder or Bytes instance.

value - The UTC timestamp in this converter's TimeUnit.

append

public void append(StringBuilder text,
                   long value)

Convenience overload that delegates to append(Appendable, long).

Specified by:

append in interface LongConverter

Parameters:

text - The StringBuilder to receive the formatted value.

value - The UTC timestamp in this converter's TimeUnit.

append

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

Convenience overload for appending to a Bytes instance.

Specified by:

append in interface LongConverter

Parameters:

bytes - The Bytes sink for the formatted value.

value - The UTC timestamp in this converter's TimeUnit.