Module org.tquadrat.foundation.config

Package org.tquadrat.foundation.config.cli

Class DocumentValueHandler

java.lang.Object

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

org.tquadrat.foundation.config.cli.DocumentValueHandler

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

An implementation of CmdLineValueHandler for Document values.

The Document will be identified by the name of the respective File object that of course has to exist and needs to be accessible.

Author:

Thomas Thrien (thomas.thrien@tquadrat.org)

Version:

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

Since:

0.0.1

UML Diagram

⁠

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

⁠

Field Summary

Fields

Modifier and Type	Field	Description
static final String	MSG_ReadFailed	The error message for a failed read attempt for the XML file: "Reading/parsing of XML file \'%1$s\' failed".
static final int	MSGKEY_ReadFailed	The resource bundle key for the message about a failed read attempt for the XML file.

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

DEFAULT_PROPERTY_NAME, MSG_InvalidParameter, MSGKEY_InvalidParameter

Constructor Summary

Constructors

Constructor	Description
DocumentValueHandler(BiConsumer<String,Document> valueSetter)	Creates a new DocumentValueHandler instance.

Method Summary

Modifier and Type	Method	Description
protected final Collection<Document>	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_ReadFailed

public static final String MSG_ReadFailed

The error message for a failed read attempt for the XML file: "Reading/parsing of XML file \'%1$s\' failed".

See Also:

• Constant Field Values

MSGKEY_ReadFailed

public static final int MSGKEY_ReadFailed

The resource bundle key for the message about a failed read attempt for the XML file.

See Also:

• Constant Field Values

Constructor Details

DocumentValueHandler

public DocumentValueHandler(BiConsumer<String,Document> valueSetter)

Creates a new DocumentValueHandler instance.

Parameters:

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

Method Details

translate

protected final Collection<Document> 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<Document>

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.