Uses of Interface
org.refcodes.cli.Term

Uses of Term in org.refcodes.cli

Subinterfaces of Term 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 by simply extending the Term interface and adding the functionality of providing access to the added Operands (leafs).
interface	Directive<T>	An Directive represents a command line operation with the according operation's operand (value).
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.
interface	Property<T>	An Property represents an option property with the according porperty's key and value separated by a = (and no whitespace inbetween).

Classes in org.refcodes.cli that implement Term

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	AbstractDirective<T>	The AbstractDirective is an abstract implementation of an Directive providing the boiler plate when implementing the Directive interface.
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	AbstractProperty<T>	The AbstractProperty is an abstract implementation of a Property providing the boiler plate when implementing the Property interface.
class	AllCondition	The AllCondition enforces that the encapsulated Term consumes all arguments passed via invoking its Term.parseArgs(String[], CliContext), else a SuperfluousArgsException is thrown.
class	AndCondition	An AndCondition contains (represents) a list of Condition (Term) instances (nested by the AndCondition) of which all are to be parsed successfully as of invoking the Term.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	ArrayDirective<T>	Creates an array representation facade for the encapsulated Directive.
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	BooleanDirective	The BooleanDirective represents a Directive holding boolean values.
class	BooleanOption	The BooleanOption represents an Option holding boolean values.
class	BooleanProperty	The BooleanProperty represents an Property holding boolean values.
class	CasesCondition	The CasesCondition is an XorCondition making sure that all possible cases inside the XorCondition must(!)
class	CharDirective	The CharDirective represents a Directive holding String values.
class	CharOption	The CharOption represents an Option holding String values.
class	CharProperty	The CharProperty represents an Property 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	ConfigProperty	The ConfigProperty represents an Property 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	DoubleDirective	The DoubleDirective represents a Directive holding double values.
class	DoubleOption	The DoubleOption represents an Option holding double values.
class	DoubleProperty	The DoubleProperty represents an Property holding double values.
class	EnumDirective<T extends Enum<T>>	The EnumDirective represents a Directive of enumeration types.
class	EnumOption<T extends Enum<T>>	The EnumOption represents an Option of enumeration types.
class	EnumProperty<T extends Enum<T>>	The EnumProperty represents an Property of enumeration types.
class	FileDirective	The FileDirective represents a Directive holding File values.
class	FileOption	The FileOption represents an Option holding File values.
class	FileProperty	The FileProperty represents an Property 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	FloatDirective	The FloatDirective represents a Directive holding float values.
class	FloatOption	The FloatOption represents an Option holding float values.
class	FloatProperty	The FloatProperty represents an Property 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	IntDirective	The IntDirective represents a Directive holding int values.
class	IntOption	The IntOption represents an Option holding int values.
class	IntProperty	The IntProperty represents an Property holding int values.
class	LongDirective	The LongDirective represents a Directive holding long values.
class	LongOption	The LongOption represents an Option holding long values.
class	LongProperty	The LongProperty represents an Property 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 an action of functioning or the fact of being active or in effect and is either provided (as command line argument) or not provided as of Operation.isEnabled().
class	OrCondition	An OrCondition represents a list of Condition (Term) instances of which at least one must be parsed successfully when the Term s' Term.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	StringDirective	The StringDirective represents a Directive holding String values.
class	StringOperand	An Operand (neither a short option nor a long option prepended nor being a flag) represents an argument of type String.
class	StringOption	The StringOption represents an Option holding String values.
class	StringProperty	The StringProperty represents an Property 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 (Term) instances of which only one is allowed to be parsed successfully when the Term.parseArgs(String[], String[], CliContext) methods are invoked.

Subinterfaces with type arguments of type Term in org.refcodes.cli

Modifier and Type	Interface	Description
interface	Term	A Term represents a node within a command line argument syntax tree.

Classes in org.refcodes.cli that implement interfaces with type arguments of type Term

Modifier and Type	Class	Description
class	ArgsSyntaxException	Thrown in case of a command line arguments mismatch regarding provided and expected args.

Fields in org.refcodes.cli declared as Term

Modifier and Type	Field	Description
protected Term[]	AbstractCondition._children
protected Term	ArgsSyntaxException._source

Methods in org.refcodes.cli that return Term

