Uses of Interface
org.refcodes.cli.Option

Uses of Option in org.refcodes.cli

Subinterfaces of Option in org.refcodes.cli

Modifier and Type	Interface	Description
interface	PropertyOption<T>	An PropertyOption represents a command line property with the according porperty's key and value.

Classes in org.refcodes.cli that implement Option

Modifier and Type	Class	Description
class	AbstractOption<T>	The AbstractOption is an abstract implementation of an Option providing the boiler plate when implementing the Option interface.
class	AbstractPropertyOption<T>	The AbstractPropertyOption is an abstract implementation of a PropertyOption providing the boiler plate when implementing the PropertyOption interface.
class	ArrayOption<T>	Creates an array representation facade for the encapsulated Option.
class	BooleanOption	The BooleanOption represents an Option holding boolean values.
class	BooleanProperty	The BooleanProperty represents an PropertyOption holding boolean values.
class	CharOption	The CharOption represents an Option holding String values.
class	CharProperty	The CharProperty represents an PropertyOption holding String values.
class	CleanFlag	A predefined clean Flag: A predefined Flag gives its CleanFlag.SHORT_OPTION, its CleanFlag.LONG_OPTION as well as its CleanFlag.ALIAS an according semantics regarded by other subsystems.
class	ConfigOption	The ConfigOption represents an Option holding a value specifying a configuration resource (file).
class	ConfigProperty	The ConfigProperty represents an PropertyOption holding a value specifying a configuration resource (file).
class	DaemonFlag	A predefined daemon Flag: A predefined Flag gives its DaemonFlag.SHORT_OPTION, its DaemonFlag.LONG_OPTION as well as its DaemonFlag.ALIAS an according semantics regarded by other subsystems.
class	DebugFlag	A predefined debug Flag: A predefined Flag gives its DebugFlag.SHORT_OPTION, its DebugFlag.LONG_OPTION as well as its DebugFlag.ALIAS an according semantics regarded by other subsystems.
class	DoubleOption	The DoubleOption represents an Option holding double values.
class	DoubleProperty	The DoubleProperty represents an PropertyOption holding double values.
class	EnumOption<T extends Enum<T>>	The EnumOption represents an Option of enumeration types.
class	EnumProperty<T extends Enum<T>>	The EnumProperty represents an PropertyOption of enumeration types.
class	FileOption	The FileOption represents an Option holding File values.
class	FileProperty	The FileProperty represents an PropertyOption holding File values.
class	Flag	The Flag class implements the Option interface for representing either a true or a false state: When a flag is provided to your command line arguments, then it is considered to be true, when it is omitted, then it is considered to be false as of Flag.isEnabled().
class	FloatOption	The FloatOption represents an Option holding float values.
class	FloatProperty	The FloatProperty represents an PropertyOption holding float values.
class	ForceFlag	A predefined force Flag: A predefined Flag gives its ForceFlag.SHORT_OPTION, its ForceFlag.LONG_OPTION as well as its ForceFlag.ALIAS an according semantics regarded by other subsystems.
class	HelpFlag	A predefined help Flag: A predefined Flag gives its HelpFlag.SHORT_OPTION, its HelpFlag.LONG_OPTION as well as its HelpFlag.ALIAS an according semantics regarded by other subsystems.
class	InitFlag	A predefined init Flag: A predefined Flag gives its InitFlag.SHORT_OPTION, its InitFlag.LONG_OPTION as well as its InitFlag.ALIAS an according semantics regarded by other subsystems.
class	IntOption	The IntOption represents an Option holding int values.
class	IntProperty	The IntProperty represents an PropertyOption holding int values.
class	LongOption	The LongOption represents an Option holding long values.
class	LongProperty	The LongProperty represents an PropertyOption holding long values.
class	QuietFlag	A predefined "be quiet" Flag: A predefined Flag gives its QuietFlag.SHORT_OPTION, its QuietFlag.LONG_OPTION as well as its QuietFlag.ALIAS an according semantics regarded by other subsystems.
class	StringOption	The StringOption represents an Option holding String values.
class	StringProperty	The StringProperty represents an PropertyOption holding String values.
class	SysInfoFlag	A predefined system information Flag: A predefined Flag gives its SysInfoFlag.SHORT_OPTION, its SysInfoFlag.LONG_OPTION as well as its SysInfoFlag.ALIAS an according semantics regarded by other subsystems..
class	VerboseFlag	A predefined verbose Flag: A predefined Flag gives its VerboseFlag.SHORT_OPTION, its VerboseFlag.LONG_OPTION as well as its VerboseFlag.ALIAS an according semantics regarded by other subsystems.

Methods in org.refcodes.cli with parameters of type Option

Modifier and Type	Method	Description
static <T> ArrayOption<T>	CliSugar.asArray(Option<T> aOption)	Creates an array representation facade for the encapsulated Option.
static <T> ArrayOption<T>	CliSugar.asArray(Option<T> aOption, int aLength)	Creates an array representation facade for the encapsulated Option.
static <T> ArrayOption<T>	CliSugar.asArray(Option<T> aOption, int aMinLength, int aMaxLength)	Creates an array representation facade for the encapsulated Option.
String	CliContext.toLongOption(Option<?> aOption)	Creates the CliContext instance specific prefixed long option String from the provided Option by prefixing the Option's long option (as of getLongOption()) with the long option prefix (as of LongOptionPrefixAccessor.getLongOptionPrefix()).
String[]	CliContext.toOptions(Option<?> aOption)	Retrieves an array of the context specific options being configured for the given Option instance, being the long option (when set) and the short option (when set), by prepending the according runtime specific short option and long option prefix (if applicable).
String[]	Optionable.toOptions(Option<?> aOption)	Retrieves an array of the context specific options being configured for the given Option instance, being the long option (when set) and the short option (when set), by prepending the according runtime specific short option and long option prefix (if applicable).
default String[]	ParseArgs.toOptions(Option<?> aOption)	Retrieves an array of the context specific options being configured for the given Option instance, being the long option (when set) and the short option (when set), by prepending the according runtime specific short option and long option prefix (if applicable).
String	CliContext.toOptionSpec(Option<?> aOption)	Creates the CliContext instance specific option notation String (without any arguments), consisting of the short option (as of CliContext.toShortOption(Option)) and(!)
String	CliContext.toOptionUsage(Option<?> aOption)	Creates the CliContext instance specific preferred prefixed option String, being the short option (as of CliContext.toShortOption(Option)) or, in case of the short option being null, the long option (as of CliContext.toLongOption(Option)).
String	CliContext.toShortOption(Option<?> aOption)	Creates the CliContext instance specific prefixed short option String from the provided Option by prefixing the Option's short option (as of getShortOption()) with the short option prefix (as of ShortOptionPrefixAccessor.getShortOptionPrefix()).

Constructors in org.refcodes.cli with parameters of type Option

Modifier	Constructor	Description
	ArrayOption(Option<T> aOption)	Constructs the ArrayOption by encapsulating the given Option and providing its definition as array definition to the CLI.
	ArrayOption(Option<T> aOption, int aLength)	Constructs the ArrayOption by encapsulating the given Option and providing its definition as array definition to the CLI.
	ArrayOption(Option<T> aOption, int aMinLength, int aMaxLength)	Constructs the ArrayOption by encapsulating the given Option and providing its definition as array definition to the CLI.