Module org.tquadrat.foundation.config

Package org.tquadrat.foundation.config.spi

Class CLIDefinition

java.lang.Object

org.tquadrat.foundation.config.spi.CLIDefinition

Direct Known Subclasses:

CLIArgumentDefinition, CLIOptionDefinition

@ClassVersion(sourceVersion="$Id: CLIDefinition.java 1120 2024-03-16 09:48:00Z tquadrat $")
@API(status=STABLE,
     since="0.0.1")
public abstract class CLIDefinition
extends Object

Base class for the run-time copies of the @Option or @Argument annotation. By definition, unnamed options are arguments, and named options are real command line options.

Author:

Thomas Thrien (thomas.thrien@tquadrat.org)

Thanks to:

Mark Sinke

Version:

$Id: CLIDefinition.java 1120 2024-03-16 09:48:00Z tquadrat $

Since:

0.0.1

See Also:

• CLIOptionDefinition
• CLIArgumentDefinition

UML Diagram

⁠

UML Diagram for "org.tquadrat.foundation.config.spi.CLIDefinition"

⁠

Field Summary

Fields

Modifier and Type	Field	Description
private final Optional<String>	m_Format	The optional format string.
private final CmdLineValueHandler<?>	m_Handler	The handler that is used to parse and store the option or argument value.
private final boolean	m_IsArgument	true if this is an argument, false if it is an option.
private final boolean	m_IsMultiValued	true if the target property is multivalued, false otherwise.
private final boolean	m_IsRequired	true if the option or argument is required, false otherwise.
private final String	m_MetaVar	The name of the meta variable that is used in examples.
private final String	m_Property	The name of the property.
private final Optional<String>	m_Usage	The usage text.
private final Optional<String>	m_UsageKey	The resource key for the usage text.
static final int	MSGKEY_EmptyIsInvalid	The message indicating that the empty String is not allowed as an option name.
static final int	MSGKEY_InvalidName	The message indicating an invalid option name.
static final int	MSGKEY_ReservedName	The message indicating that the option name is reserved.
static final int	MSGKEY_Whitespace1	The message indicating a whitespace character as option name.
static final int	MSGKEY_Whitespace2	The message indicating a whitespace character as part of an option name.
static final int	MSGKEY_WrongLeadIn	The message indicating an invalid lead-in for an option name.
static final String	USAGE_KEY_FORMAT	The format for the default usage keys.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	CLIDefinition(String property, boolean isArgument, String usage, String usageKey, String metaVar, boolean required, CmdLineValueHandler<?> handler, boolean multiValued, String format)	Creates a new CLIDefinition instance.

Method Summary

Modifier and Type	Method	Description
final Optional<String>	format()	Returns the optional format.
abstract String	getSortKey()	Returns the sort key for the option or argument.
final CmdLineValueHandler<?>	handler()	Returns the handler.
final boolean	isArgument()	Returns a flag that indicates whether this is the definition for an argument or an option.
final boolean	isMultiValued()	Returns a flag that indicates whether this option or argument is multivalued.
final String	metaVar()	The name of the meta variable.
final int	processParameters(Parameters params)	Processes the given parameter(s).
final String	propertyName()	Returns the property name for this CLI element.
final boolean	required()	Returns a flag indicating if the option or argument is mandatory.
abstract String	toString()
final Optional<String>	usage()	Returns the usage text.
final Optional<String>	usageKey()	Returns the resource key for the usage text.
static final boolean	validateOptionName(String name)	Checks whether the given name for a command line option is valid.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details

MSGKEY_EmptyIsInvalid

@API(status=STABLE,
     since="0.1.0")
public static final int MSGKEY_EmptyIsInvalid

The message indicating that the empty String is not allowed as an option name.

See Also:

• Constant Field Values

MSGKEY_InvalidName

@API(status=STABLE,
     since="0.1.0")
public static final int MSGKEY_InvalidName

The message indicating an invalid option name.

See Also:

• Constant Field Values

MSGKEY_ReservedName

@API(status=STABLE,
     since="0.1.0")
public static final int MSGKEY_ReservedName

The message indicating that the option name is reserved.

See Also:

• Constant Field Values

MSGKEY_Whitespace1

@API(status=STABLE,
     since="0.1.0")
public static final int MSGKEY_Whitespace1

