Uses of Interface
org.refcodes.cli.ArgsSyntax
-
-
Uses of ArgsSyntax in org.refcodes.cli
Subinterfaces of ArgsSyntax in org.refcodes.cli Modifier and Type Interface Description interface
Condition
Interface indicating that theArgsSyntax
semantically represents a condition which usally encapsulates otherSyntaxable
children.Classes in org.refcodes.cli that implement ArgsSyntax Modifier and Type Class Description class
AbstractCondition
TheAbstractCondition
is an abstract implementation of theArgsSyntax
interface providing the boiler plate when implementing theArgsSyntax
interface as done by theAbstractCondition
's sub-classes.class
AllCondition
TheAllCondition
enforces that the encapsulatedSyntaxable
consumes all arguments passed via invoking itsSyntaxable.parseArgs(String[])
, else aSuperfluousArgsException
is thrown.class
AndCondition
AnAndCondition
contains (represents) a list ofArgsSyntax
(Syntaxable
) instances (nested by theAndCondition
) of which all are to be parsed successfully as of invoking theSyntaxable.parseArgs(String[], String[])
methods.class
AnyCondition
Any of the nestedArgsSyntax
conditions may match for theAnyCondition
to match, e.g. all of the nested conditions are optional.class
CasesCondition
TheCasesCondition
is anXorCondition
making sure that all possible cases inside theXorCondition
must(!)class
OptionCondition
class
OrCondition
AnOrCondition
represents a list ofArgsSyntax
(Syntaxable
) instances of which at least one must be parsed successfully when theSyntaxable
s'Syntaxable.parseArgs(String[], String[])
methods are invoked.class
XorCondition
AnXorCondition
represents a list ofArgsSyntax
(Syntaxable
) instances of which only one is allowed to be parsed successfully when theSyntaxable.parseArgs(String[], String[])
methods are invoked.Methods in org.refcodes.cli that return ArgsSyntax Modifier and Type Method Description static ArgsSyntax
CliSugar. all(Syntaxable aArg)
static ArgsSyntax
CliSugar. and(Syntaxable... aArgs)
static ArgsSyntax
CliSugar. any(Syntaxable... aArgs)
static ArgsSyntax
CliSugar. cases(Syntaxable... aArgs)
ArgsSyntax
ArgsParser. getRootArgsSyntax()
The root condition is the starting point node of aSyntaxable
hierarchy to be traversed when determining the syntax for command line arguments or when evaluating the command line arguments.ArgsSyntax
ArgsParserImpl. getRootArgsSyntax()
The root condition is the starting point node of aSyntaxable
hierarchy to be traversed when determining the syntax for command line arguments or when evaluating the command line arguments.ArgsSyntax
RootConditionAccessor. getRootArgsSyntax()
Retrieves the root condition from the root condition property.default ArgsSyntax
RootConditionAccessor.RootConditionProperty. letRootArgsSyntax(ArgsSyntax aRootArgsSyntax)
This method stores and passes through the given argument, which is very useful for builder APIs: Sets the givenArgsSyntax
(setter) as ofRootConditionAccessor.RootConditionMutator.setRootArgsSyntax(ArgsSyntax)
and returns the very same value (getter).static ArgsSyntax
CliSugar. optional(Syntaxable... aArgs)
Semantically identical synonym for theCliSugar.optional(Syntaxable...)
declaration.static ArgsSyntax
CliSugar. or(Syntaxable... aArgs)
static ArgsSyntax
CliSugar. xor(Syntaxable... aArgs)
Methods in org.refcodes.cli with parameters of type ArgsSyntax Modifier and Type Method Description default ArgsSyntax
RootConditionAccessor.RootConditionProperty. letRootArgsSyntax(ArgsSyntax aRootArgsSyntax)
This method stores and passes through the given argument, which is very useful for builder APIs: Sets the givenArgsSyntax
(setter) as ofRootConditionAccessor.RootConditionMutator.setRootArgsSyntax(ArgsSyntax)
and returns the very same value (getter).void
RootConditionAccessor.RootConditionMutator. setRootArgsSyntax(ArgsSyntax aRootArgsSyntax)
Sets the root condition for the root condition property.B
RootConditionAccessor.RootConditionBuilder. withRootArgsSyntax(ArgsSyntax aRootArgsSyntax)
Sets the root condition for the root condition property.Constructors in org.refcodes.cli with parameters of type ArgsSyntax Constructor Description ArgsParserImpl(ArgsSyntax aRootArgsSyntax)
Constructs theArgsParser
instance with the given rootArgsSyntax
and the defaultSyntaxNotation.REFCODES
.
-