Module org.tquadrat.foundation.config

Package org.tquadrat.foundation.config.cli

Class YearValueHandler

java.lang.Object

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

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

org.tquadrat.foundation.config.cli.YearValueHandler

@ClassVersion(sourceVersion="$Id: YearValueHandler.java 896 2021-04-05 20:25:33Z tquadrat $")
@API(status=INTERNAL,
     since="0.0.1")
public final class YearValueHandler
extends TimeValueHandler<Year>

The implementation of TimeValueHandler for Year.

Author:

Thomas Thrien (thomas.thrien@tquadrat.org)

Version:

$Id: YearValueHandler.java 896 2021-04-05 20:25:33Z tquadrat $

Since:

0.0.1

UML Diagram

⁠

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

⁠

Field Summary

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

MSG_InvalidDateTimeFormat, MSGKEY_InvalidDateTimeFormat, NOW

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

DEFAULT_PROPERTY_NAME, MSG_InvalidParameter, MSGKEY_InvalidParameter

Constructor Summary

Constructors

Constructor	Description
YearValueHandler(BiConsumer<String,Year> valueSetter)	Creates a new YearValueHandler instance.
YearValueHandler(CLIDefinition context, BiConsumer<String,Year> valueSetter)	Creates a new YearValueHandler instance.

Method Summary

Modifier and Type	Method	Description
protected Optional<TimeDateStringConverter<Year>>	createCustomStringConverter()	Creates a non-standard string converter that uses the provided format.
protected final Year	getNow()	Get the current time.

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

getFormatter, getStringConverter, translate

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

Constructor Details

YearValueHandler

public YearValueHandler(CLIDefinition context,
 BiConsumer<String,Year> valueSetter)

Creates a new YearValueHandler 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.

YearValueHandler

public YearValueHandler(BiConsumer<String,Year> valueSetter)

Creates a new YearValueHandler instance.

Parameters:

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

Method Details

createCustomStringConverter

protected Optional<TimeDateStringConverter<Year>> createCustomStringConverter()

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

Specified by:

createCustomStringConverter in class TimeValueHandler<Year>

Returns:

An instance o Optional that holds the StringConverter.

getNow

protected final Year getNow()

Get the current time.

Specified by:

getNow in class TimeValueHandler<Year>

Returns:

The current time.