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 the ArgsSyntax semantically represents a condition which usally encapsulates other Syntaxable children.

Classes in org.refcodes.cli that implement ArgsSyntax

Modifier and Type	Class	Description
class	AbstractCondition	The AbstractCondition is an abstract implementation of the ArgsSyntax interface providing the boiler plate when implementing the ArgsSyntax interface as done by the AbstractCondition's sub-classes.
class	AllCondition	The AllCondition enforces that the encapsulated Syntaxable consumes all arguments passed via invoking its Syntaxable.parseArgs(String[]), else a SuperfluousArgsException is thrown.
class	AndCondition	An AndCondition contains (represents) a list of ArgsSyntax (Syntaxable) instances (nested by the AndCondition) of which all are to be parsed successfully as of invoking the Syntaxable.parseArgs(String[], String[]) methods.
class	AnyCondition	Any of the nested ArgsSyntax conditions may match for the AnyCondition to match, e.g. all of the nested conditions are optional.
class	CasesCondition	The CasesCondition is an XorCondition making sure that all possible cases inside the XorCondition must(!)
class	OptionCondition	A no-operation ArgsSyntax used to wrap an Option in places where a ArgsSyntax is expected.
class	OrCondition	An OrCondition represents a list of ArgsSyntax (Syntaxable) instances of which at least one must be parsed successfully when the Syntaxable s' Syntaxable.parseArgs(String[], String[]) methods are invoked.
class	XorCondition	An XorCondition represents a list of ArgsSyntax (Syntaxable) instances of which only one is allowed to be parsed successfully when the Syntaxable.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)	Instantiates a new AllCondition with the Syntaxable (ArgsSyntax) instance to be nested.
static ArgsSyntax	CliSugar.and(Syntaxable... aArgs)	Instantiates a new AndCondition with the Syntaxable (ArgsSyntax) instances to be nested.
static ArgsSyntax	CliSugar.any(Syntaxable... aArgs)	Instantiates a new AnyCondition with the Syntaxable (ArgsSyntax) instances to be nested.
static ArgsSyntax	CliSugar.cases(Syntaxable... aArgs)	Instantiates a new CasesCondition with the Syntaxable (ArgsSyntax) instances to be nested.
ArgsSyntax	ArgsParser.getArgsSyntax()	The root condition is the starting point node of a Syntaxable hierarchy to be traversed when determining the syntax for command line arguments or when evaluating the command line arguments.
ArgsSyntax	ArgsParserImpl.getArgsSyntax()	The root condition is the starting point node of a Syntaxable hierarchy to be traversed when determining the syntax for command line arguments or when evaluating the command line arguments.
ArgsSyntax	RootConditionAccessor.getArgsSyntax()	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 given ArgsSyntax (setter) as of RootConditionAccessor.RootConditionMutator.setRootArgsSyntax(ArgsSyntax) and returns the very same value (getter).
static ArgsSyntax	CliSugar.optional(Syntaxable... aArgs)	Semantically identical synonym for the CliSugar.optional(Syntaxable...) declaration.
static ArgsSyntax	CliSugar.or(Syntaxable... aArgs)	Instantiates a new OrCondition with the Syntaxable (ArgsSyntax) instances to be nested.
static ArgsSyntax	CliSugar.xor(Syntaxable... aArgs)	Instantiates a new XorCondition with the Syntaxable (ArgsSyntax) instances to be nested.

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 given ArgsSyntax (setter) as of RootConditionAccessor.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 the ArgsParser instance with the given root ArgsSyntax and the default SyntaxNotation.REFCODES.