Uses of Interface
org.refcodes.cli.Constituent
-
Uses of Constituent in org.refcodes.cli
Modifier and TypeInterfaceDescriptioninterface
TheCondition
interface represents a node (and therewith the syntax for the arguments) in the command line arguments syntax tree; simply extending theConstituent
interface and adding the functionality of providing access to the addedOperand
s (leafs).interface
Operand<T>
AnOperand
represents a value parsed from command line arguments.interface
Option<T>
AnOption
represents a command line option with the according option's value.Modifier and TypeClassDescriptionclass
TheAbstractCondition
is an abstract implementation of theCondition
interface providing the boiler plate when implementing theCondition
interface as done by theAbstractCondition
's sub-classes.class
TheAbstractOperand
is an abstract implementation of anOperand
providing the boiler plate when implementing theOperand
interface.class
TheAbstractOption
is an abstract implementation of anOption
providing the boiler plate when implementing theOption
interface.class
TheAllCondition
enforces that the encapsulatedConstituent
consumes all arguments passed via invoking itsparseArgs(String[], CliContext)
, else aSuperfluousArgsException
is thrown.class
AnAndCondition
contains (represents) a list ofCondition
(Constituent
) instances (nested by theAndCondition
) of which all are to be parsed successfully as of invoking theparseArgs(String[], String[], CliContext)
methods.class
Any of the nestedCondition
conditions may match for theAnyCondition
to match, e.g. all of the nested conditions are optional.class
ArrayOperand<T>
Creates an array representation facade for the encapsulatedOperand
.class
ArrayOption<T>
Creates an array representation facade for the encapsulatedOption
.class
TheCasesCondition
is anXorCondition
making sure that all possible cases inside theXorCondition
must(!)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
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
EnumOption<T extends Enum<T>>
TheEnumOption
represents anOption
of enumeration types.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
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
TheNoneOperand
represents an empty set of arguments, e.g. no command line argument is being passed.class
TheOperation
is an argument representing a function or a method ("command") and is either provided or not provided as ofOperation.isEnabled()
.class
AnOrCondition
represents a list ofCondition
(Constituent
) instances of which at least one must be parsed successfully when theConstituent
s'parseArgs(String[], String[], CliContext)
methods are invoked.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.class
AnXorCondition
represents a list ofCondition
(Constituent
) instances of which only one is allowed to be parsed successfully when theparseArgs(String[], String[], CliContext)
methods are invoked.Modifier and TypeMethodDescriptionArgsParser.getArgsSyntax()
Retrieves the (root)Constituent
from the (root)Constituent
property.ArgsParserImpl.getArgsSyntax()
Retrieves the (root)Constituent
from the (root)Constituent
property.ArgsSyntaxAccessor.getArgsSyntax()
Retrieves the (root)Constituent
from the (root)Constituent
property.protected Constituent
AbstractCondition.getFirst()
Gets the first child.default Constituent
ArgsSyntaxAccessor.ArgsSyntaxProperty.letArgsSyntax
(Constituent aArgsSyntax) This method stores and passes through the given argument, which is very useful for builder APIs: Sets the givenCondition
(setter) as ofArgsSyntaxAccessor.ArgsSyntaxMutator.setArgsSyntax(Constituent)
and returns the very same value (getter).Modifier and TypeMethodDescriptionprotected List<Constituent>
AbstractCondition.getChildren()
Gets the children.Modifier and TypeMethodDescriptionprotected void
AbstractCondition.addChild
(Constituent aArgumentizer) Adds the child.static Condition
CliSugar.all
(Constituent aArg) static Condition
CliSugar.and
(Constituent... aArgs) static Condition
CliSugar.any
(Constituent... aArgs) static Condition
CliSugar.cases
(Constituent... aArgs) default Constituent
ArgsSyntaxAccessor.ArgsSyntaxProperty.letArgsSyntax
(Constituent aArgsSyntax) This method stores and passes through the given argument, which is very useful for builder APIs: Sets the givenCondition
(setter) as ofArgsSyntaxAccessor.ArgsSyntaxMutator.setArgsSyntax(Constituent)
and returns the very same value (getter).static Condition
CliSugar.optional
(Constituent... aArgs) Semantically identical synonym for theCliSugar.optional(Constituent...)
declaration.static Condition
CliSugar.or
(Constituent... aArgs) void
ArgsParserImpl.setArgsSyntax
(Constituent aArgsSyntax) Sets the (root)Constituent
for the (root)Constituent
property.void
ArgsSyntaxAccessor.ArgsSyntaxMutator.setArgsSyntax
(Constituent aArgsSyntax) Sets the (root)Constituent
for the (root)Constituent
property.String[]
CliContext.toAllOptions
(Constituent aConstituent) Determines all options (short and long) found in the providedConstituent
node and its children.ArgsParserImpl.withArgsSyntax
(Constituent aArgsSyntax) Sets the (root)Constituent
for the (root)Constituent
property.ArgsSyntaxAccessor.ArgsSyntaxBuilder.withArgsSyntax
(Constituent aArgsSyntax) Sets the (root)Constituent
for the (root)Constituent
property.static Condition
CliSugar.xor
(Constituent... aArgs) ModifierConstructorDescriptionAbstractCondition
(String aDescription, Constituent... aElements) Instantiates a new abstract condition.AllCondition
(Constituent aArg) AndCondition
(Constituent... aArgs) AnyCondition
(Constituent... aArgs) ArgsParserImpl
(Constituent aArgsSyntax) Constructs theArgsParser
instance with the given rootCondition
and the defaultSyntaxNotation.LOGICAL
.ArgsParserImpl
(Constituent aArgsSyntax, CliContext aCliCtx) Constructs theArgsParser
instance with the given rootCondition
and the defaultSyntaxNotation.LOGICAL
.CasesCondition
(Constituent... aArgs) OrCondition
(Constituent... aArgs) protected
XorCondition
(String aDescription, Constituent... aArgs) XorCondition
(Constituent... aArgs)