Module org.tquadrat.foundation.util

Package org.tquadrat.foundation.util.stringconverter

Class InstantStringConverter

java.lang.Object

org.tquadrat.foundation.util.stringconverter.TimeDateStringConverter<Instant>

org.tquadrat.foundation.util.stringconverter.InstantStringConverter

All Implemented Interfaces:

Serializable, StringConverter<Instant>

@ClassVersion(sourceVersion="$Id: InstantStringConverter.java 1130 2024-05-05 16:16:09Z tquadrat $")
@API(status=STABLE,
     since="0.0.6")
public class InstantStringConverter
extends TimeDateStringConverter<Instant>

The implementation of TimeDateStringConverter for Instant.

Author:

Thomas Thrien (thomas.thrien@tquadrat.org)

Version:

$Id: InstantStringConverter.java 1130 2024-05-05 16:16:09Z tquadrat $

Since:

0.0.6

See Also:

• Serialized Form

UML Diagram

⁠

UML Diagram for "org.tquadrat.foundation.util.stringconverter.InstantStringConverter"

⁠

Field Summary

Fields

Modifier and Type	Field	Description
static final InstantStringConverter	INSTANCE	An instance of this class.

Fields inherited from class org.tquadrat.foundation.util.stringconverter.TimeDateStringConverter

MSG_InvalidDateTimeFormat

Fields inherited from interface org.tquadrat.foundation.lang.StringConverter

METHOD_NAME_GetSubjectClass, METHOD_NAME_Provider

Constructor Summary

Constructors

Constructor	Description
InstantStringConverter()	Creates a new InstantStringConverter instance.
InstantStringConverter(DateTimeFormatter formatter)	Creates a new InstantStringConverter instance that uses the given formatter for the conversion back and forth.

Method Summary

Modifier and Type	Method	Description
protected final Instant	parseDateTime(CharSequence source, Optional<DateTimeFormatter> formatter)	Parses the given String to an instance of Temporal.
static final InstantStringConverter	provider()	This method is used by the ServiceLoader to obtain the instance for this StringConverter implementation.

Methods inherited from class org.tquadrat.foundation.util.stringconverter.TimeDateStringConverter

fromString, getSubjectClass, toString

Methods inherited from class java.lang.Object

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

Field Details

INSTANCE

public static final InstantStringConverter INSTANCE

An instance of this class.

Constructor Details

InstantStringConverter

public InstantStringConverter()

Creates a new InstantStringConverter instance.

InstantStringConverter

public InstantStringConverter(DateTimeFormatter formatter)

Creates a new InstantStringConverter instance that uses the given formatter for the conversion back and forth.

Note:

• The formatter may not drop any part of the instant, otherwise fromString() may fail. This means that the formatter is only allowed to re-order the temporal fields.

Parameters:

formatter - The formatter for the temporal accessor.

Method Details

parseDateTime

protected final Instant parseDateTime(CharSequence source,
 Optional<DateTimeFormatter> formatter)
                               throws DateTimeParseException

Parses the given String to an instance of Temporal. The caller ensures that source is not null, not the empty String and does not contain only whitespace.

Specified by:

parseDateTime in class TimeDateStringConverter<Instant>

Parameters:

source - The String to parse.

formatter - The formatter for parsing the String

Returns:

The time/date value.

Throws:

DateTimeParseException - The given value cannot be parsed to a Temporal.

provider

public static final InstantStringConverter provider()

This method is used by the ServiceLoader to obtain the instance for this StringConverter implementation.

Returns:

The instance for this StringConverter implementation.