Module io.github.mmm.cli

Package io.github.mmm.cli

Class CliValue

java.lang.Object

io.github.mmm.cli.CliArgument

io.github.mmm.cli.CliValue

public class CliValue
extends CliArgument

A CliArgument that is not a CliOption but a value.

Field Summary

Fields inherited from class io.github.mmm.cli.CliArgument

END_OPTIONS

Method Summary

Modifier and Type	Method	Description
String	getOptionName()
boolean	isEndOptions()
boolean	isLongOption()
boolean	isOption()
boolean	isShortOption()
boolean	isValue()

Methods inherited from class io.github.mmm.cli.CliArgument

get, getNext, getNextOption, getNextValue, getValue, getValues, toString

Methods inherited from class java.lang.Object

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

Method Details

getOptionName

public String getOptionName()

Specified by:

getOptionName in class CliArgument

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".

isValue

public boolean isValue()

Specified by:

isValue in class CliArgument

Returns:

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

isOption

public boolean isOption()

Specified by:

isOption in class CliArgument

Returns:

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

isShortOption

public boolean isShortOption()

Specified by:

isShortOption in class CliArgument

Returns:

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

isLongOption

public boolean isLongOption()

Specified by:

isLongOption in class CliArgument

Returns:

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

isEndOptions

public boolean isEndOptions()

Specified by:

isEndOptions in class CliArgument

Returns:

true if CliArgument.END_OPTIONS was detected, false otherwise. If CliArgument.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.