Module org.tquadrat.foundation.config

Package org.tquadrat.foundation.config.cli

Class StringValueHandler

java.lang.Object

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

org.tquadrat.foundation.config.cli.StringValueHandler

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

An implementation of CmdLineValueHandler for String values.

The value can be validated against a regular expression that is provided via CLIDefinition.format().

Author:

Kohsuke Kawaguchi (kk@kohsuke.org)

Modified by:

Thomas Thrien (thomas.thrien@tquadrat.org)

Version:

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

Since:

0.0.1

See Also:

• Pattern
• Option.format()
• Argument.format()

UML Diagram

⁠

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

⁠

Field Summary

Fields

Modifier and Type	Field	Description
static final String	MSG_ValidationFailed	The error message that indicates a failed validation: "Validation failed for \'%1$s\'".
static final int	MSGKEY_ValidationFailed	The resource bundle key for the message that indicates that the validation for the command line value had failed.

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

DEFAULT_PROPERTY_NAME, MSG_InvalidParameter, MSGKEY_InvalidParameter

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
protected Collection<String>	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_ValidationFailed

public static final String MSG_ValidationFailed

The error message that indicates a failed validation: "Validation failed for \'%1$s\'".

See Also:

• Constant Field Values

MSGKEY_ValidationFailed

public static final int MSGKEY_ValidationFailed

The resource bundle key for the message that indicates that the validation for the command line value had failed.

See Also:

• Constant Field Values

Constructor Details

StringValueHandler

public StringValueHandler(CLIDefinition context,
 BiConsumer<String,String> valueSetter)

Creates a new StringValueHandler instance.

Parameters:

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

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

StringValueHandler

public StringValueHandler(BiConsumer<String,String> valueSetter)

Creates a new StringValueHandler instance.

Parameters:

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

Method Details

translate

protected Collection<String> 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<String>

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.