Uses of Interface
org.refcodes.cli.Constituent

Uses of Constituent in org.refcodes.cli

Subinterfaces of Constituent in org.refcodes.cli

Modifier and Type	Interface	Description
interface	Condition	The Condition interface represents a node (and therewith the syntax for the arguments) in the command line arguments syntax tree; simply extending the Constituent interface and adding the functionality of providing access to the added Operands (leafs).
interface	Operand<T>	An Operand represents a value parsed from command line arguments.
interface	Option<T>	An Option represents a command line option with the according option's value.

Classes in org.refcodes.cli that implement Constituent

Modifier and Type	Class	Description
class	AbstractCondition	The AbstractCondition is an abstract implementation of the Condition interface providing the boiler plate when implementing the Condition interface as done by the AbstractCondition's sub-classes.
class	AbstractOperand<T>	The AbstractOperand is an abstract implementation of an Operand providing the boiler plate when implementing the Operand interface.
class	AbstractOption<T>	The AbstractOption is an abstract implementation of an Option providing the boiler plate when implementing the Option interface.
class	AllCondition	The AllCondition enforces that the encapsulated Constituent consumes all arguments passed via invoking its parseArgs(String[], CliContext), else a SuperfluousArgsException is thrown.
class	AndCondition	An AndCondition contains (represents) a list of Condition (Constituent) instances (nested by the AndCondition) of which all are to be parsed successfully as of invoking the parseArgs(String[], String[], CliContext) methods.
class	AnyCondition	Any of the nested Condition conditions may match for the AnyCondition to match, e.g. all of the nested conditions are optional.
class	ArrayOperand<T>	Creates an array representation facade for the encapsulated Operand.
class	ArrayOption<T>	Creates an array representation facade for the encapsulated Option.
class	CasesCondition	The CasesCondition is an XorCondition making sure that all possible cases inside the XorCondition must(!)
class	CharOption	The CharOption represents an Option 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	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	EnumOption<T extends Enum<T>>	The EnumOption represents an Option of enumeration types.
class	FileOption	The FileOption represents an Option 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	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	LongOption	The LongOption represents an Option holding long values.
class	NoneOperand	The NoneOperand represents an empty set of arguments, e.g. no command line argument is being passed.
class	Operation	The Operation is an argument representing a function or a method ("command") and is either provided or not provided as of Operation.isEnabled().
class	OrCondition	An OrCondition represents a list of Condition (Constituent) instances of which at least one must be parsed successfully when the Constituent s' parseArgs(String[], String[], CliContext) methods are invoked.
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	StringOperand	An Operand (neither a short option nor a long option prepended nor being a switch) being s String.
class	StringOption	The StringOption represents an Option 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.
class	XorCondition	An XorCondition represents a list of Condition (Constituent) instances of which only one is allowed to be parsed successfully when the parseArgs(String[], String[], CliContext) methods are invoked.

Methods in org.refcodes.cli that return Constituent

Modifier and Type	Method	Description
Constituent	ArgsParser.getArgsSyntax()	The root condition is the starting point node of a Constituent hierarchy to be traversed when determining the syntax for command line arguments or when evaluating the command line arguments.
Constituent	ArgsParserImpl.getArgsSyntax()	The root condition is the starting point node of a Constituent hierarchy to be traversed when determining the syntax for command line arguments or when evaluating the command line arguments.
Constituent	ArgsSyntaxAccessor.getArgsSyntax()	Retrieves the root condition from the root condition 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 given Condition (setter) as of ArgsSyntaxAccessor.ArgsSyntaxMutator.setArgsSyntax(Constituent) and returns the very same value (getter).

Methods in org.refcodes.cli that return types with arguments of type Constituent

Modifier and Type	Method	Description
protected List<Constituent>	AbstractCondition.getChildren()	Gets the children.

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

Modifier and Type	Method	Description
protected void	AbstractCondition.addChild(Constituent aArgumentizer)	Adds the child.
static Condition	CliSugar.all(Constituent aArg)	Instantiates a new AllCondition with the Constituent (Condition) instance to be nested.
static Condition	CliSugar.and(Constituent... aArgs)	Instantiates a new AndCondition with the Constituent (Condition) instances to be nested.
static Condition	CliSugar.any(Constituent... aArgs)	Instantiates a new AnyCondition with the Constituent (Condition) instances to be nested.
static Condition	CliSugar.cases(Constituent... aArgs)	Instantiates a new CasesCondition with the Constituent (Condition) instances to be nested.
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 given Condition (setter) as of ArgsSyntaxAccessor.ArgsSyntaxMutator.setArgsSyntax(Constituent) and returns the very same value (getter).
static Condition	CliSugar.optional(Constituent... aArgs)	Semantically identical synonym for the CliSugar.optional(Constituent...) declaration.
static Condition	CliSugar.or(Constituent... aArgs)	Instantiates a new OrCondition with the Constituent (Condition) instances to be nested.
void	ArgsSyntaxAccessor.ArgsSyntaxMutator.setArgsSyntax(Constituent aArgsSyntax)	Sets the root condition for the root condition property.
String[]	CliContext.toAllOptions(Constituent aConstituent)	Determines all options (short and long) found in the provided Constituent node and its children.
B	ArgsSyntaxAccessor.ArgsSyntaxBuilder.withArgsSyntax(Constituent aArgsSyntax)	Sets the root condition for the root condition property.
static Condition	CliSugar.xor(Constituent... aArgs)	Instantiates a new XorCondition with the Constituent (Condition) instances to be nested.

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

Modifier	Constructor	Description
	AbstractCondition(String aDescription, Constituent... aElements)	Instantiates a new abstract condition.
	AllCondition(Constituent aArg)	Instantiates a new AllCondition with the Constituent (Condition) instance to be nested.
	AndCondition(Constituent... aArgs)	Instantiates a new AndCondition with the Constituent (Condition) instances to be nested.
	AnyCondition(Constituent... aArgs)	Instantiates a new AnyCondition with the Constituent (Condition) instances to be nested.
	ArgsParserImpl(Constituent aArgsSyntax)	Constructs the ArgsParser instance with the given root Condition and the default SyntaxNotation.LOGICAL.
	ArgsParserImpl(Constituent aArgsSyntax, CliContext aCliCtx)	Constructs the ArgsParser instance with the given root Condition and the default SyntaxNotation.LOGICAL.
	CasesCondition(Constituent... aArgs)	Instantiates a new CasesCondition with the Constituent (Condition) instances to be nested.
	OrCondition(Constituent... aArgs)	Instantiates a new OrCondition with the Constituent (Condition) instances to be nested.
protected	XorCondition(String aDescription, Constituent... aArgs)	Instantiates a new XorCondition with the Constituent (Condition) instances to be nested.
	XorCondition(Constituent... aArgs)	Instantiates a new XorCondition with the Constituent (Condition) instances to be nested.