Module org.tquadrat.foundation.config

Package org.tquadrat.foundation.config.cli

Class SimpleCmdLineValueHandler<T>

java.lang.Object

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

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

Type Parameters:

T - The target type.

Direct Known Subclasses:

YesNoValueHandler

@ClassVersion(sourceVersion="$Id: SimpleCmdLineValueHandler.java 1061 2023-09-25 16:32:43Z tquadrat $")
@API(status=STABLE,
     since="0.1.0")
public sealed class SimpleCmdLineValueHandler<T>
extends CmdLineValueHandler<T>
permits YesNoValueHandler

The implementation of CmdLineValueHandler for all those types for that an implementation of StringConverter exists.

Author:

Thomas Thrien (thomas.thrien@tquadrat.org)

Version:

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

Since:

0.1.0

UML Diagram

⁠

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

⁠

Field Summary

Fields

Modifier and Type	Field	Description
private final StringConverter<? extends T>	m_StringConverter	The implementation of StringConverter that is used to translate the String value from the command line into the desired object instance.

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

DEFAULT_PROPERTY_NAME, MSG_InvalidParameter, MSGKEY_InvalidParameter

Constructor Summary

Constructors

Constructor	Description
SimpleCmdLineValueHandler(BiConsumer<String,T> valueSetter, StringConverter<? extends T> stringConverter)	Creates a new SimpleCmdLineValueHandler instance.
SimpleCmdLineValueHandler(CLIDefinition context, BiConsumer<String,T> valueSetter, StringConverter<? extends T> stringConverter)	Creates a new SimpleCmdLineValueHandler instance.

Method Summary

Modifier and Type	Method	Description
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

m_StringConverter

private final StringConverter<? extends T> 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

SimpleCmdLineValueHandler

public SimpleCmdLineValueHandler(BiConsumer<String,T> valueSetter,
 StringConverter<? extends T> stringConverter)

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

SimpleCmdLineValueHandler

public SimpleCmdLineValueHandler(CLIDefinition context,
 BiConsumer<String,T> valueSetter,
 StringConverter<? extends T> stringConverter)

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

Method Details

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>

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.