Uses of Interface
org.refcodes.cli.Syntaxable

Uses of Syntaxable in org.refcodes.cli

Subinterfaces of Syntaxable in org.refcodes.cli

Modifier and Type	Interface	Description
interface	ArgsSyntax	The ArgsSyntax interface represents a node (and therewith the syntax for the arguments) in the command line arguments syntax tree; simply extending the Syntaxable interface and adding the functionality of providing access to the added Operands (leafs).
interface	Condition	Interface indicating that the ArgsSyntax semantically represents a condition.
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 Syntaxable

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	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 Syntaxable consumes all arguments passed via invoking its 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 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	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	ConfigOption	The ConfigOption represents an Option holding a value specifying a configuration file or identifying a configuration in general.
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 Class EnumOption.
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	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' parseArgs(String[], String[]) 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 ArgsSyntax (Syntaxable) instances of which only one is allowed to be parsed successfully when the parseArgs(String[], String[]) methods are invoked.

Methods in org.refcodes.cli that return Syntaxable

Modifier and Type	Method	Description
protected Syntaxable	AbstractCondition.getFirst()	Gets the first child.

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

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

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

Modifier and Type	Method	Description
protected void	AbstractCondition.addChild(Syntaxable aArgumentizer)	Adds the child.
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.
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.

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

Constructor	Description
AbstractCondition(Syntaxable... aElements)	Instantiates a new abstract condition.
AllCondition(Syntaxable aArg)	Instantiates a new AllCondition with the Syntaxable (ArgsSyntax) instance to be nested.
AndCondition(Syntaxable... aArgs)	Instantiates a new AndCondition with the Syntaxable (ArgsSyntax) instances to be nested.
AnyCondition(Syntaxable... aArgs)	Instantiates a new AnyCondition with the Syntaxable (ArgsSyntax) instances to be nested.
CasesCondition(Syntaxable... aArgs)	Instantiates a new CasesCondition with the Syntaxable (ArgsSyntax) instances to be nested.
OrCondition(Syntaxable... aArgs)	Instantiates a new OrCondition with the Syntaxable (ArgsSyntax) instances to be nested.
XorCondition(Syntaxable... aArgs)	Instantiates a new XorCondition with the Syntaxable (ArgsSyntax) instances to be nested.