Uses of Interface
org.refcodes.cli.Operand

Uses of Operand in org.refcodes.cli

Subinterfaces of Operand in org.refcodes.cli

Modifier and Type	Interface	Description
interface	Option<T>	An Option represents a command line option with the according option's value.
interface	PropertyOption<T>	An PropertyOption represents a command line property with the according porperty's key and value.

Classes in org.refcodes.cli that implement Operand

Modifier and Type	Class	Description
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	AbstractPropertyOption<T>	The AbstractPropertyOption is an abstract implementation of a PropertyOption providing the boiler plate when implementing the PropertyOption interface.
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	BooleanOption	The BooleanOption represents an Option holding boolean values.
class	BooleanProperty	The BooleanProperty represents an PropertyOption holding boolean values.
class	CharOption	The CharOption represents an Option holding String values.
class	CharProperty	The CharProperty represents an PropertyOption 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 PropertyOption 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	DoubleProperty	The DoubleProperty represents an PropertyOption holding double values.
class	EnumOption<T extends Enum<T>>	The EnumOption represents an Option of enumeration types.
class	EnumProperty<T extends Enum<T>>	The EnumProperty represents an PropertyOption of enumeration types.
class	FileOption	The FileOption represents an Option holding File values.
class	FileProperty	The FileProperty represents an PropertyOption 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	FloatProperty	The FloatProperty represents an PropertyOption 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	IntProperty	The IntProperty represents an PropertyOption holding int values.
class	LongOption	The LongOption represents an Option holding long values.
class	LongProperty	The LongProperty represents an PropertyOption 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	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	StringProperty	The StringProperty represents an PropertyOption 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.

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

Modifier and Type	Method	Description
<T extends Operand<?>> T	AbstractCondition.toOperand(String aAlias, Class<T> aType)	Traverses the hierarchy of Condition tree and returns the (first) operand matching the given alias and type.
default <T extends Operand<?>> T	Condition.toOperand(Class<T> aType)	Traverses the hierarchy of Condition tree and returns the (first) operand matching the given type.
<T extends Operand<?>> T	Condition.toOperand(String aAlias, Class<T> aType)	Traverses the hierarchy of Condition tree and returns the (first) operand matching the given alias and type.

Methods in org.refcodes.cli that return Operand