The message indicating a whitespace character as option name.

See Also:

• Constant Field Values

MSGKEY_Whitespace2

@API(status=STABLE,
     since="0.1.0")
public static final int MSGKEY_Whitespace2

The message indicating a whitespace character as part of an option name.

See Also:

• Constant Field Values

MSGKEY_WrongLeadIn

@API(status=STABLE,
     since="0.0.1")
public static final int MSGKEY_WrongLeadIn

The message indicating an invalid lead-in for an option name.

See Also:

• Constant Field Values

USAGE_KEY_FORMAT

public static final String USAGE_KEY_FORMAT

The format for the default usage keys.

The resource bundle key for a USAGE text is prepended with the name of the class that defines it.

m_Format

private final Optional<String> m_Format

The optional format string.

m_Handler

private final CmdLineValueHandler<?> m_Handler

The handler that is used to parse and store the option or argument value.

m_IsArgument

private final boolean m_IsArgument

true if this is an argument, false if it is an option.

m_IsMultiValued

private final boolean m_IsMultiValued

true if the target property is multivalued, false otherwise.

m_IsRequired

private final boolean m_IsRequired

true if the option or argument is required, false otherwise.

m_MetaVar

private final String m_MetaVar

The name of the meta variable that is used in examples.

m_Property

private final String m_Property

The name of the property.

m_Usage

private final Optional<String> m_Usage

The usage text.

m_UsageKey

private final Optional<String> m_UsageKey

The resource key for the usage text.

Constructor Details

CLIDefinition

protected CLIDefinition(String property,
 boolean isArgument,
 String usage,
 String usageKey,
 String metaVar,
 boolean required,
 CmdLineValueHandler<?> handler,
 boolean multiValued,
 String format)

Creates a new CLIDefinition instance.

Parameters:

property - The name of the property.

isArgument - true for an argument, false for an option.

usage - The usage text.

usageKey - The resource bundle key for the usage text.

metaVar - The meta variable name.

required - true if the argument or option is mandatory.

handler - The handler for the option or argument value.

multiValued - true if the option or argument allows more than one value.

format - The optional format.

Method Details

format

public final Optional<String> format()

Returns the optional format.

Returns:

An instance of Optional that holds the format.

See Also:

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

getSortKey

public abstract String getSortKey()

Returns the sort key for the option or argument.

Returns:

The sort key.

handler

public final CmdLineValueHandler<?> handler()

Returns the handler.

Returns:

The handler

isArgument

public final boolean isArgument()

Returns a flag that indicates whether this is the definition for an argument or an option.

Returns:

true if this instance of OptionDef is defined by an @Argument annotation, false if it is defined by an @Option annotation.

isMultiValued

public final boolean isMultiValued()

Returns a flag that indicates whether this option or argument is multivalued.

Returns:

true if multivalued, false otherwise.

metaVar

public final String metaVar()

The name of the meta variable.

Returns:

The meta variable.

processParameters

public final int processParameters(Parameters params)
                            throws CmdLineException

Processes the given parameter(s).

Parameters:

params - A reference to the command line arguments as for this option or argument definition. This method can use this object to access the values if necessary. The object is valid only during the method call.

Returns:

The number of command line arguments consumed by this method. For example, it will return 0 if option defined by this instance does not take any parameters.

Throws:

CmdLineException - Parsing the parameter(s) failed.

propertyName

public final String propertyName()

Returns the property name for this CLI element.

Returns:

The property name.

required

public final boolean required()

Returns a flag indicating if the option or argument is mandatory.

Returns:

true if the argument or option is required, false otherwise.

See Also:

• Argument.required()
• Option.required()

toString

public abstract String toString()

Overrides:

toString in class Object

usage

public final Optional<String> usage()

Returns the usage text.

Returns:

An instance of Optional that holds the usage text.

usageKey

public final Optional<String> usageKey()

Returns the resource key for the usage text.

Returns:

An instance of Optional that holds the key for the usage text.

validateOptionName

public static final boolean validateOptionName(String name)
                                        throws IllegalArgumentException

Checks whether the given name for a command line option is valid.

Parameters:

name - The intended name for the command line option.

Returns:

true if the given name is valid, false otherwise.

Throws:

IllegalArgumentException - The given name is invalid.