Module org.tquadrat.foundation.config

Package org.tquadrat.foundation.config.cli

Class TimeValueHandler<T extends Temporal>

java.lang.Object

org.tquadrat.foundation.config.cli.CmdLineValueHandler<T>

org.tquadrat.foundation.config.cli.TimeValueHandler<T>

Type Parameters:

T - The type that is handled by this class.

Direct Known Subclasses:

InstantValueHandler, LocalDateTimeValueHandler, LocalDateValueHandler, LocalTimeValueHandler, YearMonthValueHandler, YearValueHandler, ZonedDateTimeValueHandler

@ClassVersion(sourceVersion="$Id: TimeValueHandler.java 1061 2023-09-25 16:32:43Z tquadrat $")
@API(status=INTERNAL,
     since="0.0.1")
public abstract class TimeValueHandler<T extends Temporal>
extends CmdLineValueHandler<T>

The abstract base class for implementations of CmdLineValueHandler for types that extend Temporal.

Except for InstantValueHandler, the format for the date/time data on the command line can be modified by setting the format parameter of the @Option or @Argument annotation. The value for that parameter has to conform the requirements as for DateTimeFormatter.ofPattern(String).

All implementations do allow the value "now" instead of a concrete date/time value; this will be interpreted always as the current date and/or time.

Author:

Thomas Thrien (thomas.thrien@tquadrat.org)

Version:

$Id: TimeValueHandler.java 1061 2023-09-25 16:32:43Z tquadrat $

Since:

0.0.1

See Also:

• DateTimeFormatter

UML Diagram

⁠

UML Diagram for "org.tquadrat.foundation.config.cli.TimeValueHandler"

⁠

Field Summary

Fields

Modifier and Type	Field	Description
private final TimeDateStringConverter<T>	m_StringConverter	The implementation of StringConverter that is used to translate the String value from the command line into the desired object instance.
static final String	MSG_InvalidDateTimeFormat	The error message about an invalid date/time on the command line: "\'%1$s\' cannot be parsed as a valid date/time".
static final int	MSGKEY_InvalidDateTimeFormat	The resource bundle key for the message about an invalid date/time String on the command line.
static final String	NOW	'"now"' stands for the current time.

Fields inherited from class org.tquadrat.foundation.config.cli.CmdLineValueHandler

DEFAULT_PROPERTY_NAME, MSG_InvalidParameter, MSGKEY_InvalidParameter

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	TimeValueHandler(BiConsumer<String,T> valueSetter, TimeDateStringConverter<T> stringConverter)	Creates a new TimeValueHandler instance.
protected	TimeValueHandler(CLIDefinition context, BiConsumer<String,T> valueSetter, TimeDateStringConverter<T> stringConverter)	Creates a new TimeValueHandler instance.

Method Summary

Modifier and Type	Method	Description
protected abstract Optional<TimeDateStringConverter<T>>	createCustomStringConverter()	Creates a non-standard string converter that uses the provided format.
protected final Optional<DateTimeFormatter>	getFormatter()	Creates an instance of DateTimeFormatter from the provided format.
protected abstract T	getNow()	Get the current time.
protected final TimeDateStringConverter<T>	getStringConverter()	Returns the implementation of StringConverter that is used to translate the String value from the command line into the desired object instance.
private final T	parseDateTime(CharSequence value)	Parses the given String to an instance of Temporal.
protected final Collection<T>	translate(Parameters params)	Translates the command line values that can be referenced via the params argument to the target type.

Methods inherited from class org.tquadrat.foundation.config.cli.CmdLineValueHandler

getCLIDefinition, getPropertyName, getValueSetter, parseCmdLine, setContext

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 about an invalid date/time on the command line: "\'%1$s\' cannot be parsed as a valid date/time".

See Also:

• Constant Field Values

MSGKEY_InvalidDateTimeFormat

public static final int MSGKEY_InvalidDateTimeFormat

The resource bundle key for the message about an invalid date/time String on the command line.

See Also:

• Constant Field Values

NOW

public static final String NOW

'"now"' stands for the current time.

See Also:

• Constant Field Values

m_StringConverter

private final TimeDateStringConverter<T extends Temporal> m_StringConverter

The implementation of StringConverter that is used to translate the String value from the command line into the desired object instance.

Constructor Details

TimeValueHandler

protected TimeValueHandler(CLIDefinition context,
 BiConsumer<String,T> valueSetter,
 TimeDateStringConverter<T> stringConverter)

Creates a new TimeValueHandler instance.

Parameters:

context - The CLI definition that provides the context for this value handler.

valueSetter - The Consumer that places the translated value to the property.

stringConverter - The implementation of StringConverter that is used to translate the String value from the command line into the desired object instance in case no formatter is provided.

TimeValueHandler

protected TimeValueHandler(BiConsumer<String,T> valueSetter,
 TimeDateStringConverter<T> stringConverter)

Creates a new TimeValueHandler instance.

Parameters:

valueSetter - The Consumer that places the translated value to the property.

stringConverter - The implementation of StringConverter that is used to translate the String value from the command line into the desired object instance in case no formatter is provided.

Method Details

createCustomStringConverter

protected abstract Optional<TimeDateStringConverter<T>> createCustomStringConverter()

Creates a non-standard string converter that uses the provided format.

Returns:

An instance o Optional that holds the StringConverter.

getFormatter

protected final Optional<DateTimeFormatter> getFormatter()

Creates an instance of DateTimeFormatter from the provided format.

Returns:

An instance of Optional that holds the formatter.

See Also:

• CLIDefinition.format()

getNow

protected abstract T getNow()

Get the current time.

Returns:

The current time.

getStringConverter

protected final TimeDateStringConverter<T> getStringConverter()

Returns the implementation of StringConverter that is used to translate the String value from the command line into the desired object instance.

Returns:

The string converter.

parseDateTime

private final T parseDateTime(CharSequence value)
                       throws IllegalArgumentException

Parses the given String to an instance of Temporal.

Parameters:

value - The String to parse.

Returns:

The time/date value.

Throws:

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

translate

protected final Collection<T> translate(Parameters params)
                                 throws CmdLineException

Translates the command line values that can be referenced via the params argument to the target type.

Specified by:

translate in class CmdLineValueHandler<T extends Temporal>

Parameters:

params - The command line values to translate.

Returns:

A collection with the result; each entry in the collection corresponds to one value from the command line.

Throws:

CmdLineException - The given parameters cannot be parsed to the target type.