Module org.tquadrat.foundation.config

Package org.tquadrat.foundation.config.spi

Class CLIOptionDefinition

java.lang.Object

org.tquadrat.foundation.config.spi.CLIDefinition

org.tquadrat.foundation.config.spi.CLIOptionDefinition

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

Run-time copy of the Option annotation. By definition, named options are real options (and instances of this class). Unnamed options are arguments and actually another subclass of CLIDefinition.

Author:

Thomas Thrien (thomas.thrien@tquadrat.org)

Thanks to:

Mark Sinke

Version:

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

Since:

0.0.1

See Also:

• CLIArgumentDefinition

UML Diagram

⁠

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

⁠

Field Summary

Fields

Modifier and Type	Field	Description
private final List<String>	m_Aliases	The aliases for the option name.
private final String	m_Name	The option name.

Fields inherited from class org.tquadrat.foundation.config.spi.CLIDefinition

MSGKEY_EmptyIsInvalid, MSGKEY_InvalidName, MSGKEY_ReservedName, MSGKEY_Whitespace1, MSGKEY_Whitespace2, MSGKEY_WrongLeadIn, USAGE_KEY_FORMAT

Constructor Summary

Constructors

Constructor	Description
CLIOptionDefinition(String property, List<String> names, String usage, String usageKey, String metaVar, boolean required, CmdLineValueHandler<?> handler, boolean multiValued, String format)	Creates a new CLIOptionDefinition instance.

Method Summary

Modifier and Type	Method	Description
final Collection<String>	aliases()	Returns the aliases.
final String	getSortKey()	Returns the sort key for the option or argument.
final String	name()	Returns the name of the option.
final String	toString()

Methods inherited from class org.tquadrat.foundation.config.spi.CLIDefinition

format, handler, isArgument, isMultiValued, metaVar, processParameters, propertyName, required, usage, usageKey, validateOptionName

Methods inherited from class java.lang.Object

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

Field Details

m_Aliases

private final List<String> m_Aliases

The aliases for the option name.

m_Name

private final String m_Name

The option name.

Constructor Details

CLIOptionDefinition

public CLIOptionDefinition(String property,
 List<String> names,
 String usage,
 String usageKey,
 String metaVar,
 boolean required,
 CmdLineValueHandler<?> handler,
 boolean multiValued,
 String format)

Creates a new CLIOptionDefinition instance.

Parameters:

property - The name of the property.

names - The names for the option.

usage - The usage text.

usageKey - The resource bundle key for the usage text.

metaVar - The meta variable name; can be null.

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

aliases

public final Collection<String> aliases()

Returns the aliases.

Returns:

The aliases; may be empty, but will never be null.

getSortKey

public final String getSortKey()

Returns the sort key for the option or argument.

Specified by:

getSortKey in class CLIDefinition

Returns:

The sort key.

name

public final String name()

Returns the name of the option.

Returns:

The option's name.

toString

public final String toString()

Specified by:

toString in class CLIDefinition