net.morimekta.console.args

Class BaseOption

java.lang.Object

net.morimekta.console.args.BaseArgument

net.morimekta.console.args.BaseOption

Direct Known Subclasses:

Flag, Option, Property

public abstract class BaseOption
extends BaseArgument

Argument definition base interface.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	BaseOption(String name, String shortNames, String metaVar, String usage, String defaultValue, boolean repeated, boolean required, boolean hidden)

Method Summary

Modifier and Type	Method and Description
abstract int	apply(ArgumentList args) Parse the argument list, including the argument string that triggered the call.
abstract int	applyShort(String opts, ArgumentList args) When handling a list of short options, except for the last short option.
String	getMetaVar() Meta variable to show in usage printout.
String	getPrefix() Prefix part of the usage usage message.
String	getShortNames() Each character of the shortNames string is handled as a short option that is parsed with the -[short] style.
String	getSingleLineUsage() Get the argument's single line usage string.
protected String	nameOrShort() Handy getter mostly to be used in exception naming.

Methods inherited from class net.morimekta.console.args.BaseArgument

getDefaultValue, getName, getUsage, isHidden, isRepeated, isRequired, validate

Methods inherited from class java.lang.Object

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

Constructor Detail

BaseOption

protected BaseOption(String name,
                     String shortNames,
                     String metaVar,
                     String usage,
                     String defaultValue,
                     boolean repeated,
                     boolean required,
                     boolean hidden)

Method Detail

getShortNames

public String getShortNames()

Each character of the shortNames string is handled as a short option that is parsed with the -[short] style. If the string is empty or null, no short options are provided.

Returns:

The short names

getMetaVar

public String getMetaVar()

Meta variable to show in usage printout.

Returns:

The meta variable.

getSingleLineUsage

public String getSingleLineUsage()

Description copied from class: BaseArgument

Get the argument's single line usage string.

Specified by:

getSingleLineUsage in class BaseArgument

Returns:

The single-line usage string.

getPrefix

public String getPrefix()

Description copied from class: BaseArgument

Prefix part of the usage usage message.

Specified by:

getPrefix in class BaseArgument

Returns:

The usage prefix.

applyShort

public abstract int applyShort(String opts,
                               ArgumentList args)

When handling a list of short options, except for the last short option.

Parameters:

opts - The remaining characters of the short opt list.

args - The list of arguments including the short opt list.

Returns:

The number of arguments consumed. If 0 is returned, will handle as the short option char was the only thing being consumed.

apply

public abstract int apply(ArgumentList args)

Parse the argument list, including the argument string that triggered the call. And handle it's value or values.

Specified by:

apply in class BaseArgument

Parameters:

args - The list of arguments.

Returns:

The number of arguments consumed.

Throws:

ArgumentException - If the passed arguments are not valid.

nameOrShort

protected String nameOrShort()

Handy getter mostly to be used in exception naming.

Returns:

The argument's name or first short name.