Uses of Interface
org.refcodes.cli.Option
-
Uses of Option in org.refcodes.cli
Modifier and TypeInterfaceDescriptioninterface
AnPropertyOption
represents a command line property with the according porperty's key and value.Modifier and TypeClassDescriptionclass
TheAbstractOption
is an abstract implementation of anOption
providing the boiler plate when implementing theOption
interface.class
TheAbstractPropertyOption
is an abstract implementation of aPropertyOption
providing the boiler plate when implementing thePropertyOption
interface.class
ArrayOption<T>
Creates an array representation facade for the encapsulatedOption
.class
class
class
class
class
A predefined cleanFlag
: A predefinedFlag
gives itsCleanFlag.SHORT_OPTION
, itsCleanFlag.LONG_OPTION
as well as itsCleanFlag.ALIAS
an according semantics regarded by other subsystems.class
TheConfigOption
represents anOption
holding a value specifying a configuration resource (file).class
TheConfigProperty
represents anPropertyOption
holding a value specifying a configuration resource (file).class
A predefined daemonFlag
: A predefinedFlag
gives itsDaemonFlag.SHORT_OPTION
, itsDaemonFlag.LONG_OPTION
as well as itsDaemonFlag.ALIAS
an according semantics regarded by other subsystems.class
A predefined debugFlag
: A predefinedFlag
gives itsDebugFlag.SHORT_OPTION
, itsDebugFlag.LONG_OPTION
as well as itsDebugFlag.ALIAS
an according semantics regarded by other subsystems.class
class
class
EnumOption<T extends Enum<T>>
TheEnumOption
represents anOption
of enumeration types.class
EnumProperty<T extends Enum<T>>
TheEnumProperty
represents anPropertyOption
of enumeration types.class
class
class
TheFlag
class implements theOption
interface for representing either atrue
or afalse
state: When a flag is provided to your command line arguments, then it is considered to betrue
, when it is omitted, then it is considered to befalse
as ofFlag.isEnabled()
.class
class
class
A predefined forceFlag
: A predefinedFlag
gives itsForceFlag.SHORT_OPTION
, itsForceFlag.LONG_OPTION
as well as itsForceFlag.ALIAS
an according semantics regarded by other subsystems.class
A predefined helpFlag
: A predefinedFlag
gives itsHelpFlag.SHORT_OPTION
, itsHelpFlag.LONG_OPTION
as well as itsHelpFlag.ALIAS
an according semantics regarded by other subsystems.class
A predefined initFlag
: A predefinedFlag
gives itsInitFlag.SHORT_OPTION
, itsInitFlag.LONG_OPTION
as well as itsInitFlag.ALIAS
an according semantics regarded by other subsystems.class
class
class
class
class
A predefined "be quiet"Flag
: A predefinedFlag
gives itsQuietFlag.SHORT_OPTION
, itsQuietFlag.LONG_OPTION
as well as itsQuietFlag.ALIAS
an according semantics regarded by other subsystems.class
class
class
A predefined system informationFlag
: A predefinedFlag
gives itsSysInfoFlag.SHORT_OPTION
, itsSysInfoFlag.LONG_OPTION
as well as itsSysInfoFlag.ALIAS
an according semantics regarded by other subsystems..class
A predefined verboseFlag
: A predefinedFlag
gives itsVerboseFlag.SHORT_OPTION
, itsVerboseFlag.LONG_OPTION
as well as itsVerboseFlag.ALIAS
an according semantics regarded by other subsystems.Modifier and TypeMethodDescriptionstatic <T> ArrayOption<T>
Creates an array representation facade for the encapsulatedOption
.static <T> ArrayOption<T>
Creates an array representation facade for the encapsulatedOption
.static <T> ArrayOption<T>
Creates an array representation facade for the encapsulatedOption
.CliContext.toLongOption
(Option<?> aOption) Creates theCliContext
instance specific prefixed long optionString
from the providedOption
by prefixing theOption
's long option (as ofgetLongOption()
) with the long option prefix (as ofLongOptionPrefixAccessor.getLongOptionPrefix()
).String[]
Retrieves an array of the context specific options being configured for the givenOption
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[]
Retrieves an array of the context specific options being configured for the givenOption
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[]
Retrieves an array of the context specific options being configured for the givenOption
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).CliContext.toOptionSpec
(Option<?> aOption) Creates theCliContext
instance specific option notationString
(without any arguments), consisting of the short option (as ofCliContext.toShortOption(Option)
) and(!)CliContext.toOptionUsage
(Option<?> aOption) Creates theCliContext
instance specific preferred prefixed optionString
, being the short option (as ofCliContext.toShortOption(Option)
) or, in case of the short option beingnull
, the long option (as ofCliContext.toLongOption(Option)
).CliContext.toShortOption
(Option<?> aOption) Creates theCliContext
instance specific prefixed short optionString
from the providedOption
by prefixing theOption
's short option (as ofgetShortOption()
) with the short option prefix (as ofShortOptionPrefixAccessor.getShortOptionPrefix()
).ModifierConstructorDescriptionArrayOption
(Option<T> aOption) Constructs theArrayOption
by encapsulating the givenOption
and providing its definition as array definition to the CLI.ArrayOption
(Option<T> aOption, int aLength) Constructs theArrayOption
by encapsulating the givenOption
and providing its definition as array definition to the CLI.ArrayOption
(Option<T> aOption, int aMinLength, int aMaxLength) Constructs theArrayOption
by encapsulating the givenOption
and providing its definition as array definition to the CLI.