Module io.github.mmm.cli

Package io.github.mmm.cli.arg

Class CliShortOption

java.lang.Object

io.github.mmm.cli.arg.CliArgument

io.github.mmm.cli.arg.CliOption

io.github.mmm.cli.arg.CliShortOption

public class CliShortOption
extends CliOption

CliOption in short format (e.g. "-h"). Will always be a hyphen ('-') followed by a single other character.

Since:

1.0.0

Field Summary

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

END_OPTIONS

Method Summary

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

Methods inherited from class io.github.mmm.cli.arg.CliOption

getValueType, isAssignment, isEndOptions, isOption, isValue

Methods inherited from class io.github.mmm.cli.arg.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

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.

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