Modifier and Type	Method	Description
Operand<?>[]	ArgsParser.evalArgs(String[] aArgs)	Evaluates the provided command line arguments and determines the according values by evaluating the root Condition.
Operand<?>[]	ParseArgs.evalArgs(String[] aArgs)	Evaluates the provided command line arguments and determines the according values by evaluating the root Condition.
default Operand<?>[]	ParseArgs.evalArgs(String[] aArgs, Pattern aFilterExp)	Evaluates the provided command line arguments as of ParseArgs.evalArgs(String[]), additionally filtering (excluding) the arguments matching the provided Pattern.
default Operand<?>[]	ParseArgs.evalArgs(String[] aArgs, ArgsFilter aArgsFilter)	Evaluates the provided command line arguments as of ParseArgs.evalArgs(String[]), additionally filtering (excluding) the arguments matching the provided ArgsFilter.
default Operand<?>[]	ParseArgs.evalArgs(List<String> aArgs)	Same as ParseArgs.evalArgs(String[]) with the difference that the elements representing the arguments are passed as a list instead of an array.
default Operand<?>[]	ParseArgs.evalArgs(List<String> aArgs, Pattern aFilterExp)	Evaluates the provided command line arguments as of ParseArgs.evalArgs(String[]), additionally filtering (excluding) the arguments matching the provided Pattern.
default Operand<?>[]	ParseArgs.evalArgs(List<String> aArgs, ArgsFilter aArgsFilter)	Evaluates the provided command line arguments as of ParseArgs.evalArgs(String[]), additionally filtering (excluding) the arguments matching the provided ArgsFilter.
protected Operand<T>	ArrayOperand.getOperand()	Hook for accessing the encapsulated Operand.
Operand<?>[]	Example.getOperands()	Retrieves the command line arguments required by the example.
Operand<?>[]	AbstractOperand.parseArgs(String[] aArgs, String[] aOptions, CliContext aCliContext)	Parses the provided command line arguments and determines the according values by evaluating this Term instance or, in case of being a node in the syntax tree (such as a Condition, traversing the child Term instances' Term.parseArgs(String[], String[], CliContext) methods.
Operand<?>[]	AbstractOption.parseArgs(String[] aArgs, String[] aOptions, CliContext aCliCtx)	Parses the provided command line arguments and determines the according values by evaluating this Term instance or, in case of being a node in the syntax tree (such as a Condition, traversing the child Term instances' Term.parseArgs(String[], String[], CliContext) methods.
Operand<?>[]	AbstractPropertyOption.parseArgs(String[] aArgs, String[] aOptions, CliContext aCliCtx)	Parses the provided command line arguments and determines the according values by evaluating this Term instance or, in case of being a node in the syntax tree (such as a Condition, traversing the child Term instances' Term.parseArgs(String[], String[], CliContext) methods.
Operand<?>[]	AllCondition.parseArgs(String[] aArgs, String[] aOptions, CliContext aCliCtx)	Parses the provided command line arguments and determines the according values by evaluating this Term instance or, in case of being a node in the syntax tree (such as a Condition, traversing the child Term instances' Term.parseArgs(String[], String[], CliContext) methods.
Operand<?>[]	AndCondition.parseArgs(String[] aArgs, String[] aOptions, CliContext aCliCtx)	Parses the provided command line arguments and determines the according values by evaluating this Term instance or, in case of being a node in the syntax tree (such as a Condition, traversing the child Term instances' Term.parseArgs(String[], String[], CliContext) methods.
Operand<?>[]	AnyCondition.parseArgs(String[] aArgs, String[] aOptions, CliContext aCliCtx)	Parses the provided command line arguments and determines the according values by evaluating this Term instance or, in case of being a node in the syntax tree (such as a Condition, traversing the child Term instances' Term.parseArgs(String[], String[], CliContext) methods.
Operand<?>[]	ArrayOperand.parseArgs(String[] aArgs, String[] aOperands, CliContext aCliCtx)	Parses the provided command line arguments and determines the according values by evaluating this Term instance or, in case of being a node in the syntax tree (such as a Condition, traversing the child Term instances' Term.parseArgs(String[], String[], CliContext) methods.
Operand<Boolean>[]	Flag.parseArgs(String[] aArgs, String[] aOptions, CliContext aCliCtx)	Parses the provided command line arguments and determines the according values by evaluating this Term instance or, in case of being a node in the syntax tree (such as a Condition, traversing the child Term instances' Term.parseArgs(String[], String[], CliContext) methods.
Operand<?>[]	NoneOperand.parseArgs(String[] aArgs, String[] aOptions, CliContext aCliContext)	Parses the provided command line arguments and determines the according values by evaluating this Term instance or, in case of being a node in the syntax tree (such as a Condition, traversing the child Term instances' Term.parseArgs(String[], String[], CliContext) methods.
Operand<Boolean>[]	Operation.parseArgs(String[] aArgs, String[] aOptions, CliContext aCliContext)	Parses the provided command line arguments and determines the according values by evaluating this Term instance or, in case of being a node in the syntax tree (such as a Condition, traversing the child Term instances' Term.parseArgs(String[], String[], CliContext) methods.
Operand<?>[]	OrCondition.parseArgs(String[] aArgs, String[] aOptions, CliContext aCliCtx)	Parses the provided command line arguments and determines the according values by evaluating this Term instance or, in case of being a node in the syntax tree (such as a Condition, traversing the child Term instances' Term.parseArgs(String[], String[], CliContext) methods.
Operand<?>[]	Term.parseArgs(String[] aArgs, String[] aOptions, CliContext aCliContext)	Parses the provided command line arguments and determines the according values by evaluating this Term instance or, in case of being a node in the syntax tree (such as a Condition, traversing the child Term instances' Term.parseArgs(String[], String[], CliContext) methods.
default Operand<?>[]	Term.parseArgs(String[] aArgs, CliContext aCliCtx)	Parses the provided command line arguments and determines the according values by evaluating this Term instance or, in case of being a node in the syntax tree (such as a Condition, traversing the child Term instances' Term.parseArgs(String[], String[], CliContext) methods.
Operand<?>[]	XorCondition.parseArgs(String[] aArgs, String[] aOptions, CliContext aCliCtx)	Parses the provided command line arguments and determines the according values by evaluating this Term instance or, in case of being a node in the syntax tree (such as a Condition, traversing the child Term instances' Term.parseArgs(String[], String[], CliContext) methods.
default Operand<?>	Condition.toOperand(String aAlias)	Traverses the hierarchy of Condition tree and returns the (first) operand matching the given alias.
Operand<?>[]	AbstractCondition.toOperands()	Traverses the hierarchy of Conditions and collects all therein found Operands and sub-types such as the Flag or the Option.
Operand<?>[]	Condition.toOperands()	Traverses the hierarchy of Conditions and collects all therein found Operands and sub-types such as the Flag or the Option.
default Operand<?>[]	Condition.toOperands(String[] aArgs)	Determines the potential Operand instances matching the given args (intersection) which might be useful to get more details on failing to parse arguments (in case we have superfluous arguments and want to see which Operand addressed them).

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

Modifier and Type	Method	Description
default void	ParseArgs.addExample(String aDescription, Operand<?>... aOperands)	Adds a usage example by providing a description of the example and the command line arguments required by the example.
static <T> ArrayOperand<T>	CliSugar.asArray(Operand<T> aOperand)	Creates an array representation facade for the encapsulated Operand.
static <T> ArrayOperand<T>	CliSugar.asArray(Operand<T> aOperand, int aLength)	Creates an array representation facade for the encapsulated Operand.
static <T> ArrayOperand<T>	CliSugar.asArray(Operand<T> aOperand, int aMinLength, int aMaxLength)	Creates an array representation facade for the encapsulated Operand.
int	AbstractOperand.compareTo(Operand<?> obj)
int	ArrayOperand.compareTo(Operand<?> o)
static Example	CliSugar.example(String aDescription, Operand<?>... aOperands)	Sugar for creating an Example from a description and the according Operand elements.
String	CliContext.toArgumentSpec(Operand<?> aOperand)	Creates the argument specification from the provided Operand.
String	CliContext.toArgumentSpec(Operand<?> aOperand, int aMin, int aMax)	Creates the argument specification from the provided Operand.
ArgsParser	ArgsParser.withAddExample(String aDescription, Operand<?>... aOperands)	Builder method adding an application's Example element.
B	ArgsProcessorBuilder.withAddExample(String aDescription, Operand<?>... aOperands)	Builder method adding an application's Example element.
default ParseArgs	ParseArgs.withAddExample(String aDescription, Operand<?>... aOperands)	Builder method adding an application's Example element.

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

Modifier	Constructor	Description
	ArrayOperand(Operand<T> aOperand)	Constructs the ArrayOperand by encapsulating the given Operand and providing its definition as array definition to the CLI.
	ArrayOperand(Operand<T> aOperand, int aLength)	Constructs the ArrayOperand by encapsulating the given Operand and providing its definition as array definition to the CLI.
	ArrayOperand(Operand<T> aOperand, int aMinLength, int aMaxLength)	Constructs the ArrayOperand by encapsulating the given Operand and providing its definition as array definition to the CLI.
	Example(String aDescription, Operand<?>... aOperands)	Constructs an example usage.

Constructor parameters in org.refcodes.cli with type arguments of type Operand

Modifier	Constructor	Description
	AbstractOperand(Class<T> aType, String aAlias, String aDescription, Consumer<? extends Operand<T>> aConsumer)	Constructs an Operand with the given arguments.
	AbstractOperand(org.refcodes.struct.Relation<String,T> aProperty, Class<T> aType, Consumer<? extends Operand<T>> aConsumer)	Constructs an Operand with the given arguments.
	AbstractOption(Character aShortOption, String aLongOption, Class<T> aType, String aAlias, String aDescription, Consumer<? extends Operand<T>> aConsumer)	Constructs an AbstractOption with the given arguments.
protected	AbstractOption(Character aShortOption, String aLongOption, Class<T> aType, String aDescription, Consumer<? extends Operand<T>> aConsumer)	Constructs an AbstractOption with the given arguments.
	AbstractOption(String aLongOption, Class<T> aType, String aAlias, String aDescription, Consumer<? extends Operand<T>> aConsumer)	Constructs an AbstractOption with the given arguments.
	AbstractOption(String aLongOption, Class<T> aType, String aDescription, Consumer<? extends Operand<T>> aConsumer)	Constructs an AbstractOption with the given arguments.
	AbstractOption(org.refcodes.struct.Relation<String,T> aProperty, Class<T> aType, Consumer<? extends Operand<T>> aConsumer)	Constructs an AbstractOption with the given arguments.
	AbstractPropertyOption(Character aShortProperty, String aLongProperty, Class<T> aType, String aAlias, String aDescription, Consumer<? extends Operand<T>> aConsumer)	Constructs an AbstractPropertyOption with the given arguments.
protected	AbstractPropertyOption(Character aShortProperty, String aLongProperty, Class<T> aType, String aDescription, Consumer<? extends Operand<T>> aConsumer)	Constructs an AbstractPropertyOption with the given arguments.
	AbstractPropertyOption(String aLongProperty, Class<T> aType, String aAlias, String aDescription, Consumer<? extends Operand<T>> aConsumer)	Constructs an AbstractPropertyOption with the given arguments.
	AbstractPropertyOption(String aLongProperty, Class<T> aType, String aDescription, Consumer<? extends Operand<T>> aConsumer)	Constructs an AbstractPropertyOption with the given arguments.
	AbstractPropertyOption(org.refcodes.struct.Relation<String,T> aProperty, Class<T> aType, Consumer<? extends Operand<T>> aConsumer)	Constructs an AbstractPropertyOption with the given arguments.