Module io.github.mmm.cli

Package io.github.mmm.cli.arg

Class CliArgument

java.lang.Object

io.github.mmm.cli.arg.CliArgument

Direct Known Subclasses:

CliOption, CliValue

public abstract class CliArgument
extends Object

A single argument of a main method from a command-line-interface (CLI). A CliArgument is either a CliOption or a CliValue.

Since:

1.0.0

See Also:

• CliArgs.getFirst()
• getNext()

Field Summary

Fields

Modifier and Type	Field	Description
static final String	END_OPTIONS	The argument to indicate the end of the options.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	CliArgument(String arg)	The constructor.

Method Summary

Modifier and Type	Method	Description
String	get()
CliArgument	getNext()
CliOption	getNextOption()
CliValue	getNextValue()
abstract String	getOptionName()
String	getValue()	If this is a CliOption followed by a CliValue, this method will return that value (e.g.
List<String>	getValues()	Like getValue() but returns all the next values.
abstract CliValueType	getValueType()
boolean	isEndOptions()
abstract boolean	isLongOption()
abstract boolean	isOption()
abstract boolean	isShortOption()
abstract boolean	isValue()
String	toString()

Methods inherited from class java.lang.Object

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

Field Details

END_OPTIONS

public static final String END_OPTIONS

The argument to indicate the end of the options. If this string is given as argument, any further arguments are treated as values. This allows to provide CliValues (e.g. a filename) starting with a hyphen ('-'). Please note that the first occurrence of this string given as argument will not be supplied as CliArgument but only parsed internally to hide complexity for the developer using this API.

See Also:

• Constant Field Values

Constructor Details

CliArgument

protected CliArgument(String arg)

The constructor.

Parameters:

arg - the argument.

Method Details

get

public String get()

Returns:

the argument text (e.g. "-h" for CliShortOption, "--help" for CliLongOption, or "archive.zip" for a CliValue.

getOptionName

public abstract String getOptionName()

Returns:

the name of a CliOption or null if not an option (in case of a CliValue). For the CliShortOption "-h" this method will return "h", and for CliLongOption "--help" it will return "help".

isOption

public abstract boolean isOption()

Returns:

true if this CliArgument is a CliOption (e.g. "-h" or "--help"), false otherwise (if it is a CliValue).

isShortOption

public abstract boolean isShortOption()

Returns:

true if this CliArgument is a CliShortOption (e.g. "-h"), false otherwise.

isLongOption

public abstract boolean isLongOption()

Returns:

true if this CliArgument is a CliLongOption (e.g. "--help"), false otherwise.

isValue

public abstract boolean isValue()

Returns:

true if this CliArgument is a CliValue, false otherwise (if it is a CliOption).

getValueType

public abstract CliValueType getValueType()

Returns:

the CliValueType or null in case of an option.

isEndOptions

public boolean isEndOptions()

Returns:

true if END_OPTIONS was detected, false otherwise. If END_OPTIONS is parsed for the first time, it will be skipped, all following arguments will be parsed as CliValue no matter if they start with hyphen ('-') or not and will return true for this method.

getNext

public CliArgument getNext()

Returns:

the next CliArgument or null if this is the last argument.

getNextOption

public CliOption getNextOption()

Returns:

the next CliOption (skipping all next CliValues) or null if no more CliOption follows.

getNextValue

public CliValue getNextValue()

Returns:

the next CliValue (skipping all next CliOptions) or null if no more CliValue follows.

getValue

public String getValue()

If this is a CliOption followed by a CliValue, this method will return that value (e.g. for "--key foo" it will return "foo"). If however such CliOption is followed by another CliOption, this method will return null (e.g. for "-x -z"). Finally, if this is a CliValue, this method will return its value.

Returns:

the same as get() if this is a CliValue, otherwise if this a CliOption the value of the next argument if a CliValue or otherwise null.

getValues

public List<String> getValues()

Like getValue() but returns all the next values.

Returns:

a List with the value of this CliArgument followed by all next CliValues available. If getValue() return null this method will return an empty List.

toString

public String toString()

Overrides:

toString in class Object