Uses of Class
org.refcodes.cli.CliContext

Uses of CliContext in org.refcodes.cli

Methods in org.refcodes.cli that return CliContext

Modifier and Type	Method	Description
CliContext	CliContext.Builder.build()	CliContext.Builder for fluently building a CliContext instances.
CliContext	CliContextAccessor.getCliContext()	Retrieves the CliContext from the CliContext property.
default CliContext	CliContextAccessor.CliContextProperty.letCliContext(CliContext aCliContext)	This method stores and passes through the given argument, which is very useful for builder APIs: Sets the given CliContext (setter) as of CliContextAccessor.CliContextMutator.setCliContext(CliContext) and returns the very same value (getter).

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

Modifier and Type	Method	Description
default CliContext	CliContextAccessor.CliContextProperty.letCliContext(CliContext aCliContext)	This method stores and passes through the given argument, which is very useful for builder APIs: Sets the given CliContext (setter) as of CliContextAccessor.CliContextMutator.setCliContext(CliContext) and returns the very same value (getter).
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.
void	CliContextAccessor.CliContextMutator.setCliContext(CliContext aCliContext)	Sets the CliContext for the CliContext property.
protected UnknownArgsException	AbstractOption.toException(String[] aArgs, CliContext aCliCtx)	Convenience method to create an UnknownArgsException.
protected org.refcodes.struct.Relation<String,String>	AbstractPropertyOption.toPropertyArgument(String[] aArgs, CliContext aCliCtx)	Takes the Option's short-option and long-option and tries to determine that Option's value in the provided command line arguments.
String	AbstractPropertyOption.toSpec(CliContext aCliContext)	Creates a specification for this Operand, helpful e.g. in human readable messages.
default String	Operand.toSpec(CliContext aCliContext)	Creates a specification for this Operand, helpful e.g. in human readable messages.
String	AllCondition.toSynopsis(CliContext aCliCtx)	Returns the human readable (verbose) syntax of implementing class ATTENTION: As of different parenthesis settings for some notations regarding the root Term and the child Terms, the method Term.toSyntax(CliContext) is called from inside a Term hierarchy.
String	AndCondition.toSynopsis(CliContext aCliCtx)	Returns the human readable (verbose) syntax of implementing class ATTENTION: As of different parenthesis settings for some notations regarding the root Term and the child Terms, the method Term.toSyntax(CliContext) is called from inside a Term hierarchy.
String	OrCondition.toSynopsis(CliContext aCliCtx)	Returns the human readable (verbose) syntax of implementing class ATTENTION: As of different parenthesis settings for some notations regarding the root Term and the child Terms, the method Term.toSyntax(CliContext) is called from inside a Term hierarchy.
String	Synopsisable.toSynopsis(CliContext aCliCtx)	Returns the human readable (verbose) syntax of implementing class ATTENTION: As of different parenthesis settings for some notations regarding the root Term and the child Terms, the method Term.toSyntax(CliContext) is called from inside a Term hierarchy.
default String	Term.toSynopsis(CliContext aCliCtx)	Returns the human readable (verbose) syntax of implementing class ATTENTION: As of different parenthesis settings for some notations regarding the root Term and the child Terms, the method Term.toSyntax(CliContext) is called from inside a Term hierarchy.
String	XorCondition.toSynopsis(CliContext aCliCtx)	Returns the human readable (verbose) syntax of implementing class ATTENTION: As of different parenthesis settings for some notations regarding the root Term and the child Terms, the method Term.toSyntax(CliContext) is called from inside a Term hierarchy.
String	AbstractCondition.toSyntax(CliContext aCliCtx)	This method is to be called from inside the Term hierarchy; use the method Synopsisable.toSynopsis(SyntaxNotation) in case you invoke syntax retrieval from the root Term.
String	AbstractOperand.toSyntax(CliContext aCliCtx)	This method is to be called from inside the Term hierarchy; use the method Synopsisable.toSynopsis(SyntaxNotation) in case you invoke syntax retrieval from the root Term.
String	AbstractOption.toSyntax(CliContext aCliCtx)	This method is to be called from inside the Term hierarchy; use the method Synopsisable.toSynopsis(SyntaxNotation) in case you invoke syntax retrieval from the root Term.
String	AbstractPropertyOption.toSyntax(CliContext aCliCtx)	This method is to be called from inside the Term hierarchy; use the method Synopsisable.toSynopsis(SyntaxNotation) in case you invoke syntax retrieval from the root Term.
String	AllCondition.toSyntax(CliContext aCliCtx)	This method is to be called from inside the Term hierarchy; use the method Synopsisable.toSynopsis(SyntaxNotation) in case you invoke syntax retrieval from the root Term.
String	AndCondition.toSyntax(CliContext aCliCtx)	This method is to be called from inside the Term hierarchy; use the method Synopsisable.toSynopsis(SyntaxNotation) in case you invoke syntax retrieval from the root Term.
String	AnyCondition.toSyntax(CliContext aCliCtx)	This method is to be called from inside the Term hierarchy; use the method Synopsisable.toSynopsis(SyntaxNotation) in case you invoke syntax retrieval from the root Term.
String	ArrayOperand.toSyntax(CliContext aCliCtx)	This method is to be called from inside the Term hierarchy; use the method Synopsisable.toSynopsis(SyntaxNotation) in case you invoke syntax retrieval from the root Term.
String	ArrayOption.toSyntax(CliContext aCliCtx)	This method is to be called from inside the Term hierarchy; use the method Synopsisable.toSynopsis(SyntaxNotation) in case you invoke syntax retrieval from the root Term.
String	Flag.toSyntax(CliContext aCliCtx)	This method is to be called from inside the Term hierarchy; use the method Synopsisable.toSynopsis(SyntaxNotation) in case you invoke syntax retrieval from the root Term.
String	NoneOperand.toSyntax(CliContext aCliCtx)	This method is to be called from inside the Term hierarchy; use the method Synopsisable.toSynopsis(SyntaxNotation) in case you invoke syntax retrieval from the root Term.
String	Operation.toSyntax(CliContext aCliCtx)	This method is to be called from inside the Term hierarchy; use the method Synopsisable.toSynopsis(SyntaxNotation) in case you invoke syntax retrieval from the root Term.
String	Term.toSyntax(CliContext aCliCtx)	This method is to be called from inside the Term hierarchy; use the method Synopsisable.toSynopsis(SyntaxNotation) in case you invoke syntax retrieval from the root Term.
B	CliContextAccessor.CliContextBuilder.withCliContext(CliContext aCliContext)	Sets the CliContext for the CliContext property.

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

Modifier	Constructor	Description
	ArgsParser(CliContext aCliCtx)	Constructs the ParseArgs instance without any restrictions to the parsed arguments.
	ArgsParser(Term aArgsSyntax, CliContext aCliCtx)	Constructs the ParseArgs instance with the given root Condition and the default SyntaxNotation.LOGICAL.