Module org.tquadrat.foundation.util

Package org.tquadrat.foundation.util.stringconverter

Class TimeDateStringConverter<T extends TemporalAccessor>

java.lang.Object

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

Type Parameters:

T - The type that is handled by this class.

All Implemented Interfaces:

Serializable, StringConverter<T>

Direct Known Subclasses:

InstantStringConverter, LocalDateStringConverter, LocalDateTimeStringConverter, LocalTimeStringConverter, MonthDayStringConverter, OffsetDateTimeStringConverter, OffsetTimeStringConverter, YearMonthStringConverter, YearStringConverter, ZonedDateTimeStringConverter

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

The abstract base class for implementations of StringConverter for types that extend TemporalAccessor.

The format for the date/time data can be modified by applying an instance of DateTimeFormatter to the constructor TimeDateStringConverter(Class,DateTimeFormatter) that is used for parsing Strings to object instances and for converting object instances to Strings.

Author:

Thomas Thrien (thomas.thrien@tquadrat.org)

Version:

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

Since:

0.0.6

See Also:

• DateTimeFormatter
• Serialized Form

UML Diagram

⁠

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

⁠

Field Summary

Fields

Modifier and Type	Field	Description
private final Optional<DateTimeFormatter>	m_Formatter	The formatter that is used to format the date/time data.
private final Class<T>	m_SubjectClass	The subject class for this converter.
static final String	MSG_InvalidDateTimeFormat	The error message for an invalid date/time on the command line: "\'%1$s\' cannot be parsed as a valid date/time".

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

METHOD_NAME_GetSubjectClass, METHOD_NAME_Provider

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	TimeDateStringConverter(Class<T> subjectClass)	Creates a new TimeStringConverter instance.
protected	TimeDateStringConverter(Class<T> subjectClass, DateTimeFormatter formatter)	Creates a new TimeStringConverter instance that uses the given formatter for the conversion back and forth.
private	TimeDateStringConverter(Class<T> subjectClass, Optional<DateTimeFormatter> formatter)	Creates a new TimeStringConverter instance.

Method Summary

Modifier and Type	Method	Description
final T	fromString(CharSequence source)
final Collection<Class<T>>	getSubjectClass()	Provides the subject class for this converter.
protected abstract T	parseDateTime(CharSequence source, Optional<DateTimeFormatter> formatter)	Parses the given String to an instance of Temporal.
private final void	readObject(ObjectInputStream in)	Loads a previously serialised instance of this class from the given input stream.
final String	toString(T source)
private final void	writeObject(ObjectOutputStream out)	Writes a serialised instance of this class to the given output stream.

Methods inherited from class java.lang.Object

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

Field Details

MSG_InvalidDateTimeFormat

public static final String MSG_InvalidDateTimeFormat

The error message for an invalid date/time on the command line: "\'%1$s\' cannot be parsed as a valid date/time".

See Also:

• Constant Field Values

m_Formatter

private final transient Optional<DateTimeFormatter> m_Formatter

The formatter that is used to format the date/time data.

m_SubjectClass

private final Class<T extends TemporalAccessor> m_SubjectClass

The subject class for this converter.

Constructor Details

TimeDateStringConverter

protected TimeDateStringConverter(Class<T> subjectClass)

Creates a new TimeStringConverter instance.

Parameters:

subjectClass - The subject class.

TimeDateStringConverter

protected TimeDateStringConverter(Class<T> subjectClass,
 DateTimeFormatter formatter)

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

Note:

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

Parameters:

subjectClass - The subject class.

formatter - The formatter for the date/time data.

TimeDateStringConverter

private TimeDateStringConverter(Class<T> subjectClass,
 Optional<DateTimeFormatter> formatter)

Creates a new TimeStringConverter instance.

Parameters:

subjectClass - The subject class.

formatter - The formatter for the date/time data.

Method Details

fromString

public final T fromString(CharSequence source)
                   throws IllegalArgumentException

Specified by:

fromString in interface StringConverter<T extends TemporalAccessor>

Throws:

IllegalArgumentException

getSubjectClass

public final Collection<Class<T>> getSubjectClass()

Provides the subject class for this converter.

Returns:

The subject class.

parseDateTime

@MountPoint
protected abstract T 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.

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.

readObject

private final void readObject(ObjectInputStream in)
                       throws IOException,
ClassNotFoundException

Loads a previously serialised instance of this class from the given input stream.

Parameters:

in - The input stream.

Throws:

IOException - The de-serialisation failed.

ClassNotFoundException - A class could not be found.

toString

public final String toString(T source)

Specified by:

toString in interface StringConverter<T extends TemporalAccessor>

writeObject

private final void writeObject(ObjectOutputStream out)
                        throws IOException

Writes a serialised instance of this class to the given output stream. This fails if a DateTimeFormatter instance was assigned to this instance.

Parameters:

out - The output stream.

Throws:

IOException - A DateTimeFormatter was assigned to this instance.