Modifier and Type	Method	Description
Term	ArgsParser.getArgsSyntax()	Retrieves the (root) Term from the (root) Term property.
Term	ArgsSyntaxAccessor.getArgsSyntax()	Retrieves the (root) Term from the (root) Term property.
Term	CliArgsParser.getArgsSyntax()	Retrieves the (root) Term from the (root) Term property.
protected Term	AllCondition.getChild()	Returns the one and only child of this Term.
Term[]	AbstractCondition.getChildren()
Term	ArgsSyntaxException.getSource()	Returns the Term responsible for this exception.
default Term	ArgsSyntaxAccessor.ArgsSyntaxProperty.letArgsSyntax(Term 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(Term) and returns the very same value (getter).

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

Modifier and Type	Method	Description
static AllCondition	CliSugar.all(Term aArg)	Instantiates a new AllCondition with the Term.
static AndCondition	CliSugar.and(Term... aArgs)	Instantiates a new AndCondition with the Term.
static AnyCondition	CliSugar.any(Term... aArgs)	Instantiates a new AnyCondition with the Term.
static CasesCondition	CliSugar.cases(Term... aArgs)	Instantiates a new CasesCondition with the Term.
default boolean	Condition.hasChild(Term aTerm)	Determines whether the provided Term is a child (or a child's child) of this Condition.
default boolean	Condition.isChild(Term aTerm)	Determines whether the provided Term is a direct child of this Condition.
default Term	ArgsSyntaxAccessor.ArgsSyntaxProperty.letArgsSyntax(Term 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(Term) and returns the very same value (getter).
static AnyCondition	CliSugar.optional(Term... aArgs)	Semantically identical synonym for the CliSugar.optional(Term...). declaration.
static OrCondition	CliSugar.or(Term... aArgs)	Instantiates a new OrCondition with the Term.
void	ArgsSyntaxAccessor.ArgsSyntaxMutator.setArgsSyntax(Term aArgsSyntax)	Sets the (root) Term for the (root) Term property.
void	CliArgsParser.setArgsSyntax(Term aArgsSyntax)	Sets the (root) Term for the (root) Term property.
String[]	CliContext.toKeywords(Term aTerm)	Determines all keywords (e.g. short- and long-options) found in the provided Term node and its children.
B	ArgsSyntaxAccessor.ArgsSyntaxBuilder.withArgsSyntax(Term aArgsSyntax)	Sets the (root) Term for the (root) Term property.
CliArgsParser	CliArgsParser.withArgsSyntax(Term aArgsSyntax)	Sets the (root) Term for the (root) Term property.
static XorCondition	CliSugar.xor(Term... aArgs)	Instantiates a new XorCondition with the Term.

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

Modifier	Constructor	Description
	AbstractCondition(String aDescription, Term... aElements)	Instantiates an AbstractCondition' s sub-class with the according arguments.
	AllCondition(Term aArg)	Instantiates a new AllCondition with the Term (Condition) instance to be nested.
	AmbiguousArgsException(String[] aArgs, Term aSource, Throwable aCause)	Instantiates the class AmbiguousArgsException.
	AmbiguousArgsException(String[] aArgs, Term aSource, Throwable aCause, String aErrorCode)	Instantiates the class AmbiguousArgsException.
	AmbiguousArgsException(String aMessage, String[] aArgs, Term aSource)	Instantiates the class AmbiguousArgsException.
	AmbiguousArgsException(String aMessage, String[] aArgs, Term aSource, String aErrorCode)	Instantiates the class AmbiguousArgsException.
	AmbiguousArgsException(String aMessage, String[] aArgs, Term aSource, Throwable aCause)	Instantiates the class AmbiguousArgsException.
	AmbiguousArgsException(String aMessage, String[] aArgs, Term aSource, Throwable aCause, String aErrorCode)	ArgsSyntaxException#ArgsSyntaxException(String, String[], Term, Throwable, String)
	AndCondition(Term... aArgs)	Instantiates a new AndCondition with the Term (Condition) instances to be nested.
	AnyCondition(Term... aArgs)	Instantiates a new AnyCondition with the Term (Condition) instances to be nested.
	ArgsSyntaxException(String[] aArgs, Term aSource, Throwable aCause)	Instantiates the class ArgsSyntaxException.
	ArgsSyntaxException(String[] aArgs, Term aSource, Throwable aCause, String aErrorCode)	Instantiates the class ArgsSyntaxException.
	ArgsSyntaxException(String aMessage, String[] aArgs, Term aSource)	Instantiates the class ArgsSyntaxException.
	ArgsSyntaxException(String aMessage, String[] aArgs, Term aSource, String aErrorCode)	Instantiates the class ArgsSyntaxException.
	ArgsSyntaxException(String aMessage, String[] aArgs, Term aSource, Throwable aCause)	Instantiates the class ArgsSyntaxException.
	ArgsSyntaxException(String aMessage, String[] aArgs, Term aSource, Throwable aCause, String aErrorCode)	Instantiates the class ArgsSyntaxException.
	CasesCondition(Term... aArgs)	Instantiates a new CasesCondition with the Term (Condition) instances to be nested.
	CliArgsParser(Term aArgsSyntax)	Constructs the ArgsParser instance with the given root Condition and the default SyntaxNotation.LOGICAL.
	CliArgsParser(Term aArgsSyntax, CliContext aCliCtx)	Constructs the ArgsParser instance with the given root Condition and the default SyntaxNotation.LOGICAL.
	OrCondition(Term... aArgs)	Instantiates a new OrCondition with the Term (Condition) instances to be nested.
	ParseArgsException(String[] aArgs, Term aSource, Throwable aCause)	Instantiates the class ParseArgsException.
	ParseArgsException(String[] aArgs, Term aSource, Throwable aCause, String aErrorCode)	Instantiates the class ParseArgsException.
	ParseArgsException(String aMessage, String[] aArgs, Term aSource)	Instantiates the class ParseArgsException.
	ParseArgsException(String aMessage, String[] aArgs, Term aSource, String aErrorCode)	Instantiates the class ParseArgsException.
	ParseArgsException(String aMessage, String[] aArgs, Term aSource, Throwable aCause)	Instantiates the class ParseArgsException.
	ParseArgsException(String aMessage, String[] aArgs, Term aSource, Throwable aCause, String aErrorCode)	Instantiates the class ParseArgsException.
	ParseDirectiveArgsException(String[] aArgs, String aOperation, Throwable aCause, Term aSource)	Instantiates the class ParseDirectiveArgsException.
	ParseDirectiveArgsException(String[] aArgs, String aOperation, Throwable aCause, Term aSource, String aErrorCode)	Instantiates the class ParseDirectiveArgsException.
	ParseDirectiveArgsException(String aMessage, String[] aArgs, String aOperation, Throwable aCause, Term aSource)	Instantiates the class ParseDirectiveArgsException.
	ParseDirectiveArgsException(String aMessage, String[] aArgs, String aOperation, Throwable aCause, Term aSource, String aErrorCode)	Instantiates the class ParseDirectiveArgsException.
	ParseDirectiveArgsException(String aMessage, String[] aArgs, String aOperation, Term aSource)	Instantiates the class ParseDirectiveArgsException.
	ParseDirectiveArgsException(String aMessage, String[] aArgs, String aOperation, Term aSource, String aErrorCode)	Instantiates the class ParseDirectiveArgsException.
	ParseOptionArgsException(String[] aArgs, String aShortOption, String aLongOption, Throwable aCause, Term aSource)	Instantiates the class ParseOptionArgsException.
	ParseOptionArgsException(String[] aArgs, String aShortOption, String aLongOption, Throwable aCause, Term aSource, String aErrorCode)	Instantiates the class ParseOptionArgsException.
	ParseOptionArgsException(String aMessage, String[] aArgs, String aShortOption, String aLongOption, Throwable aCause, Term aSource)	Instantiates the class ParseOptionArgsException.
	ParseOptionArgsException(String aMessage, String[] aArgs, String aShortOption, String aLongOption, Throwable aCause, Term aSource, String aErrorCode)	Instantiates the class ParseOptionArgsException.
	ParseOptionArgsException(String aMessage, String[] aArgs, String aShortOption, String aLongOption, Term aSource)	Instantiates the class ParseOptionArgsException.
	ParseOptionArgsException(String aMessage, String[] aArgs, String aShortOption, String aLongOption, Term aSource, String aErrorCode)	Instantiates the class ParseOptionArgsException.
	SuperfluousArgsException(String[] aArgs, Term aSource, Throwable aCause)	Instantiates the class SuperfluousArgsException.
	SuperfluousArgsException(String[] aArgs, Term aSource, Throwable aCause, String aErrorCode)	Instantiates the class SuperfluousArgsException.
	SuperfluousArgsException(String aMessage, String[] aArgs, Term aSource)	Instantiates the class SuperfluousArgsException.
	SuperfluousArgsException(String aMessage, String[] aArgs, Term aSource, String aErrorCode)	Instantiates the class SuperfluousArgsException.
	SuperfluousArgsException(String aMessage, String[] aArgs, Term aSource, Throwable aCause)	Instantiates the class SuperfluousArgsException.
	SuperfluousArgsException(String aMessage, String[] aArgs, Term aSource, Throwable aCause, String aErrorCode)	Instantiates the class SuperfluousArgsException.
	UnknownArgsException(String[] aArgs, Term aSource, Throwable aCause)	Instantiates the class UnknownArgsException.
	UnknownArgsException(String[] aArgs, Term aSource, Throwable aCause, String aErrorCode)	Instantiates the class UnknownArgsException.
	UnknownArgsException(String aMessage, String[] aArgs, Term aSource)	Instantiates the class UnknownArgsException.
	UnknownArgsException(String aMessage, String[] aArgs, Term aSource, String aErrorCode)	Instantiates the class UnknownArgsException.
	UnknownArgsException(String aMessage, String[] aArgs, Term aSource, Throwable aCause)	Instantiates the class UnknownArgsException.
	UnknownArgsException(String aMessage, String[] aArgs, Term aSource, Throwable aCause, String aErrorCode)	Instantiates the class UnknownArgsException.
	UnknownOperationArgsException(String aMessage, String[] aArgs, String aOperation, Throwable aCause, Term aSource)	Instantiates the class UnknownOperationArgsException.
	UnknownOperationArgsException(String aMessage, String[] aArgs, String aOperation, Throwable aCause, Term aSource, String aErrorCode)	Instantiates the class UnknownOperationArgsException.
	UnknownOperationArgsException(String aMessage, String[] aArgs, String aOperation, Term aSource)	Instantiates the class UnknownOperationArgsException.
	UnknownOperationArgsException(String aMessage, String[] aArgs, String aOperation, Term aSource, String aErrorCode)	Instantiates the class UnknownOperationArgsException.
	UnknownOperationArgsException(String aShortOption, String aOperation, String[] aArgs, Throwable aCause, Term aSource)	Instantiates the class UnknownOperationArgsException.
	UnknownOperationArgsException(String aShortOption, String aOperation, String[] aArgs, Throwable aCause, Term aSource, String aErrorCode)	Instantiates the class UnknownOperationArgsException.
	UnknownOptionArgsException(String aMessage, String[] aArgs, String aShortOption, String aLongOption, Throwable aCause, Term aSource)	Instantiates the class UnknownOptionArgsException.
	UnknownOptionArgsException(String aMessage, String[] aArgs, String aShortOption, String aLongOption, Throwable aCause, Term aSource, String aErrorCode)	Instantiates the class UnknownOptionArgsException.
	UnknownOptionArgsException(String aMessage, String[] aArgs, String aShortOption, String aLongOption, Term aSource)	Instantiates the class UnknownOptionArgsException.
	UnknownOptionArgsException(String aMessage, String[] aArgs, String aShortOption, String aLongOption, Term aSource, String aErrorCode)	Instantiates the class UnknownOptionArgsException.
	UnknownOptionArgsException(String aShortOption, String aLongOption, String[] aArgs, Throwable aCause, Term aSource)	Instantiates the class UnknownOptionArgsException.
	UnknownOptionArgsException(String aShortOption, String aLongOption, String[] aArgs, Throwable aCause, Term aSource, String aErrorCode)	Instantiates the class UnknownOptionArgsException.
protected	XorCondition(String aDescription, Term... aArgs)	Instantiates a new XorCondition with the Term (Condition) instances to be nested.
	XorCondition(Term... aArgs)	Instantiates a new XorCondition with the Term (Condition) instances to be nested.