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 aCliCtx)	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 aCliCtx)	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<?>[]	AbstractDirective.parseArgs(String[] aArgs, String[] aKeywords, CliContext aCliCtx)	Parses the given command line arguments using the provided keyword set and CLI context.
Operand<?>[]	AbstractOperand.parseArgs(String[] aArgs, String[] aKeywords, CliContext aCliCtx)	Parses the given command line arguments using the provided keyword set and CLI context.
Operand<?>[]	AbstractOption.parseArgs(String[] aArgs, String[] aKeywords, CliContext aCliCtx)	Parses the given command line arguments using the provided keyword set and CLI context.
Operand<?>[]	AbstractProperty.parseArgs(String[] aArgs, String[] aKeywords, CliContext aCliCtx)	Parses the given command line arguments using the provided keyword set and CLI context.
Operand<?>[]	AllCondition.parseArgs(String[] aArgs, String[] aKeywords, CliContext aCliCtx)	Parses the given command line arguments using the provided keyword set and CLI context.
Operand<?>[]	AndCondition.parseArgs(String[] aArgs, String[] aKeywords, CliContext aCliCtx)	Parses the given command line arguments using the provided keyword set and CLI context.
Operand<?>[]	AnyCondition.parseArgs(String[] aArgs, String[] aKeywords, CliContext aCliCtx)	Parses the given command line arguments using the provided keyword set and CLI context.
Operand<?>[]	ArrayOperand.parseArgs(String[] aArgs, String[] aOperands, CliContext aCliCtx)	Parses the given command line arguments using the provided keyword set and CLI context.
Operand<Boolean>[]	Flag.parseArgs(String[] aArgs, String[] aKeywords, CliContext aCliCtx)	Parses the given command line arguments using the provided keyword set and CLI context.
Operand<?>[]	NoneOperand.parseArgs(String[] aArgs, String[] aKeywords, CliContext aCliCtx)	Parses the given command line arguments using the provided keyword set and CLI context.
Operand<Boolean>[]	Operation.parseArgs(String[] aArgs, String[] aKeywords, CliContext aCliCtx)	Parses the given command line arguments using the provided keyword set and CLI context.
Operand<?>[]	OrCondition.parseArgs(String[] aArgs, String[] aKeywords, CliContext aCliCtx)	Parses the given command line arguments using the provided keyword set and CLI context.
Operand<?>[]	Term.parseArgs(String[] aArgs, String[] aKeywords, CliContext aCliCtx)	Parses the given command line arguments using the provided keyword set and CLI context.
default Operand<?>[]	Term.parseArgs(String[] aArgs, CliContext aCliCtx)	Parses the given command line arguments using the provided CLI context deriving its keyword.
Operand<?>[]	XorCondition.parseArgs(String[] aArgs, String[] aKeywords, CliContext aCliCtx)	Parses the given command line arguments using the provided keyword set and CLI context.
void	CliContextAccessor.CliContextMutator.setCliContext(CliContext aCliCtx)	Sets the CliContext for the CliContext property.
protected UnknownArgsException	AbstractOption.toException(String[] aArgs, CliContext aCliCtx)	Convenience method to create an UnknownArgsException.
String[]	ArrayOperand.toKeywords(CliContext aCliCtx)	Produces the keywords (short and/or long options, operations, commands, whatever) with the according prefix (if any) to be considered when overall parsing the command line arguments.
default String[]	Directive.toKeywords(CliContext aCliCtx)	Produces the keywords (short and/or long options, operations, commands, whatever) with the according prefix (if any) to be considered when overall parsing the command line arguments.
default String[]	Operand.toKeywords(CliContext aCliCtx)	Produces the keywords (short and/or long options, operations, commands, whatever) with the according prefix (if any) to be considered when overall parsing the command line arguments.
String[]	Operation.toKeywords(CliContext aCliCtx)	Produces the keywords (short and/or long options, operations, commands, whatever) with the according prefix (if any) to be considered when overall parsing the command line arguments.
default String[]	Option.toKeywords(CliContext aCliCtx)	Produces the keywords (short and/or long options, operations, commands, whatever) with the according prefix (if any) to be considered when overall parsing the command line arguments.
default String	Option.toLongOption(CliContext aCliCtx)	Creates the CliContext instance specific prefixed long option String from this Option by prefixing the Option's long option (as of Option.getLongOption()) with the long option prefix (as of LongOptionPrefixAccessor.getLongOptionPrefix()).
protected static org.refcodes.struct.Relation<String,String>	AbstractProperty.toPropertyArgument(String[] aArgs, String aOption, 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.
protected org.refcodes.struct.Relation<String,String>	AbstractProperty.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.
default String	Option.toShortOption(CliContext aCliCtx)	Creates the CliContext instance specific prefixed short option String from this Option by prefixing the Option's short option (as of Option.getShortOption()) with the short option prefix (as of ShortOptionPrefixAccessor.getShortOptionPrefix()).
String	ArrayOperand.toSpec(CliContext aCliCtx)	Creates a specification including its arguments.
default String	Directive.toSpec(CliContext aCliCtx)	Creates a specification including its arguments.
String	Flag.toSpec(CliContext aCliCtx)	Creates a specification including its arguments.
String	NoneOperand.toSpec(CliContext aCliCtx)	Creates a specification including its arguments.
default String	Operand.toSpec(CliContext aCliCtx)	Creates a specification including its arguments.
String	Operation.toSpec(CliContext aCliCtx)	Creates a specification including its arguments.
default String	Option.toSpec(CliContext aCliCtx)	Creates a specification including its arguments.
default String	Property.toSpec(CliContext aCliCtx)	Creates a specification including its arguments.
String	AllCondition.toSynopsis(CliContext aCliCtx)	Creates the synopsis for the syntax hierarchy.
String	AndCondition.toSynopsis(CliContext aCliCtx)	Creates the synopsis for the syntax hierarchy.
String	OrCondition.toSynopsis(CliContext aCliCtx)	Creates the synopsis for the syntax hierarchy.
String	Synopsisable.toSynopsis(CliContext aCliCtx)	Creates the synopsis for the syntax hierarchy.
default String	Term.toSynopsis(CliContext aCliCtx)	Creates the synopsis for the syntax hierarchy.
String	XorCondition.toSynopsis(CliContext aCliCtx)	Creates the synopsis for the syntax hierarchy.
String	AbstractCondition.toSyntax(CliContext aCliCtx)	Creates a syntax including its arguments.
String	AllCondition.toSyntax(CliContext aCliCtx)	Creates a syntax including its arguments.
String	AndCondition.toSyntax(CliContext aCliCtx)	Creates a syntax including its arguments.
String	AnyCondition.toSyntax(CliContext aCliCtx)	Creates a syntax including its arguments.
String	ArrayDirective.toSyntax(CliContext aCliCtx)	Creates a syntax including its arguments.
String	ArrayOperand.toSyntax(CliContext aCliCtx)	Creates a syntax including its arguments.
String	ArrayOption.toSyntax(CliContext aCliCtx)	Creates a syntax including its arguments.
default String	Directive.toSyntax(CliContext aCliCtx)	Creates a syntax including its arguments.
String	Flag.toSyntax(CliContext aCliCtx)	Creates a syntax including its arguments.
String	NoneOperand.toSyntax(CliContext aCliCtx)	Creates a syntax including its arguments.
default String	Operand.toSyntax(CliContext aCliCtx)	Creates a syntax including its arguments.
String	Operation.toSyntax(CliContext aCliCtx)	Creates a syntax including its arguments.
default String	Option.toSyntax(CliContext aCliCtx)	Creates a syntax including its arguments.
default String	Property.toSyntax(CliContext aCliCtx)	Creates a syntax including its arguments.
String	Term.toSyntax(CliContext aCliCtx)	Creates a syntax including its arguments.
String	ArrayOperand.toUsage(CliContext aCliCtx)	Creates a plain usage specification without any escape codes, helpful e.g. in human readable messages.
default String	Directive.toUsage(CliContext aCliCtx)	Creates a plain usage specification without any escape codes, helpful e.g. in human readable messages.
String	NoneOperand.toUsage(CliContext aCliCtx)	Creates a plain usage specification without any escape codes, helpful e.g. in human readable messages.
default String	Operand.toUsage(CliContext aCliCtx)	Creates a plain usage specification without any escape codes, helpful e.g. in human readable messages.
String	Operation.toUsage(CliContext aCliCtx)	Creates a plain usage specification without any escape codes, helpful e.g. in human readable messages.
default String	Option.toUsage(CliContext aCliCtx)	Creates a plain usage specification without any escape codes, helpful e.g. in human readable messages.
B	CliContextAccessor.CliContextBuilder.withCliContext(CliContext aCliCtx)	Sets the CliContext for the CliContext property.

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

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