Index (org.refcodes:refcodes-cli 3.0.9 API)

A B C D E F G H I L N O P Q R S T U V W X _
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form

A

AbstractCondition - Class in org.refcodes.cli: 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.
AbstractCondition(String, Constituent...) - Constructor for class org.refcodes.cli.AbstractCondition: Instantiates a new abstract condition.
AbstractOperand<T> - Class in org.refcodes.cli: The AbstractOperand is an abstract implementation of an Operand providing the boiler plate when implementing the Operand interface.
AbstractOperand(Class<T>, String, String) - Constructor for class org.refcodes.cli.AbstractOperand: Constructs a Operand with the given arguments.
AbstractOperand(Relation<String, T>, Class<T>) - Constructor for class org.refcodes.cli.AbstractOperand: Instantiates a new operand.
AbstractOption<T> - Class in org.refcodes.cli: The AbstractOption is an abstract implementation of an Option providing the boiler plate when implementing the Option interface.
AbstractOption(Character, String, Class<T>, String) - Constructor for class org.refcodes.cli.AbstractOption: Constructs an AbstractOption with the given arguments.
AbstractOption(Character, String, Class<T>, String, String) - Constructor for class org.refcodes.cli.AbstractOption: Constructs an AbstractOption with the given arguments.
AbstractOption(String, Class<T>, String) - Constructor for class org.refcodes.cli.AbstractOption: Constructs an AbstractOption with the given arguments.
AbstractOption(String, Class<T>, String, String) - Constructor for class org.refcodes.cli.AbstractOption: Constructs an AbstractOption with the given arguments.
AbstractOption(Relation<String, T>, Class<T>) - Constructor for class org.refcodes.cli.AbstractOption: Constructs an AbstractOption with the given arguments.
addChild(Constituent) - Method in class org.refcodes.cli.AbstractCondition: Adds the child.
addExample(String, Operand<?>...) - Method in interface org.refcodes.cli.ArgsParser: Adds a usage example by providing a description of the example and the command line arguments required by the example.
addExample(Example) - Method in interface org.refcodes.cli.ArgsParser: Adds a usage example by providing a description of the example and the command line arguments required by the example.
addExample(Example) - Method in class org.refcodes.cli.ArgsParserImpl: Adds a usage example by providing a description of the example and the command line arguments required by the example.
ALIAS - Static variable in class org.refcodes.cli.CleanFlag
ALIAS - Static variable in class org.refcodes.cli.ConfigOption
ALIAS - Static variable in class org.refcodes.cli.DaemonFlag
ALIAS - Static variable in class org.refcodes.cli.DebugFlag
ALIAS - Static variable in class org.refcodes.cli.ForceFlag
ALIAS - Static variable in class org.refcodes.cli.HelpFlag
ALIAS - Static variable in class org.refcodes.cli.InitFlag
ALIAS - Static variable in class org.refcodes.cli.QuietFlag
ALIAS - Static variable in class org.refcodes.cli.SysInfoFlag
ALIAS - Static variable in class org.refcodes.cli.VerboseFlag
all(Constituent) - Static method in class org.refcodes.cli.CliSugar: Instantiates a new AllCondition with the Constituent (Condition) instance to be nested.
AllCondition - Class in org.refcodes.cli: The AllCondition enforces that the encapsulated Constituent consumes all arguments passed via invoking its parseArgs(String[], CliContext), else a SuperfluousArgsException is thrown.
AllCondition(Constituent) - Constructor for class org.refcodes.cli.AllCondition: Instantiates a new AllCondition with the Constituent (Condition) instance to be nested.
AmbiguousArgsException - Exception in org.refcodes.cli: Thrown in case the command line arguments do not match the required syntax.
AmbiguousArgsException(String[], String) - Constructor for exception org.refcodes.cli.AmbiguousArgsException: Instantiates a new ambiguous args exception.
AmbiguousArgsException(String[], String, String) - Constructor for exception org.refcodes.cli.AmbiguousArgsException: Instantiates a new ambiguous args exception.
AmbiguousArgsException(String[], String, Throwable) - Constructor for exception org.refcodes.cli.AmbiguousArgsException: Instantiates a new ambiguous args exception.
AmbiguousArgsException(String[], String, Throwable, String) - Constructor for exception org.refcodes.cli.AmbiguousArgsException: Instantiates a new ambiguous args exception.
AmbiguousArgsException(String[], Throwable) - Constructor for exception org.refcodes.cli.AmbiguousArgsException: Instantiates a new ambiguous args exception.
AmbiguousArgsException(String[], Throwable, String) - Constructor for exception org.refcodes.cli.AmbiguousArgsException: Instantiates a new ambiguous args exception.
and(Constituent...) - Static method in class org.refcodes.cli.CliSugar: Instantiates a new AndCondition with the Constituent (Condition) instances to be nested.
AndCondition - Class in org.refcodes.cli: An AndCondition contains (represents) a list of Condition (Constituent) instances (nested by the AndCondition) of which all are to be parsed successfully as of invoking the parseArgs(String[], String[], CliContext) methods.
AndCondition(Constituent...) - Constructor for class org.refcodes.cli.AndCondition: Instantiates a new AndCondition with the Constituent (Condition) instances to be nested.
any(Constituent...) - Static method in class org.refcodes.cli.CliSugar: Instantiates a new AnyCondition with the Constituent (Condition) instances to be nested.
AnyCondition - Class in org.refcodes.cli: Any of the nested Condition conditions may match for the AnyCondition to match, e.g. all of the nested conditions are optional.
AnyCondition(Constituent...) - Constructor for class org.refcodes.cli.AnyCondition: Instantiates a new AnyCondition with the Constituent (Condition) instances to be nested.
ArgsAccessor - Interface in org.refcodes.cli: Provides an accessor for a command line arguments (short "args") array.
ArgsAccessor.ArgsMutator - Interface in org.refcodes.cli: Provides a mutator for a args property.
ArgsAccessor.ArgsProperty - Interface in org.refcodes.cli: Provides a args property.
ArgsFilter - Enum Class in org.refcodes.cli: Enumeration declaring command line argument filter.
ArgsParser - Interface in org.refcodes.cli: The ArgsParser provides means for parsing command line arguments and constructing a command line utility's help output.
ArgsParserAccessor - Interface in org.refcodes.cli: Provides an accessor for a ArgsParser property.
ArgsParserAccessor.ArgsParserBuilder> - Interface in org.refcodes.cli: Provides a builder method for a ArgsParser property returning the builder for applying multiple build operations.
ArgsParserAccessor.ArgsParserMutator - Interface in org.refcodes.cli: Provides a mutator for a ArgsParser property.
ArgsParserAccessor.ArgsParserProperty - Interface in org.refcodes.cli: Provides a ArgsParser property.
ArgsParserImpl - Class in org.refcodes.cli: A straightforward implementation of the ArgsParser interface.
ArgsParserImpl() - Constructor for class org.refcodes.cli.ArgsParserImpl: Constructs the ArgsParser instance without any restrictions to the parsed arguments.
ArgsParserImpl(CliContext) - Constructor for class org.refcodes.cli.ArgsParserImpl: Constructs the ArgsParser instance without any restrictions to the parsed arguments.
ArgsParserImpl(Constituent) - Constructor for class org.refcodes.cli.ArgsParserImpl: Constructs the ArgsParser instance with the given root Condition and the default SyntaxNotation.LOGICAL.
ArgsParserImpl(Constituent, CliContext) - Constructor for class org.refcodes.cli.ArgsParserImpl: Constructs the ArgsParser instance with the given root Condition and the default SyntaxNotation.LOGICAL.
ArgsParserMixin> - Interface in org.refcodes.cli: This mixin provides builder additions (as of the builder pattern for chained configuring method calls) for parsing command line arguments.
ArgsSyntaxAccessor - Interface in org.refcodes.cli: Provides an accessor for a root condition property.
ArgsSyntaxAccessor.ArgsSyntaxBuilder> - Interface in org.refcodes.cli: Provides a builder method for a root condition property returning the builder for applying multiple build operations.
ArgsSyntaxAccessor.ArgsSyntaxMutator - Interface in org.refcodes.cli: Provides a mutator for a root condition property.
ArgsSyntaxAccessor.ArgsSyntaxProperty - Interface in org.refcodes.cli: Provides a root condition property.
ArgsSyntaxException - Exception in org.refcodes.cli: Thrown in case of a command line arguments mismatch regarding provided and expected args.
ArgsSyntaxException(String[], String) - Constructor for exception org.refcodes.cli.ArgsSyntaxException: Instantiates a new args mismatch exception.
ArgsSyntaxException(String[], String, String) - Constructor for exception org.refcodes.cli.ArgsSyntaxException: Instantiates a new args mismatch exception.
ArgsSyntaxException(String[], String, Throwable) - Constructor for exception org.refcodes.cli.ArgsSyntaxException: Instantiates a new args mismatch exception.
ArgsSyntaxException(String[], String, Throwable, String) - Constructor for exception org.refcodes.cli.ArgsSyntaxException: Instantiates a new args mismatch exception.
ArgsSyntaxException(String[], Throwable) - Constructor for exception org.refcodes.cli.ArgsSyntaxException: Instantiates a new args mismatch exception.
ArgsSyntaxException(String[], Throwable, String) - Constructor for exception org.refcodes.cli.ArgsSyntaxException: Instantiates a new args mismatch exception.
ArgumentEscapeCodeAccessor - Interface in org.refcodes.cli: Provides an accessor for a argument Escape-Code property.
ArgumentEscapeCodeAccessor.ArgumentEscapeCodeBuilder> - Interface in org.refcodes.cli: Provides a builder method for a argument Escape-Code property returning the builder for applying multiple build operations.
ArgumentEscapeCodeAccessor.ArgumentEscapeCodeMutator - Interface in org.refcodes.cli: Provides a mutator for a argument Escape-Code property.
ArgumentEscapeCodeAccessor.ArgumentEscapeCodeProperty - Interface in org.refcodes.cli: Provides a argument Escape-Code property.
ArgumentPrefixAccessor - Interface in org.refcodes.cli: Provides an accessor for an argument prefix property.
ArgumentPrefixAccessor.ArgumentPrefixBuilder> - Interface in org.refcodes.cli: Provides a builder method for an argument prefix property returning the builder for applying multiple build operations.
ArgumentPrefixAccessor.ArgumentPrefixMutator - Interface in org.refcodes.cli: Provides a mutator for an argument prefix property.
ArgumentPrefixAccessor.ArgumentPrefixProperty - Interface in org.refcodes.cli: Provides an argument prefix property.
ArgumentSuffixAccessor - Interface in org.refcodes.cli: Provides an accessor for an argument suffix property.
ArgumentSuffixAccessor.ArgumentSuffixBuilder> - Interface in org.refcodes.cli: Provides a builder method for an argument suffix property returning the builder for applying multiple build operations.
ArgumentSuffixAccessor.ArgumentSuffixMutator - Interface in org.refcodes.cli: Provides a mutator for an argument suffix property.
ArgumentSuffixAccessor.ArgumentSuffixProperty - Interface in org.refcodes.cli: Provides an argument suffix property.
ArrayOperand<T> - Class in org.refcodes.cli: Creates an array representation facade for the encapsulated Operand.
ArrayOperand(Operand<T>) - Constructor for class org.refcodes.cli.ArrayOperand: Constructs the ArrayOperand by encapsulating the given Operand and providing its definition as array definition to the CLI.
ArrayOperand(Operand<T>, int) - Constructor for class org.refcodes.cli.ArrayOperand: Constructs the ArrayOperand by encapsulating the given Operand and providing its definition as array definition to the CLI.
ArrayOperand(Operand<T>, int, int) - Constructor for class org.refcodes.cli.ArrayOperand: Constructs the ArrayOperand by encapsulating the given Operand and providing its definition as array definition to the CLI.
ArrayOption<T> - Class in org.refcodes.cli: Creates an array representation facade for the encapsulated Option.
ArrayOption(Option<T>) - Constructor for class org.refcodes.cli.ArrayOption: Constructs the ArrayOption by encapsulating the given Option and providing its definition as array definition to the CLI.
ArrayOption(Option<T>, int) - Constructor for class org.refcodes.cli.ArrayOption: Constructs the ArrayOption by encapsulating the given Option and providing its definition as array definition to the CLI.
ArrayOption(Option<T>, int, int) - Constructor for class org.refcodes.cli.ArrayOption: Constructs the ArrayOption by encapsulating the given Option and providing its definition as array definition to the CLI.
asArray(Operand<T>) - Static method in class org.refcodes.cli.CliSugar: Creates an array representation facade for the encapsulated Operand.
asArray(Operand<T>, int) - Static method in class org.refcodes.cli.CliSugar: Creates an array representation facade for the encapsulated Operand.
asArray(Operand<T>, int, int) - Static method in class org.refcodes.cli.CliSugar: Creates an array representation facade for the encapsulated Operand.
asArray(Option<T>) - Static method in class org.refcodes.cli.CliSugar: Creates an array representation facade for the encapsulated Option.
asArray(Option<T>, int) - Static method in class org.refcodes.cli.CliSugar: Creates an array representation facade for the encapsulated Option.
asArray(Option<T>, int, int) - Static method in class org.refcodes.cli.CliSugar: Creates an array representation facade for the encapsulated Option.

B

build() - Method in class org.refcodes.cli.CliContext.Builder: CliContext.Builder for fluently building a CliContext instances.
build() - Method in class org.refcodes.cli.SyntaxMetricsImpl.Builder: SyntaxMetricsImpl.Builder for fluently building a SyntaxMetrics instances.
builder() - Static method in class org.refcodes.cli.CliContext: Creates a CliContext.Builder used to fluently construct CliContext instances.
builder() - Static method in class org.refcodes.cli.SyntaxMetricsImpl: Creates a SyntaxMetricsImpl.Builder used to fluently construct SyntaxMetrics instances.

C

cases(Constituent...) - Static method in class org.refcodes.cli.CliSugar: Instantiates a new CasesCondition with the Constituent (Condition) instances to be nested.
CasesCondition - Class in org.refcodes.cli: The CasesCondition is an XorCondition making sure that all possible cases inside the XorCondition must(!)
CasesCondition(Constituent...) - Constructor for class org.refcodes.cli.CasesCondition: Instantiates a new CasesCondition with the Constituent (Condition) instances to be nested.
charOption(Character, String, String) - Static method in class org.refcodes.cli.CliSugar: Instantiates a new CharOption with the given arguments.
charOption(Character, String, String, String) - Static method in class org.refcodes.cli.CliSugar: Instantiates a new CharOption with the given arguments.
charOption(String, String) - Static method in class org.refcodes.cli.CliSugar: Instantiates a new CharOption with the given arguments.
charOption(String, String, String) - Static method in class org.refcodes.cli.CliSugar: Instantiates a new CharOption with the given arguments.
CharOption - Class in org.refcodes.cli: The CharOption represents an Option holding String values.
CharOption(Character, String, String) - Constructor for class org.refcodes.cli.CharOption: Instantiates a new CharOption with the given arguments.
CharOption(Character, String, String, String) - Constructor for class org.refcodes.cli.CharOption: Instantiates a new CharOption with the given arguments.
CharOption(String, String) - Constructor for class org.refcodes.cli.CharOption: Instantiates a new CharOption with the given arguments.
CharOption(String, String, String) - Constructor for class org.refcodes.cli.CharOption: Instantiates a new CharOption with the given arguments.
CharOption(Relation<String, Character>) - Constructor for class org.refcodes.cli.CharOption: Instantiates a new CharOption with the alias being the proerty's key and the value being the property's value.
cleanFlag() - Static method in class org.refcodes.cli.CliSugar: Constructs the predefined clean Flag.
cleanFlag(boolean) - Static method in class org.refcodes.cli.CliSugar: Constructs the predefined clean Flag.
cleanFlag(String) - Static method in class org.refcodes.cli.CliSugar: Constructs the predefined clean Flag.
CleanFlag - Class in org.refcodes.cli: 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.
CleanFlag() - Constructor for class org.refcodes.cli.CleanFlag: Constructs the predefined clean Flag.
CleanFlag(boolean) - Constructor for class org.refcodes.cli.CleanFlag: Constructs the predefined clean Flag.
CleanFlag(String) - Constructor for class org.refcodes.cli.CleanFlag: Constructs the predefined clean Flag.
CleanFlag(String, boolean) - Constructor for class org.refcodes.cli.CleanFlag: Constructs the predefined clean Flag.
CliContext - Class in org.refcodes.cli: The CliContext describes the context in which an ArgsParser is running.
CliContext() - Constructor for class org.refcodes.cli.CliContext: Constructs an accordingly preconfigured CliContext instance.
CliContext(boolean) - Constructor for class org.refcodes.cli.CliContext: Constructs an accordingly configured CliContext instance.
CliContext(String, String, String) - Constructor for class org.refcodes.cli.CliContext: Constructs an accordingly configured CliContext instance.
CliContext(CliMetrics) - Constructor for class org.refcodes.cli.CliContext: Constructs an accordingly configured CliContext instance.
CliContext(CliMetrics, SyntaxMetrics) - Constructor for class org.refcodes.cli.CliContext: Constructs an accordingly configured CliContext instance.
CliContext(SyntaxMetrics) - Constructor for class org.refcodes.cli.CliContext: Constructs an accordingly configured CliContext instance.
CliContext(SyntaxMetrics, boolean) - Constructor for class org.refcodes.cli.CliContext: Constructs an accordingly configured CliContext instance.
CliContext(SyntaxMetrics, Character, String, boolean, String, String, String) - Constructor for class org.refcodes.cli.CliContext: Constructs an accordingly configured CliContext instance.
CliContext(SyntaxMetrics, String, String, String) - Constructor for class org.refcodes.cli.CliContext: Constructs an accordingly configured CliContext instance.
CliContext.Builder - Class in org.refcodes.cli: Builder to build SyntaxMetricsAccessor.SyntaxMetricsBuilder instances.
CliContextAccessor - Interface in org.refcodes.cli: Provides an accessor for a CliContext property.
CliContextAccessor.RootConditionBuilder> - Interface in org.refcodes.cli: Provides a builder method for a CliContext property returning the builder for applying multiple build operations.
CliContextAccessor.RootConditionMutator - Interface in org.refcodes.cli: Provides a mutator for a CliContext property.
CliContextAccessor.RootConditionProperty - Interface in org.refcodes.cli: Provides a CliContext property.
CliException - Exception in org.refcodes.cli: Base exception for the console artifact.
CliException(String) - Constructor for exception org.refcodes.cli.CliException: Instantiates a new console exception.
CliException(String, String) - Constructor for exception org.refcodes.cli.CliException: Instantiates a new console exception.
CliException(String, Throwable) - Constructor for exception org.refcodes.cli.CliException: Instantiates a new console exception.
CliException(String, Throwable, String) - Constructor for exception org.refcodes.cli.CliException: Instantiates a new console exception.
CliException(Throwable) - Constructor for exception org.refcodes.cli.CliException: Instantiates a new console exception.
CliException(Throwable, String) - Constructor for exception org.refcodes.cli.CliException: Instantiates a new console exception.
CliException.ConsoleArgsException - Exception in org.refcodes.cli: This abstract exception is the base exception for all command line argument related exceptions.
CliException.ConsoleCliException - Exception in org.refcodes.cli: The Class ConsoleCliException.
CliMetrics - Interface in org.refcodes.cli: The CliMetrics define the attributes required to parse a Constituent tree's syntax by an ArgsParser.
CliSchema - Class in org.refcodes.cli: The purpose of a CliSchema is automatically generate documentation of Constituent structures.
CliSchema(Class<?>, String) - Constructor for class org.refcodes.cli.CliSchema
CliSchema(Class<?>, String, Object) - Constructor for class org.refcodes.cli.CliSchema: Instantiates a new CliSchema.
CliSchema(Class<?>, String, Object, CliSchema...) - Constructor for class org.refcodes.cli.CliSchema: Instantiates a new CliSchema.
CliSchema(Class<?>, String, String) - Constructor for class org.refcodes.cli.CliSchema
CliSchema(Class<?>, String, String, Object) - Constructor for class org.refcodes.cli.CliSchema: Instantiates a new CliSchema.
CliSchema(Class<?>, String, String, Object, CliSchema...) - Constructor for class org.refcodes.cli.CliSchema: Instantiates a new CliSchema.
CliSchema(Class<?>, String, String, CliSchema...) - Constructor for class org.refcodes.cli.CliSchema
CliSchema(Class<?>, String, CliSchema...) - Constructor for class org.refcodes.cli.CliSchema
CliSchema(CliSchema) - Constructor for class org.refcodes.cli.CliSchema
CliSchema(CliSchema, CliSchema...) - Constructor for class org.refcodes.cli.CliSchema
CliSugar - Class in org.refcodes.cli: Declarative syntactic sugar which may be statically imported in order to allow declarative definitions for the command line Flag, Condition, Option and Operand elements.
CliSugar() - Constructor for class org.refcodes.cli.CliSugar
CliUtility - Class in org.refcodes.cli: This utility class provides method useful for the refcodes-cli artifact and whose implementation has been motivated by the implementation of the refcodes-cli artifact.
clone() - Method in class org.refcodes.cli.AbstractOperand
clone() - Method in class org.refcodes.cli.AbstractOption
clone() - Method in class org.refcodes.cli.ArrayOperand
clone() - Method in class org.refcodes.cli.Operation
compareTo(Operand<?>) - Method in class org.refcodes.cli.AbstractOperand
compareTo(Operand<?>) - Method in class org.refcodes.cli.ArrayOperand
Condition - Interface in org.refcodes.cli: The Condition interface represents a node (and therewith the syntax for the arguments) in the command line arguments syntax tree; simply extending the Constituent interface and adding the functionality of providing access to the added Operands (leafs).
configOption() - Static method in class org.refcodes.cli.CliSugar: Creates a ConfigOption representing value specifying a configuration resource (file).
configOption(String) - Static method in class org.refcodes.cli.CliSugar: Instantiates a new config (file) Option.
ConfigOption - Class in org.refcodes.cli: The ConfigOption represents an Option holding a value specifying a configuration resource (file).
ConfigOption() - Constructor for class org.refcodes.cli.ConfigOption: Constructs the predefined config (file) Option.
ConfigOption(boolean) - Constructor for class org.refcodes.cli.ConfigOption: Constructs the predefined config (file) Option.
ConfigOption(String) - Constructor for class org.refcodes.cli.ConfigOption: Instantiates a new config (file) Option.
ConfigOption(String, boolean) - Constructor for class org.refcodes.cli.ConfigOption: Constructs the predefined config (file) Option.
ConsoleArgsException(String[], String) - Constructor for exception org.refcodes.cli.CliException.ConsoleArgsException: Instantiates a new console args exception.
ConsoleArgsException(String[], String, String) - Constructor for exception org.refcodes.cli.CliException.ConsoleArgsException: Instantiates a new console args exception.
ConsoleArgsException(String[], String, Throwable) - Constructor for exception org.refcodes.cli.CliException.ConsoleArgsException: Instantiates a new console args exception.
ConsoleArgsException(String[], String, Throwable, String) - Constructor for exception org.refcodes.cli.CliException.ConsoleArgsException: Instantiates a new console args exception.
ConsoleArgsException(String[], Throwable) - Constructor for exception org.refcodes.cli.CliException.ConsoleArgsException: Instantiates a new console args exception.
ConsoleArgsException(String[], Throwable, String) - Constructor for exception org.refcodes.cli.CliException.ConsoleArgsException: Instantiates a new console args exception.
ConsoleCliException(ExitCode, String) - Constructor for exception org.refcodes.cli.CliException.ConsoleCliException: Instantiates a new console cli exception.
ConsoleCliException(ExitCode, String, String) - Constructor for exception org.refcodes.cli.CliException.ConsoleCliException: Instantiates a new console cli exception.
ConsoleCliException(ExitCode, String, Throwable) - Constructor for exception org.refcodes.cli.CliException.ConsoleCliException: Instantiates a new console cli exception.
ConsoleCliException(ExitCode, String, Throwable, String) - Constructor for exception org.refcodes.cli.CliException.ConsoleCliException: Instantiates a new console cli exception.
ConsoleCliException(ExitCode, Throwable) - Constructor for exception org.refcodes.cli.CliException.ConsoleCliException: Instantiates a new console cli exception.
ConsoleCliException(ExitCode, Throwable, String) - Constructor for exception org.refcodes.cli.CliException.ConsoleCliException: Instantiates a new console cli exception.
Constituent - Interface in org.refcodes.cli: A Constituent defines the methods at least required when building a command line arguments syntax tree for traversing the syntax tree; either for parsing command line arguments or for constructing the command line arguments syntax.
contains(String[], String) - Static method in class org.refcodes.cli.AbstractOption: Determines whether a given String is contained in the given String array.

D

D - Enum constant in enum class org.refcodes.cli.ArgsFilter: Java system properties are to be filtered.
D_XX - Enum constant in enum class org.refcodes.cli.ArgsFilter: Matches ArgsFilter.D as well as ArgsFilter.XX.
daemonFlag() - Static method in class org.refcodes.cli.CliSugar: Constructs the predefined daemon Flag.
daemonFlag(boolean) - Static method in class org.refcodes.cli.CliSugar: Constructs the predefined daemon Flag.
daemonFlag(String) - Static method in class org.refcodes.cli.CliSugar: Constructs the predefined daemon Flag.
DaemonFlag - Class in org.refcodes.cli: 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.
DaemonFlag() - Constructor for class org.refcodes.cli.DaemonFlag: Constructs the predefined daemon Flag.
DaemonFlag(boolean) - Constructor for class org.refcodes.cli.DaemonFlag: Constructs the predefined daemon Flag.
DaemonFlag(String) - Constructor for class org.refcodes.cli.DaemonFlag: Constructs the predefined daemon Flag.
DaemonFlag(String, boolean) - Constructor for class org.refcodes.cli.DaemonFlag: Constructs the predefined daemon Flag.
debugFlag() - Static method in class org.refcodes.cli.CliSugar: Constructs the predefined debug Flag.
debugFlag(boolean) - Static method in class org.refcodes.cli.CliSugar: Constructs the predefined debug Flag.
debugFlag(String) - Static method in class org.refcodes.cli.CliSugar: Constructs the predefined debug Flag.
DebugFlag - Class in org.refcodes.cli: 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.
DebugFlag() - Constructor for class org.refcodes.cli.DebugFlag: Constructs the predefined debug Flag.
DebugFlag(boolean) - Constructor for class org.refcodes.cli.DebugFlag: Constructs the predefined debug Flag.
DebugFlag(String) - Constructor for class org.refcodes.cli.DebugFlag: Constructs the predefined debug Flag.
DebugFlag(String, boolean) - Constructor for class org.refcodes.cli.DebugFlag: Constructs the predefined debug Flag.
doubleOption(Character, String, String) - Static method in class org.refcodes.cli.CliSugar: Instantiates a new DoubleOption with the given arguments.
doubleOption(Character, String, String, String) - Static method in class org.refcodes.cli.CliSugar: Instantiates a new DoubleOption with the given arguments.
doubleOption(String, String) - Static method in class org.refcodes.cli.CliSugar: Instantiates a new DoubleOption with the given arguments.
doubleOption(String, String, String) - Static method in class org.refcodes.cli.CliSugar: Instantiates a new DoubleOption with the given arguments.
DoubleOption - Class in org.refcodes.cli: The DoubleOption represents an Option holding double values.
DoubleOption(Character, String, String) - Constructor for class org.refcodes.cli.DoubleOption: Instantiates a new DoubleOption with the given arguments.
DoubleOption(Character, String, String, String) - Constructor for class org.refcodes.cli.DoubleOption: Instantiates a new DoubleOption with the given arguments.
DoubleOption(String, String) - Constructor for class org.refcodes.cli.DoubleOption: Instantiates a new DoubleOption with the given arguments.
DoubleOption(String, String, String) - Constructor for class org.refcodes.cli.DoubleOption: Instantiates a new DoubleOption with the given arguments.
DoubleOption(Relation<String, Double>) - Constructor for class org.refcodes.cli.DoubleOption: Instantiates a new DoubleOption with the alias being the proerty's key and the value being the property's value.

E

enumOption(Character, String, Class<T>, String) - Static method in class org.refcodes.cli.CliSugar: Instantiates a new EnumOption with the given arguments.
enumOption(Character, String, Class<T>, String, String) - Static method in class org.refcodes.cli.CliSugar: Instantiates a new EnumOption with the given arguments.
enumOption(String, Class<T>, String) - Static method in class org.refcodes.cli.CliSugar: Instantiates a new EnumOption with the given arguments.
enumOption(String, Class<T>, String, String) - Static method in class org.refcodes.cli.CliSugar: Instantiates a new EnumOption with the given arguments.
EnumOption<T extends Enum<T>> - Class in org.refcodes.cli: The EnumOption represents an Option of enumeration types.
EnumOption(Character, String, Class<T>, String) - Constructor for class org.refcodes.cli.EnumOption: Instantiates a new EnumOption with the given arguments.
EnumOption(Character, String, Class<T>, String, String) - Constructor for class org.refcodes.cli.EnumOption: Instantiates a new EnumOption with the given arguments.
EnumOption(String, Class<T>, String) - Constructor for class org.refcodes.cli.EnumOption: Instantiates a new EnumOption with the given arguments.
EnumOption(String, Class<T>, String, String) - Constructor for class org.refcodes.cli.EnumOption: Instantiates a new EnumOption with the given arguments.
EnumOption(Relation<String, T>, Class<T>) - Constructor for class org.refcodes.cli.EnumOption: Instantiates a new EnumOption with the alias being the proerty's key and the value being the property's value.
errorLn(String) - Method in interface org.refcodes.cli.ArgsParser: Prints the given line to standard error with regards to the console width as specified by the ArgsParser.withConsoleWidth(int) method.
errorLn(String) - Method in class org.refcodes.cli.ArgsParserImpl: Prints the given line to standard error with regards to the console width as specified by the ArgsParser.withConsoleWidth(int) method.
evalArgs(String[]) - Method in interface org.refcodes.cli.ArgsParser: Evaluates the provided command line arguments and determines the according values by evaluating the root Condition.
evalArgs(String[]) - Method in class org.refcodes.cli.ArgsParserImpl: Evaluates the provided command line arguments and determines the according values by evaluating the root Condition.
evalArgs(String[], Pattern) - Method in interface org.refcodes.cli.ArgsParser: Evaluates the provided command line arguments, filtering (excluding) the arguments matching the provided Pattern.
evalArgs(String[], ArgsFilter) - Method in interface org.refcodes.cli.ArgsParser: Evaluates the provided command line arguments, filtering (excluding) the arguments matching the provided ArgsFilter.
evalArgs(List<String>) - Method in interface org.refcodes.cli.ArgsParser: Same as ArgsParser.evalArgs(String[]) with the difference that the elements representing the arguments are passed as a list instead of an array.
evalArgs(List<String>, Pattern) - Method in interface org.refcodes.cli.ArgsParser: Evaluates the provided command line arguments, filtering (excluding) the arguments matching the provided Pattern.
evalArgs(List<String>, ArgsFilter) - Method in interface org.refcodes.cli.ArgsParser: Evaluates the provided command line arguments, filtering (excluding) the arguments matching the provided ArgsFilter.
example(String, Operand<?>...) - Static method in class org.refcodes.cli.CliSugar: Sugar for creating an Example from a description and the according Operand elements.
Example - Class in org.refcodes.cli: An example usage item describing a usage scenario.
Example(String, Operand<?>...) - Constructor for class org.refcodes.cli.Example: Constructs an example usage.
examples(Example...) - Static method in class org.refcodes.cli.CliSugar: Sugar for creating an Example array from a varargs argument.

F

fileOption(Character, String, String) - Static method in class org.refcodes.cli.CliSugar: Instantiates a new FileOption with the given arguments.
fileOption(Character, String, String, String) - Static method in class org.refcodes.cli.CliSugar: Instantiates a new FileOption with the given arguments.
fileOption(String, String) - Static method in class org.refcodes.cli.CliSugar: Instantiates a new FileOption with the given arguments.
fileOption(String, String, String) - Static method in class org.refcodes.cli.CliSugar: Instantiates a new FileOption with the given arguments.
FileOption - Class in org.refcodes.cli: The FileOption represents an Option holding File values.
FileOption(Character, String, String) - Constructor for class org.refcodes.cli.FileOption: Instantiates a new FileOption with the given arguments.
FileOption(Character, String, String, String) - Constructor for class org.refcodes.cli.FileOption: Instantiates a new FileOption with the given arguments.
FileOption(String, String) - Constructor for class org.refcodes.cli.FileOption: Instantiates a new FileOption with the given arguments.
FileOption(String, String, String) - Constructor for class org.refcodes.cli.FileOption: Instantiates a new FileOption with the given arguments.
FileOption(Relation<String, File>) - Constructor for class org.refcodes.cli.FileOption: Instantiates a new FileOption with the alias being the proerty's key and the value being the property's value.
flag(Character, String, String) - Static method in class org.refcodes.cli.CliSugar: Instantiates a new Flag with the given arguments.
flag(Character, String, String, String) - Static method in class org.refcodes.cli.CliSugar: Instantiates a new Flag with the given arguments.
flag(String, String) - Static method in class org.refcodes.cli.CliSugar: Instantiates a new Flag with the given arguments.
flag(String, String, String) - Static method in class org.refcodes.cli.CliSugar: Instantiates a new Flag with the given arguments.
Flag - Class in org.refcodes.cli: 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().
Flag(Character, String, String) - Constructor for class org.refcodes.cli.Flag: Instantiates a new Flag with the given arguments.
Flag(Character, String, String, String) - Constructor for class org.refcodes.cli.Flag: Instantiates a new Flag with the given arguments.
Flag(String, String) - Constructor for class org.refcodes.cli.Flag: Instantiates a new Flag with the given arguments.
Flag(String, String, String) - Constructor for class org.refcodes.cli.Flag: Instantiates a new Flag with the given arguments.
Flag(Relation<String, Boolean>) - Constructor for class org.refcodes.cli.Flag: Instantiates a new Flag with the alias being the proerty's key and the value being the property's value.
floatOption(Character, String, String) - Static method in class org.refcodes.cli.CliSugar: Instantiates a new FloatOption with the given arguments.
floatOption(Character, String, String, String) - Static method in class org.refcodes.cli.CliSugar: Instantiates a new FloatOption with the given arguments.
floatOption(String, String) - Static method in class org.refcodes.cli.CliSugar: Instantiates a new FloatOption with the given arguments.
floatOption(String, String, String) - Static method in class org.refcodes.cli.CliSugar: Instantiates a new FloatOption with the given arguments.
FloatOption - Class in org.refcodes.cli: The FloatOption represents an Option holding float values.
FloatOption(Character, String, String) - Constructor for class org.refcodes.cli.FloatOption: Instantiates a new FloatOption with the given arguments.
FloatOption(Character, String, String, String) - Constructor for class org.refcodes.cli.FloatOption: Instantiates a new FloatOption with the given arguments.
FloatOption(String, String) - Constructor for class org.refcodes.cli.FloatOption: Instantiates a new FloatOption with the given arguments.
FloatOption(String, String, String) - Constructor for class org.refcodes.cli.FloatOption: Instantiates a new FloatOption with the given arguments.
FloatOption(Relation<String, Float>) - Constructor for class org.refcodes.cli.FloatOption: Instantiates a new FloatOption with the alias being the proerty's key and the value being the property's value.
forceFlag() - Static method in class org.refcodes.cli.CliSugar: Constructs the predefined force Flag.
forceFlag(boolean) - Static method in class org.refcodes.cli.CliSugar: Constructs the predefined force Flag.
forceFlag(String) - Static method in class org.refcodes.cli.CliSugar: Constructs the predefined force Flag.
ForceFlag - Class in org.refcodes.cli: 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.
ForceFlag() - Constructor for class org.refcodes.cli.ForceFlag: Constructs the predefined force Flag.
ForceFlag(boolean) - Constructor for class org.refcodes.cli.ForceFlag: Constructs the predefined force Flag.
ForceFlag(String) - Constructor for class org.refcodes.cli.ForceFlag: Constructs the predefined force Flag.
fromArgs(String[], char) - Static method in class org.refcodes.cli.ArgsParserImpl: Heuristically loads the arguments without any syntax required, e.g.
fromFilter(String[]) - Method in enum class org.refcodes.cli.ArgsFilter: Filters the provided args by including the args matching this enumerations criteria.
fromFilter(String[], Pattern) - Static method in enum class org.refcodes.cli.ArgsFilter: Filters the provided args by including the args matching the provided Pattern (opposite of ArgsFilter.toFiltered(String[], Pattern).
fromFilter(List<String>) - Method in enum class org.refcodes.cli.ArgsFilter: Filters the provided args by including the args matching this enumerations criteria.
fromFilter(List<String>, Pattern) - Static method in enum class org.refcodes.cli.ArgsFilter: Filters the provided args by including the args matching the provided Pattern (opposite of ArgsFilter.toFiltered(List, Pattern).

G

getAlias() - Method in class org.refcodes.cli.AbstractOperand: Retrieves the name (alias) of the parameter value which can be the name of the operand (Operand) or the option argument (Option), depending on the sub-type inheriting from this interface.
getAlias() - Method in class org.refcodes.cli.ArrayOperand: Retrieves the name (alias) of the parameter value which can be the name of the operand (Operand) or the option argument (Option), depending on the sub-type inheriting from this interface.
getAlias() - Method in class org.refcodes.cli.CliSchema
getAlias() - Method in interface org.refcodes.cli.Operand: Retrieves the name (alias) of the parameter value which can be the name of the operand (Operand) or the option argument (Option), depending on the sub-type inheriting from this interface.
getAllSymbol() - Method in interface org.refcodes.cli.SyntaxMetrics: Retrieves the symbol for representing an ALL condition.
getAllSymbol() - Method in class org.refcodes.cli.SyntaxMetricsImpl: Retrieves the symbol for representing an ALL condition.
getAllSymbol() - Method in enum class org.refcodes.cli.SyntaxNotation: Retrieves the symbol for representing an ALL condition.
getAndSymbol() - Method in interface org.refcodes.cli.SyntaxMetrics: Retrieves the symbol for representing an AND condition.
getAndSymbol() - Method in class org.refcodes.cli.SyntaxMetricsImpl: Retrieves the symbol for representing an AND condition.
getAndSymbol() - Method in enum class org.refcodes.cli.SyntaxNotation: Retrieves the symbol for representing an AND condition.
getAnySymbol() - Method in interface org.refcodes.cli.SyntaxMetrics: Retrieves the symbol for representing an OPTIONAL condition.
getAnySymbol() - Method in class org.refcodes.cli.SyntaxMetricsImpl: Retrieves the symbol for representing an OPTIONAL condition.
getAnySymbol() - Method in enum class org.refcodes.cli.SyntaxNotation: Retrieves the symbol for representing an OPTIONAL condition.
getArgsParser() - Method in interface org.refcodes.cli.ArgsParserAccessor: Retrieves the args-parser from the ArgsParser property.
getArgsSyntax() - Method in interface org.refcodes.cli.ArgsParser: The root condition is the starting point node of a Constituent hierarchy to be traversed when determining the syntax for command line arguments or when evaluating the command line arguments.
getArgsSyntax() - Method in class org.refcodes.cli.ArgsParserImpl: The root condition is the starting point node of a Constituent hierarchy to be traversed when determining the syntax for command line arguments or when evaluating the command line arguments.
getArgsSyntax() - Method in interface org.refcodes.cli.ArgsSyntaxAccessor: Retrieves the root condition from the root condition property.
getArgumentEscapeCode() - Method in interface org.refcodes.cli.ArgsParser: Retrieves the parameter Escape-Code from the parameter Escape-Code property.
getArgumentEscapeCode() - Method in class org.refcodes.cli.ArgsParserImpl: Retrieves the parameter Escape-Code from the parameter Escape-Code property.
getArgumentEscapeCode() - Method in interface org.refcodes.cli.ArgumentEscapeCodeAccessor: Retrieves the argument Escape-Code from the argument Escape-Code property.
getArgumentEscapeCode() - Method in class org.refcodes.cli.CliContext: Retrieves the argument Escape-Code from the argument Escape-Code property.
getArgumentPrefix() - Method in interface org.refcodes.cli.ArgumentPrefixAccessor: Retrieves the argument prefix from the argument prefix property.
getArgumentPrefix() - Method in class org.refcodes.cli.SyntaxMetricsImpl: Retrieves the argument prefix from the argument prefix property.
getArgumentPrefix() - Method in enum class org.refcodes.cli.SyntaxNotation: Retrieves the argument prefix from the argument prefix property.
getArgumentSuffix() - Method in interface org.refcodes.cli.ArgumentSuffixAccessor: Retrieves the argument suffix from the argument suffix property.
getArgumentSuffix() - Method in class org.refcodes.cli.SyntaxMetricsImpl: Retrieves the argument suffix from the argument suffix property.
getArgumentSuffix() - Method in enum class org.refcodes.cli.SyntaxNotation: Retrieves the argument suffix from the argument suffix property.
getBannerBorderEscapeCode() - Method in interface org.refcodes.cli.ArgsParser: Retrieves the banner's border Escape-Code from the banner border Escape-Code property.
getBannerBorderEscapeCode() - Method in class org.refcodes.cli.ArgsParserImpl: Retrieves the banner's border Escape-Code from the banner border Escape-Code property.
getBannerEscapeCode() - Method in interface org.refcodes.cli.ArgsParser: Retrieves the banner's content Escape-Code from the banner Escape-Code property.
getBannerEscapeCode() - Method in class org.refcodes.cli.ArgsParserImpl: Retrieves the banner's content Escape-Code from the banner Escape-Code property.
getBeginArraySymbol() - Method in interface org.refcodes.cli.SyntaxMetrics: Retrieves the symbol representing the beginning of an array, e.g. an opening square brace.
getBeginArraySymbol() - Method in class org.refcodes.cli.SyntaxMetricsImpl: Retrieves the symbol representing the beginning of an array, e.g. an opening square brace.
getBeginArraySymbol() - Method in enum class org.refcodes.cli.SyntaxNotation: Retrieves the symbol representing the beginning of an array, e.g. an opening square brace.
getBeginListSymbol() - Method in interface org.refcodes.cli.SyntaxMetrics: Retrieves the symbol representing the beginning of a list, e.g. an opening brace.
getBeginListSymbol() - Method in class org.refcodes.cli.SyntaxMetricsImpl: Retrieves the symbol representing the beginning of a list, e.g. an opening brace.
getBeginListSymbol() - Method in enum class org.refcodes.cli.SyntaxNotation: Retrieves the symbol representing the beginning of a list, e.g. an opening brace.
getBeginOptionalSymbol() - Method in interface org.refcodes.cli.SyntaxMetrics: Retrieves the symbol representing the beginning of optional elements, e.g. an opening square brace.
getBeginOptionalSymbol() - Method in class org.refcodes.cli.SyntaxMetricsImpl: Retrieves the symbol representing the beginning of optional elements, e.g. an opening square brace.
getBeginOptionalSymbol() - Method in enum class org.refcodes.cli.SyntaxNotation: Retrieves the symbol representing the beginning of optional elements, e.g. an opening square brace.
getBeginRangeSymbol() - Method in interface org.refcodes.cli.SyntaxMetrics: Retrieves the symbol representing the beginning of a range, e.g. an opening curly brace.
getBeginRangeSymbol() - Method in class org.refcodes.cli.SyntaxMetricsImpl: Retrieves the symbol representing the beginning of a range, e.g. an opening curly brace.
getBeginRangeSymbol() - Method in enum class org.refcodes.cli.SyntaxNotation: Retrieves the symbol representing the beginning of a range, e.g. an opening curly brace.
getChildren() - Method in class org.refcodes.cli.AbstractCondition: Gets the children.
getCliContext() - Method in interface org.refcodes.cli.CliContextAccessor: Retrieves the CliContext from the CliContext property.
getCommandEscapeCode() - Method in interface org.refcodes.cli.ArgsParser: Retrieves the command name's (CLI executable) Escape-Code from the command name Escape-Code property.
getCommandEscapeCode() - Method in class org.refcodes.cli.ArgsParserImpl: Retrieves the command name's (CLI executable) Escape-Code from the command name Escape-Code property.
getCopyrightNote() - Method in interface org.refcodes.cli.ArgsParser: Retrieves the copyright.
getCopyrightNote() - Method in class org.refcodes.cli.ArgsParserImpl: Retrieves the copyright.
getDelimiter() - Method in class org.refcodes.cli.ArgsParserImpl: Returns the delimiter to be used by colliding command line args when creating non colliding arg's aliases (keys for key/value-pairs).
getDescription() - Method in class org.refcodes.cli.AbstractCondition
getDescription() - Method in interface org.refcodes.cli.ArgsParser: Retrieves the description.
getDescription() - Method in class org.refcodes.cli.ArgsParserImpl: Retrieves the description.
getDescription() - Method in class org.refcodes.cli.ArrayOperand
getDescription() - Method in class org.refcodes.cli.CliSchema
getDescription() - Method in class org.refcodes.cli.Example
getDescriptionEscapeCode() - Method in interface org.refcodes.cli.ArgsParser: Retrieves the parameter's description Escape-Code from the parameter's description Escape-Code property.
getDescriptionEscapeCode() - Method in class org.refcodes.cli.ArgsParserImpl: Retrieves the parameter's description Escape-Code from the parameter's description Escape-Code property.
getEmptySymbol() - Method in interface org.refcodes.cli.SyntaxMetrics: Retrieves the symbol for representing an EMPTY condition (no args).
getEmptySymbol() - Method in class org.refcodes.cli.SyntaxMetricsImpl: Retrieves the symbol for representing an EMPTY condition (no args).
getEmptySymbol() - Method in enum class org.refcodes.cli.SyntaxNotation: Retrieves the symbol for representing an EMPTY condition (no args).
getEndArraySymbol() - Method in interface org.refcodes.cli.SyntaxMetrics: Retrieves the symbol representing the end of an array, e.g. a closing square brace.
getEndArraySymbol() - Method in class org.refcodes.cli.SyntaxMetricsImpl: Retrieves the symbol representing the end of an array, e.g. a closing square brace.
getEndArraySymbol() - Method in enum class org.refcodes.cli.SyntaxNotation: Retrieves the symbol representing the end of an array, e.g. a closing square brace.
getEndListSymbol() - Method in interface org.refcodes.cli.SyntaxMetrics: Retrieves the symbol representing the end of a list, e.g. a closing brace.
getEndListSymbol() - Method in class org.refcodes.cli.SyntaxMetricsImpl: Retrieves the symbol representing the end of a list, e.g. a closing brace.
getEndListSymbol() - Method in enum class org.refcodes.cli.SyntaxNotation: Retrieves the symbol representing the end of a list, e.g. a closing brace.
getEndOptionalSymbol() - Method in interface org.refcodes.cli.SyntaxMetrics: Retrieves the symbol representing the end of optional elements, e.g. a closing square brace.
getEndOptionalSymbol() - Method in class org.refcodes.cli.SyntaxMetricsImpl: Retrieves the symbol representing the end of optional elements, e.g. a closing square brace.
getEndOptionalSymbol() - Method in enum class org.refcodes.cli.SyntaxNotation: Retrieves the symbol representing the end of optional elements, e.g. a closing square brace.
getEndRangeSymbol() - Method in interface org.refcodes.cli.SyntaxMetrics: Retrieves the symbol representing the end of a range, e.g. a closing curly brace.
getEndRangeSymbol() - Method in class org.refcodes.cli.SyntaxMetricsImpl: Retrieves the symbol representing the end of a range, e.g. a closing curly brace.
getEndRangeSymbol() - Method in enum class org.refcodes.cli.SyntaxNotation: Retrieves the symbol representing the end of a range, e.g. a closing curly brace.
getExamples() - Method in interface org.refcodes.cli.ArgsParser: Retrieves the Example instances as added using ArgsParser.addExample(String, Operand...).
getExamples() - Method in class org.refcodes.cli.ArgsParserImpl: Retrieves the Example instances as added using ArgsParser.addExample(String, Operand...).
getFilter() - Method in enum class org.refcodes.cli.ArgsFilter: Returns the args Pattern used to filter (exclude) the according args.
getFirst() - Method in class org.refcodes.cli.AbstractCondition: Gets the first child.
getIntervalSymbol() - Method in interface org.refcodes.cli.SyntaxMetrics: Retrieves the symbol representing an interval, e.g. "..." or "-".
getIntervalSymbol() - Method in class org.refcodes.cli.SyntaxMetricsImpl: Retrieves the symbol representing an interval, e.g. "..." or "-".
getIntervalSymbol() - Method in enum class org.refcodes.cli.SyntaxNotation: Retrieves the symbol representing an interval, e.g. "..." or "-".
getLicenseNote() - Method in interface org.refcodes.cli.ArgsParser: Retrieves the license.
getLicenseNote() - Method in class org.refcodes.cli.ArgsParserImpl: Retrieves the license.
getLineSeparatorEscapeCode() - Method in interface org.refcodes.cli.ArgsParser: Retrieves the line separator Escape-Code from the line separator Escape-Code property.
getLineSeparatorEscapeCode() - Method in class org.refcodes.cli.ArgsParserImpl: Retrieves the line separator Escape-Code from the line separator Escape-Code property.
getLongOption() - Method in class org.refcodes.cli.AbstractOption: Returns the long-option representing an Option instance.
getLongOption() - Method in class org.refcodes.cli.ArrayOption: Returns the long-option representing an Option instance.
getLongOption() - Method in interface org.refcodes.cli.Option: Returns the long-option representing an Option instance.
getLongOptionPrefix() - Method in class org.refcodes.cli.ArgsParserImpl: Retrieves the long option prefix from the long option prefix property.
getLongOptionPrefix() - Method in interface org.refcodes.cli.LongOptionPrefixAccessor: Retrieves the long option prefix from the long option prefix property.
getLongOptionPrefix() - Method in class org.refcodes.cli.SyntaxMetricsImpl: Retrieves the long option prefix from the long option prefix property.
getLongOptionPrefix() - Method in enum class org.refcodes.cli.SyntaxNotation: Retrieves the long option prefix from the long option prefix property.
getMaxLength() - Method in class org.refcodes.cli.ArrayOperand: Retrieves the maximum number of array elements to be present, e.g.
getMinLength() - Method in class org.refcodes.cli.ArrayOperand: Retrieves the minimum number of array elements to be present, e.g.
getName() - Method in class org.refcodes.cli.ArgsParserImpl
getOperand() - Method in class org.refcodes.cli.ArrayOperand: Hook for accessing the encapsulated Operand.
getOperands() - Method in class org.refcodes.cli.Example: Retrieves the command line arguments required by the example.
getOperation() - Method in class org.refcodes.cli.Operation: Returns the operation's name.
getOptionEscapeCode() - Method in interface org.refcodes.cli.ArgsParser: Retrieves the option Escape-Code from the option Escape-Code property.
getOptionEscapeCode() - Method in class org.refcodes.cli.ArgsParserImpl: Retrieves the option Escape-Code from the option Escape-Code property.
getOptionEscapeCode() - Method in class org.refcodes.cli.CliContext: Retrieves the option Escape-Code from the option Escape-Code property.
getOptionEscapeCode() - Method in interface org.refcodes.cli.OptionEscapeCodeAccessor: Retrieves the option Escape-Code from the option Escape-Code property.
getOrSymbol() - Method in interface org.refcodes.cli.SyntaxMetrics: Retrieves the symbol for representing an OR condition.
getOrSymbol() - Method in class org.refcodes.cli.SyntaxMetricsImpl: Retrieves the symbol for representing an OR condition.
getOrSymbol() - Method in enum class org.refcodes.cli.SyntaxNotation: Retrieves the symbol for representing an OR condition.
getResetEscapeCode() - Method in class org.refcodes.cli.ArgsParserImpl
getResetEscapeCode() - Method in class org.refcodes.cli.CliContext
getSeparatorLnChar() - Method in interface org.refcodes.cli.ArgsParser: Gets the character to be used when printing a separator line with the ArgsParser.printSeparatorLn() method.
getSeparatorLnChar() - Method in class org.refcodes.cli.ArgsParserImpl: Gets the character to be used when printing a separator line with the ArgsParser.printSeparatorLn() method.
getShortOption() - Method in class org.refcodes.cli.AbstractOption: Returns the short-option representing an Option instance.
getShortOption() - Method in class org.refcodes.cli.ArrayOption: Returns the short-option representing an Option instance.
getShortOption() - Method in interface org.refcodes.cli.Option: Returns the short-option representing an Option instance.
getShortOptionPrefix() - Method in class org.refcodes.cli.ArgsParserImpl: Retrieves the short option prefix from the short option prefix property.
getShortOptionPrefix() - Method in interface org.refcodes.cli.ShortOptionPrefixAccessor: Retrieves the short option prefix from the short option prefix property.
getShortOptionPrefix() - Method in class org.refcodes.cli.SyntaxMetricsImpl: Retrieves the short option prefix from the short option prefix property.
getShortOptionPrefix() - Method in enum class org.refcodes.cli.SyntaxNotation: Retrieves the short option prefix from the short option prefix property.
getStatusCode() - Method in exception org.refcodes.cli.CliException.ConsoleCliException: Gets the status code.
getSyntaxMetrics() - Method in class org.refcodes.cli.ArgsParserImpl: Retrieves the SyntaxMetrics from the SyntaxMetrics property.
getSyntaxMetrics() - Method in class org.refcodes.cli.CliContext: Retrieves the SyntaxMetrics from the SyntaxMetrics property.
getSyntaxMetrics() - Method in interface org.refcodes.cli.SyntaxMetricsAccessor: Retrieves the SyntaxMetrics from the SyntaxMetrics property.
getTextBoxGrid() - Method in class org.refcodes.cli.ArgsParserImpl
getTitle() - Method in class org.refcodes.cli.ArgsParserImpl
getType() - Method in class org.refcodes.cli.AbstractOperand
getType() - Method in class org.refcodes.cli.ArrayOperand
getValue() - Method in class org.refcodes.cli.AbstractOperand
getValue() - Method in class org.refcodes.cli.ArrayOperand
getValue() - Method in class org.refcodes.cli.CliSchema
getValue() - Method in interface org.refcodes.cli.Operand
getXorSymbol() - Method in interface org.refcodes.cli.SyntaxMetrics: Retrieves the symbol for representing an XOR condition.
getXorSymbol() - Method in class org.refcodes.cli.SyntaxMetricsImpl: Retrieves the symbol for representing an XOR condition.
getXorSymbol() - Method in enum class org.refcodes.cli.SyntaxNotation: Retrieves the symbol for representing an XOR condition.
GNU_POSIX - Enum constant in enum class org.refcodes.cli.SyntaxNotation: A syntax notation derived from GNU and POSIX utility conventions and utility argument syntax.

H

hasValue() - Method in interface org.refcodes.cli.Operand: When being parsed via the parseArgs(String[], String[], CliContext) method, use this method to determine whether the Operand.getValue() method contains parsed value.
helpFlag() - Static method in class org.refcodes.cli.CliSugar: Constructs the predefined help Flag.
helpFlag(boolean) - Static method in class org.refcodes.cli.CliSugar: Constructs the predefined help Flag.
helpFlag(String) - Static method in class org.refcodes.cli.CliSugar: Constructs the predefined help Flag.
HelpFlag - Class in org.refcodes.cli: 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.
HelpFlag() - Constructor for class org.refcodes.cli.HelpFlag: Constructs the predefined help Flag.
HelpFlag(boolean) - Constructor for class org.refcodes.cli.HelpFlag: Constructs the predefined help Flag.
HelpFlag(String) - Constructor for class org.refcodes.cli.HelpFlag: Constructs the predefined help Flag.
HelpFlag(String, boolean) - Constructor for class org.refcodes.cli.HelpFlag: Constructs the predefined help Flag.

I

initFlag() - Static method in class org.refcodes.cli.CliSugar: Constructs the predefined init Flag.
initFlag(boolean) - Static method in class org.refcodes.cli.CliSugar: Constructs the predefined init Flag.
initFlag(String) - Static method in class org.refcodes.cli.CliSugar: Constructs the predefined init Flag.
InitFlag - Class in org.refcodes.cli: 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.
InitFlag() - Constructor for class org.refcodes.cli.InitFlag: Constructs the predefined init Flag.
InitFlag(boolean) - Constructor for class org.refcodes.cli.InitFlag: Constructs the predefined init Flag.
InitFlag(String) - Constructor for class org.refcodes.cli.InitFlag: Constructs the predefined init Flag.
InitFlag(String, boolean) - Constructor for class org.refcodes.cli.InitFlag: Constructs the predefined init Flag.
intOption(Character, String, String) - Static method in class org.refcodes.cli.CliSugar: Instantiates a new IntOption with the given arguments.
intOption(Character, String, String, String) - Static method in class org.refcodes.cli.CliSugar: Instantiates a new IntOption with the given arguments.
intOption(String, String) - Static method in class org.refcodes.cli.CliSugar: Instantiates a new IntOption with the given arguments.
intOption(String, String, String) - Static method in class org.refcodes.cli.CliSugar: Instantiates a new IntOption with the given arguments.
IntOption - Class in org.refcodes.cli: The IntOption represents an Option holding int values.
IntOption(Character, String, String) - Constructor for class org.refcodes.cli.IntOption: Instantiates a new IntOption with the given arguments.
IntOption(Character, String, String, String) - Constructor for class org.refcodes.cli.IntOption: Instantiates a new IntOption with the given arguments.
IntOption(String, String) - Constructor for class org.refcodes.cli.IntOption: Instantiates a new IntOption with the given arguments.
IntOption(String, String, String) - Constructor for class org.refcodes.cli.IntOption: Instantiates a new IntOption with the given arguments.
IntOption(Relation<String, Integer>) - Constructor for class org.refcodes.cli.IntOption: Instantiates a new IntOption with the alias being the proerty's key and the value being the property's value.
isEnabled() - Method in class org.refcodes.cli.Flag: Returns true if the switch has been set (enabled).
isEnabled() - Method in class org.refcodes.cli.NoneOperand: Determines whether none arguments have been passed.
isEnabled() - Method in class org.refcodes.cli.Operation: Returns true if the switch has been set (enabled).
isEscapeCodesEnabled() - Method in class org.refcodes.cli.ArgsParserImpl
isEscapeCodesEnabled() - Method in class org.refcodes.cli.CliContext
isOption(String) - Method in class org.refcodes.cli.CliContext: Determines whether the given argument is an option in terms of this context, e.g. whether it starts either with a short option prefix (as of ShortOptionPrefixAccessor.getShortOptionPrefix() or a long option prefix (as of LongOptionPrefixAccessor.getLongOptionPrefix()).

L

letArgs(String[]) - Method in interface org.refcodes.cli.ArgsAccessor.ArgsProperty: This method stores and passes through the given arguments, which is very useful for builder APIs: Sets the given String array (setter) as of ArgsAccessor.ArgsMutator.setArgs(String[]) and returns the very same value (getter).
letArgsParser(ArgsParser) - Method in interface org.refcodes.cli.ArgsParserAccessor.ArgsParserProperty: This method stores and passes through the given argument, which is very useful for builder APIs: Sets the given ArgsParser (setter) as of ArgsParserAccessor.ArgsParserMutator.setArgsParser(ArgsParser) and returns the very same value (getter).
letArgsSyntax(Constituent) - Method in interface org.refcodes.cli.ArgsSyntaxAccessor.ArgsSyntaxProperty: 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(Constituent) and returns the very same value (getter).
letArgumentEscapeCode(String) - Method in interface org.refcodes.cli.ArgumentEscapeCodeAccessor.ArgumentEscapeCodeProperty: This method stores and passes through the given argument, which is very useful for builder APIs: Sets the given String (setter) as of ArgumentEscapeCodeAccessor.ArgumentEscapeCodeMutator.setArgumentEscapeCode(String) and returns the very same value (getter).
letArgumentPrefix(String) - Method in interface org.refcodes.cli.ArgumentPrefixAccessor.ArgumentPrefixProperty: This method stores and passes through the given argument, which is very useful for builder APIs: Sets the given String (setter) as of ArgumentPrefixAccessor.ArgumentPrefixMutator.setArgumentPrefix(String) and returns the very same value (getter).
letArgumentSuffix(String) - Method in interface org.refcodes.cli.ArgumentSuffixAccessor.ArgumentSuffixProperty: This method stores and passes through the given argument, which is very useful for builder APIs: Sets the given String (setter) as of ArgumentSuffixAccessor.ArgumentSuffixMutator.setArgumentSuffix(String) and returns the very same value (getter).
letCliContext(CliContext) - Method in interface org.refcodes.cli.CliContextAccessor.RootConditionProperty: This method stores and passes through the given argument, which is very useful for builder APIs: Sets the given CliContext (setter) as of CliContextAccessor.RootConditionMutator.setCliContext(CliContext) and returns the very same value (getter).
letLongOptionPrefix(String) - Method in interface org.refcodes.cli.LongOptionPrefixAccessor.LongOptionPrefixProperty: This method stores and passes through the given argument, which is very useful for builder APIs: Sets the given String (setter) as of LongOptionPrefixAccessor.LongOptionPrefixMutator.setLongOptionPrefix(String) and returns the very same value (getter).
letOptionEscapeCode(String) - Method in interface org.refcodes.cli.OptionEscapeCodeAccessor.OptionEscapeCodeProperty: This method stores and passes through the given argument, which is very useful for builder APIs: Sets the given String (setter) as of OptionEscapeCodeAccessor.OptionEscapeCodeMutator.setOptionEscapeCode(String) and returns the very same value (getter).
letShortOptionPrefix(Character) - Method in interface org.refcodes.cli.ShortOptionPrefixAccessor.ShortOptionPrefixProperty: This method stores and passes through the given argument, which is very useful for builder APIs: Sets the given Character (setter) as of ShortOptionPrefixAccessor.ShortOptionPrefixMutator.setShortOptionPrefix(Character) and returns the very same value (getter).
letSyntaxMetrics(SyntaxMetrics) - Method in interface org.refcodes.cli.SyntaxMetricsAccessor.SyntaxMetricsProperty: This method stores and passes through the given argument, which is very useful for builder APIs: Sets the given SyntaxMetrics (setter) as of SyntaxMetricsAccessor.SyntaxMetricsMutator.setSyntaxMetrics(SyntaxMetrics) and returns the very same value (getter).
LOGICAL - Enum constant in enum class org.refcodes.cli.SyntaxNotation: A notation which the author of this code believes to unambiguously describe a command line utility's argument syntax; as defined by the means of this refcodes-cli artifact.
LONG_OPTION - Static variable in class org.refcodes.cli.CleanFlag
LONG_OPTION - Static variable in class org.refcodes.cli.ConfigOption
LONG_OPTION - Static variable in class org.refcodes.cli.DaemonFlag
LONG_OPTION - Static variable in class org.refcodes.cli.DebugFlag
LONG_OPTION - Static variable in class org.refcodes.cli.ForceFlag
LONG_OPTION - Static variable in class org.refcodes.cli.HelpFlag
LONG_OPTION - Static variable in class org.refcodes.cli.InitFlag
LONG_OPTION - Static variable in class org.refcodes.cli.QuietFlag
LONG_OPTION - Static variable in class org.refcodes.cli.SysInfoFlag
LONG_OPTION - Static variable in class org.refcodes.cli.VerboseFlag
longOption(Character, String, String) - Static method in class org.refcodes.cli.CliSugar: Instantiates a new LongOption with the given arguments.
longOption(Character, String, String, String) - Static method in class org.refcodes.cli.CliSugar: Instantiates a new LongOption with the given arguments.
longOption(String, String) - Static method in class org.refcodes.cli.CliSugar: Instantiates a new LongOption with the given arguments.
longOption(String, String, String) - Static method in class org.refcodes.cli.CliSugar: Instantiates a new LongOption with the given arguments.
LongOption - Class in org.refcodes.cli: The LongOption represents an Option holding long values.
LongOption(Character, String, String) - Constructor for class org.refcodes.cli.LongOption: Instantiates a new LongOption with the given arguments.
LongOption(Character, String, String, String) - Constructor for class org.refcodes.cli.LongOption: Instantiates a new LongOption with the given arguments.
LongOption(String, String) - Constructor for class org.refcodes.cli.LongOption: Instantiates a new LongOption with the given arguments.
LongOption(String, String, String) - Constructor for class org.refcodes.cli.LongOption: Instantiates a new LongOption with the given arguments.
LongOption(Relation<String, Long>) - Constructor for class org.refcodes.cli.LongOption: Instantiates a new LongOption with the alias being the proerty's key and the value being the property's value.
LongOptionPrefixAccessor - Interface in org.refcodes.cli: Provides an accessor for a long option prefix property.
LongOptionPrefixAccessor.LongOptionPrefixBuilder> - Interface in org.refcodes.cli: Provides a builder method for a long option prefix property returning the builder for applying multiple build operations.
LongOptionPrefixAccessor.LongOptionPrefixMutator - Interface in org.refcodes.cli: Provides a mutator for a long option prefix property.
LongOptionPrefixAccessor.LongOptionPrefixProperty - Interface in org.refcodes.cli: Provides a long option prefix property.

N

none(String) - Static method in class org.refcodes.cli.CliSugar: Instantiates a new NoneOperand.
none(String, String) - Static method in class org.refcodes.cli.CliSugar: Instantiates a new NoneOperand.
none(Relation<String, Boolean>) - Static method in class org.refcodes.cli.CliSugar: Instantiates a new NoneOperand.
NONE - Enum constant in enum class org.refcodes.cli.ArgsFilter: No arguments are filtered.
NoneOperand - Class in org.refcodes.cli: The NoneOperand represents an empty set of arguments, e.g. no command line argument is being passed.
NoneOperand(String) - Constructor for class org.refcodes.cli.NoneOperand: Instantiates a new NoneOperand.
NoneOperand(String, String) - Constructor for class org.refcodes.cli.NoneOperand: Instantiates a new NoneOperand.
NoneOperand(Relation<String, Boolean>) - Constructor for class org.refcodes.cli.NoneOperand: Instantiates a new NoneOperand.

O

Operand<T> - Interface in org.refcodes.cli: An Operand represents a value parsed from command line arguments.
operation(String, String) - Static method in class org.refcodes.cli.CliSugar: Constructs a Operation with the given arguments.
operation(String, String, String) - Static method in class org.refcodes.cli.CliSugar: Constructs a Operation with the given arguments.
Operation - Class in org.refcodes.cli: The Operation is an argument representing a function or a method ("command") and is either provided or not provided as of Operation.isEnabled().
Operation(String, String) - Constructor for class org.refcodes.cli.Operation: Constructs a Operation with the given arguments.
Operation(String, String, String) - Constructor for class org.refcodes.cli.Operation: Constructs a Operation with the given arguments.
Option<T> - Interface in org.refcodes.cli: An Option represents a command line option with the according option's value.
Optionable - Interface in org.refcodes.cli: Provides means to determine context specific information on Option instances.
optional(Constituent...) - Static method in class org.refcodes.cli.CliSugar: Semantically identical synonym for the CliSugar.optional(Constituent...) declaration.
OptionEscapeCodeAccessor - Interface in org.refcodes.cli: Provides an accessor for a option Escape-Code property.
OptionEscapeCodeAccessor.OptionEscapeCodeBuilder> - Interface in org.refcodes.cli: Provides a builder method for a option Escape-Code property returning the builder for applying multiple build operations.
OptionEscapeCodeAccessor.OptionEscapeCodeMutator - Interface in org.refcodes.cli: Provides a mutator for a option Escape-Code property.
OptionEscapeCodeAccessor.OptionEscapeCodeProperty - Interface in org.refcodes.cli: Provides a option Escape-Code property.
or(Constituent...) - Static method in class org.refcodes.cli.CliSugar: Instantiates a new OrCondition with the Constituent (Condition) instances to be nested.
OrCondition - Class in org.refcodes.cli: An OrCondition represents a list of Condition (Constituent) instances of which at least one must be parsed successfully when the Constituent s' parseArgs(String[], String[], CliContext) methods are invoked.
OrCondition(Constituent...) - Constructor for class org.refcodes.cli.OrCondition: Instantiates a new OrCondition with the Constituent (Condition) instances to be nested.
org.refcodes.cli - module org.refcodes.cli
org.refcodes.cli - package org.refcodes.cli: This artifact defines some helpful toolkit to parse your command line arguments (as passed to your public static void main( String[] args) { ... } method.

P

parseArgs(String[], String[], CliContext) - Method in class org.refcodes.cli.AbstractOperand: Parses the provided command line arguments and determines the according values by evaluating this Constituent instance or, in case of being a node in the syntax tree (such as a Condition, traversing the child Constituent instances' parseArgs(String[], String[], CliContext) methods.
parseArgs(String[], String[], CliContext) - Method in class org.refcodes.cli.AbstractOption: Parses the provided command line arguments and determines the according values by evaluating this Constituent instance or, in case of being a node in the syntax tree (such as a Condition, traversing the child Constituent instances' parseArgs(String[], String[], CliContext) methods.
parseArgs(String[], String[], CliContext) - Method in class org.refcodes.cli.AllCondition: Parses the provided command line arguments and determines the according values by evaluating this Constituent instance or, in case of being a node in the syntax tree (such as a Condition, traversing the child Constituent instances' parseArgs(String[], String[], CliContext) methods.
parseArgs(String[], String[], CliContext) - Method in class org.refcodes.cli.AndCondition: Parses the provided command line arguments and determines the according values by evaluating this Constituent instance or, in case of being a node in the syntax tree (such as a Condition, traversing the child Constituent instances' parseArgs(String[], String[], CliContext) methods.
parseArgs(String[], String[], CliContext) - Method in class org.refcodes.cli.AnyCondition: Parses the provided command line arguments and determines the according values by evaluating this Constituent instance or, in case of being a node in the syntax tree (such as a Condition, traversing the child Constituent instances' parseArgs(String[], String[], CliContext) methods.
parseArgs(String[], String[], CliContext) - Method in class org.refcodes.cli.ArrayOperand: Parses the provided command line arguments and determines the according values by evaluating this Constituent instance or, in case of being a node in the syntax tree (such as a Condition, traversing the child Constituent instances' parseArgs(String[], String[], CliContext) methods.
parseArgs(String[], String[], CliContext) - Method in interface org.refcodes.cli.Constituent: Parses the provided command line arguments and determines the according values by evaluating this Constituent instance or, in case of being a node in the syntax tree (such as a Condition, traversing the child Constituent instances' parseArgs(String[], String[], CliContext) methods.
parseArgs(String[], String[], CliContext) - Method in class org.refcodes.cli.Flag: Parses the provided command line arguments and determines the according values by evaluating this Constituent instance or, in case of being a node in the syntax tree (such as a Condition, traversing the child Constituent instances' parseArgs(String[], String[], CliContext) methods.
parseArgs(String[], String[], CliContext) - Method in class org.refcodes.cli.NoneOperand: Parses the provided command line arguments and determines the according values by evaluating this Constituent instance or, in case of being a node in the syntax tree (such as a Condition, traversing the child Constituent instances' parseArgs(String[], String[], CliContext) methods.
parseArgs(String[], String[], CliContext) - Method in class org.refcodes.cli.Operation: Parses the provided command line arguments and determines the according values by evaluating this Constituent instance or, in case of being a node in the syntax tree (such as a Condition, traversing the child Constituent instances' parseArgs(String[], String[], CliContext) methods.
parseArgs(String[], String[], CliContext) - Method in class org.refcodes.cli.OrCondition: Parses the provided command line arguments and determines the according values by evaluating this Constituent instance or, in case of being a node in the syntax tree (such as a Condition, traversing the child Constituent instances' parseArgs(String[], String[], CliContext) methods.
parseArgs(String[], String[], CliContext) - Method in class org.refcodes.cli.XorCondition: Parses the provided command line arguments and determines the according values by evaluating this Constituent instance or, in case of being a node in the syntax tree (such as a Condition, traversing the child Constituent instances' parseArgs(String[], String[], CliContext) methods.
parseArgs(String[], CliContext) - Method in interface org.refcodes.cli.Constituent: Parses the provided command line arguments and determines the according values by evaluating this Constituent instance or, in case of being a node in the syntax tree (such as a Condition, traversing the child Constituent instances' parseArgs(String[], String[], CliContext) methods.
ParseArgsException - Exception in org.refcodes.cli: Thrown in case the provided command line arguments do not respect the required semantics or cannot be converted to the required type.
ParseArgsException(String[], String) - Constructor for exception org.refcodes.cli.ParseArgsException: Instantiates a new parses the args exception.
ParseArgsException(String[], String, String) - Constructor for exception org.refcodes.cli.ParseArgsException: Instantiates a new parses the args exception.
ParseArgsException(String[], String, Throwable) - Constructor for exception org.refcodes.cli.ParseArgsException: Instantiates a new parses the args exception.
ParseArgsException(String[], String, Throwable, String) - Constructor for exception org.refcodes.cli.ParseArgsException: Instantiates a new parses the args exception.
ParseArgsException(String[], Throwable) - Constructor for exception org.refcodes.cli.ParseArgsException: Instantiates a new parses the args exception.
ParseArgsException(String[], Throwable, String) - Constructor for exception org.refcodes.cli.ParseArgsException: Instantiates a new parses the args exception.
printBanner() - Method in interface org.refcodes.cli.ArgsParser: Prints the banner; the banner most probably is an ASCII_HEADER_ASCII_BODY art text block which's look depends strongly on the taste of the author implementing this interface.
printBanner() - Method in class org.refcodes.cli.ArgsParserImpl: Prints the banner; the banner most probably is an ASCII_HEADER_ASCII_BODY art text block which's look depends strongly on the taste of the author implementing this interface.
printBody() - Method in interface org.refcodes.cli.ArgsParser: Prints the help as of ArgsParser.printHelp() without the banner.
printCopyrightNote() - Method in interface org.refcodes.cli.ArgsParser: Prints the copyright note as specified by the ArgsParser.withCopyrightNote(String) method; with regards to the console width as specified by the ArgsParser.withConsoleWidth(int) method.
printCopyrightNote() - Method in class org.refcodes.cli.ArgsParserImpl: Prints the copyright note as specified by the ArgsParser.withCopyrightNote(String) method; with regards to the console width as specified by the ArgsParser.withConsoleWidth(int) method.
printDescription() - Method in interface org.refcodes.cli.ArgsParser: Prints the description as set by the ArgsParser.withDescription(String) method with regards to the console width as specified by the ArgsParser.withConsoleWidth(int) method.
printDescription() - Method in class org.refcodes.cli.ArgsParserImpl: Prints the description as set by the ArgsParser.withDescription(String) method with regards to the console width as specified by the ArgsParser.withConsoleWidth(int) method.
printExamples() - Method in interface org.refcodes.cli.ArgsParser: Prints example usages as as added by the ArgsParser.addExample(String, Operand...) method with regards to the console width as specified by the ArgsParser.withConsoleWidth(int) method.
printExamples() - Method in class org.refcodes.cli.ArgsParserImpl: Prints example usages as as added by the ArgsParser.addExample(String, Operand...) method with regards to the console width as specified by the ArgsParser.withConsoleWidth(int) method.
printHeader() - Method in interface org.refcodes.cli.ArgsParser: Prints the header, which might be a simplified banner: Can be used when overriding methods such as ArgsParser.printHelp() or ArgsParser.printBanner().
printHeader() - Method in class org.refcodes.cli.ArgsParserImpl: Prints the header, which might be a simplified banner: Can be used when overriding methods such as ArgsParser.printHelp() or ArgsParser.printBanner().
printHelp() - Method in interface org.refcodes.cli.ArgsParser: Prints the help to the standard output specified by the ArgsParser.withStandardOut(PrintStream) method.
printLicenseNote() - Method in interface org.refcodes.cli.ArgsParser: Prints the license note as specified by the ArgsParser.withLicenseNote(String) method; with regards to the console width as specified by the ArgsParser.withConsoleWidth(int) method.
printLicenseNote() - Method in class org.refcodes.cli.ArgsParserImpl: Prints the license note as specified by the ArgsParser.withLicenseNote(String) method; with regards to the console width as specified by the ArgsParser.withConsoleWidth(int) method.
printLn() - Method in interface org.refcodes.cli.ArgsParser: Prints an empty line / a line break.
printLn() - Method in class org.refcodes.cli.ArgsParserImpl: Prints an empty line / a line break.
printLn(String) - Method in interface org.refcodes.cli.ArgsParser: Prints the given line to standard out with regards to the console width as specified by the ArgsParser.withConsoleWidth(int) method.
printLn(String) - Method in class org.refcodes.cli.ArgsParserImpl: Prints the given line to standard out with regards to the console width as specified by the ArgsParser.withConsoleWidth(int) method.
printOptions() - Method in interface org.refcodes.cli.ArgsParser: Prints the Options (short- and the long-options), the Flages and the Operand and their description with regards to the console width as specified by the ArgsParser.withConsoleWidth(int) method.
printOptions() - Method in class org.refcodes.cli.ArgsParserImpl: Prints the Options (short- and the long-options), the Flages and the Operand and their description with regards to the console width as specified by the ArgsParser.withConsoleWidth(int) method.
printSeparatorLn() - Method in interface org.refcodes.cli.ArgsParser: Prints a separator line using the separator character as specified by the ArgsParser.withSeparatorLnChar(char) method; with regards to the console width as specified by the ArgsParser.withConsoleWidth(int) method.
printSeparatorLn() - Method in class org.refcodes.cli.ArgsParserImpl: Prints a separator line using the separator character as specified by the ArgsParser.withSeparatorLnChar(char) method; with regards to the console width as specified by the ArgsParser.withConsoleWidth(int) method.
printSynopsis() - Method in interface org.refcodes.cli.ArgsParser: Prints the syntax as retrieved by the root Condition element as of Synopsisable.toSynopsis(SyntaxNotation) with regards to the SyntaxNotation set by the ArgsParser.withSyntaxMetrics(SyntaxMetrics) method.
printSynopsis() - Method in class org.refcodes.cli.ArgsParserImpl: Prints the syntax as retrieved by the root Condition element as of Synopsisable.toSynopsis(SyntaxNotation) with regards to the SyntaxNotation set by the ArgsParser.withSyntaxMetrics(SyntaxMetrics) method.

Q

quietFlag() - Static method in class org.refcodes.cli.CliSugar: Constructs the predefined quiet Flag.
quietFlag(boolean) - Static method in class org.refcodes.cli.CliSugar: Constructs the predefined quiet Flag.
quietFlag(String) - Static method in class org.refcodes.cli.CliSugar: Constructs the predefined quiet Flag.
QuietFlag - Class in org.refcodes.cli: 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.
QuietFlag() - Constructor for class org.refcodes.cli.QuietFlag: Constructs the predefined quiet Flag.
QuietFlag(boolean) - Constructor for class org.refcodes.cli.QuietFlag: Constructs the predefined quiet Flag.
QuietFlag(String) - Constructor for class org.refcodes.cli.QuietFlag: Constructs the predefined quiet Flag.
QuietFlag(String, boolean) - Constructor for class org.refcodes.cli.QuietFlag: Constructs the predefined quiet Flag.

R

reset() - Method in class org.refcodes.cli.AbstractCondition
reset() - Method in class org.refcodes.cli.AbstractOperand
reset() - Method in class org.refcodes.cli.AllCondition
reset() - Method in class org.refcodes.cli.AnyCondition
reset() - Method in class org.refcodes.cli.ArgsParserImpl
reset() - Method in class org.refcodes.cli.ArrayOperand
reset() - Method in class org.refcodes.cli.Flag
reset() - Method in class org.refcodes.cli.Operation

S

setArgs(String[]) - Method in interface org.refcodes.cli.ArgsAccessor.ArgsMutator: Sets the command line arguments for the args property.
setArgsParser(ArgsParser) - Method in interface org.refcodes.cli.ArgsParserAccessor.ArgsParserMutator: Sets the args-parser for the ArgsParser property.
setArgsSyntax(Constituent) - Method in interface org.refcodes.cli.ArgsSyntaxAccessor.ArgsSyntaxMutator: Sets the root condition for the root condition property.
setArgumentEscapeCode(String) - Method in interface org.refcodes.cli.ArgsParser: Sets the parameter Escape-Code for the parameter Escape-Code property.
setArgumentEscapeCode(String) - Method in class org.refcodes.cli.ArgsParserImpl: Sets the parameter Escape-Code for the parameter Escape-Code property.
setArgumentEscapeCode(String) - Method in interface org.refcodes.cli.ArgumentEscapeCodeAccessor.ArgumentEscapeCodeMutator: Sets the argument Escape-Code for the argument Escape-Code property.
setArgumentPrefix(String) - Method in interface org.refcodes.cli.ArgumentPrefixAccessor.ArgumentPrefixMutator: Sets the argument prefix for the argument prefix property.
setArgumentSuffix(String) - Method in interface org.refcodes.cli.ArgumentSuffixAccessor.ArgumentSuffixMutator: Sets the argument suffix for the argument suffix property.
setBannerBorderEscapeCode(String) - Method in interface org.refcodes.cli.ArgsParser: Sets the banner's border Escape-Code for the banner border Escape-Code property.
setBannerBorderEscapeCode(String) - Method in class org.refcodes.cli.ArgsParserImpl: Sets the banner's border Escape-Code for the banner border Escape-Code property.
setBannerEscapeCode(String) - Method in interface org.refcodes.cli.ArgsParser: Sets the banner's content Escape-Code for the banner Escape-Code property.
setBannerEscapeCode(String) - Method in class org.refcodes.cli.ArgsParserImpl: Sets the banner's content Escape-Code for the banner Escape-Code property.
setBannerFont(Font) - Method in interface org.refcodes.cli.ArgsParser: Sets the banner font.
setBannerFont(Font) - Method in class org.refcodes.cli.ArgsParserImpl: Sets the banner font.
setBannerFontPalette(char[]) - Method in interface org.refcodes.cli.ArgsParser: Sets the banner font palette.
setBannerFontPalette(char[]) - Method in class org.refcodes.cli.ArgsParserImpl: Sets the banner font palette.
setCliContext(CliContext) - Method in interface org.refcodes.cli.CliContextAccessor.RootConditionMutator: Sets the CliContext for the CliContext property.
setCommandEscapeCode(String) - Method in interface org.refcodes.cli.ArgsParser: Sets the command name's (CLI executable) Escape-Code for the command name Escape-Code property.
setCommandEscapeCode(String) - Method in class org.refcodes.cli.ArgsParserImpl: Sets the command name's (CLI executable) Escape-Code for the command name Escape-Code property.
setConsoleWidth(int) - Method in interface org.refcodes.cli.ArgsParser: Set the console with.
setConsoleWidth(int) - Method in class org.refcodes.cli.ArgsParserImpl: Set the console with.
setCopyrightNote(String) - Method in interface org.refcodes.cli.ArgsParser: Set the copyright note used by the ArgsParser.printHelp() method when writing out the copyright claim and make other adjustments with the result (with regards to the Builder-Pattern).
setCopyrightNote(String) - Method in class org.refcodes.cli.ArgsParserImpl: Set the copyright note used by the ArgsParser.printHelp() method when writing out the copyright claim and make other adjustments with the result (with regards to the Builder-Pattern).
setDescription(String) - Method in class org.refcodes.cli.ArgsParserImpl
setDescriptionEscapeCode(String) - Method in interface org.refcodes.cli.ArgsParser: Sets the description Escape-Code for the description Escape-Code property.
setDescriptionEscapeCode(String) - Method in class org.refcodes.cli.ArgsParserImpl: Sets the description Escape-Code for the description Escape-Code property.
setErrorOut(PrintStream) - Method in interface org.refcodes.cli.ArgsParser: Set the error out PrintStream and make other adjustments with the result (with regards to the Builder-Pattern).
setErrorOut(PrintStream) - Method in class org.refcodes.cli.ArgsParserImpl: Set the error out PrintStream and make other adjustments with the result (with regards to the Builder-Pattern).
setEscapeCodesEnabled(boolean) - Method in class org.refcodes.cli.ArgsParserImpl
setLicenseNote(String) - Method in interface org.refcodes.cli.ArgsParser: Set the license note used by the ArgsParser.printHelp() method when writing out the licensing conditions.
setLicenseNote(String) - Method in class org.refcodes.cli.ArgsParserImpl: Set the license note used by the ArgsParser.printHelp() method when writing out the licensing conditions.
setLineBreak(String) - Method in interface org.refcodes.cli.ArgsParser: Set the console's line break.
setLineBreak(String) - Method in class org.refcodes.cli.ArgsParserImpl: Set the console's line break.
setLineSeparatorEscapeCode(String) - Method in interface org.refcodes.cli.ArgsParser: Sets the line separator Escape-Code for the line separator Escape-Code property.
setLineSeparatorEscapeCode(String) - Method in class org.refcodes.cli.ArgsParserImpl: Sets the line separator Escape-Code for the line separator Escape-Code property.
setLongOptionPrefix(String) - Method in class org.refcodes.cli.ArgsParserImpl: Sets the long option prefix for the long option prefix property.
setLongOptionPrefix(String) - Method in interface org.refcodes.cli.LongOptionPrefixAccessor.LongOptionPrefixMutator: Sets the long option prefix for the long option prefix property.
setMaxConsoleWidth(int) - Method in interface org.refcodes.cli.ArgsParser: Set the maximum console width to use in case the console width is greater than the maximum you want.
setMaxConsoleWidth(int) - Method in class org.refcodes.cli.ArgsParserImpl: Set the maximum console width to use in case the console width is greater than the maximum you want.
setName(String) - Method in class org.refcodes.cli.ArgsParserImpl
setOptionEscapeCode(String) - Method in interface org.refcodes.cli.ArgsParser: Sets the option Escape-Code for the option Escape-Code property.
setOptionEscapeCode(String) - Method in class org.refcodes.cli.ArgsParserImpl: Sets the option Escape-Code for the option Escape-Code property.
setOptionEscapeCode(String) - Method in interface org.refcodes.cli.OptionEscapeCodeAccessor.OptionEscapeCodeMutator: Sets the option Escape-Code for the option Escape-Code property.
setParsedArgs(String[]) - Method in class org.refcodes.cli.AbstractOperand: Sets the command line argument(s) representing the Operand and its value as parsed by the AbstractOperand.parseArgs(String[], String[], CliContext) method.
setParsedArgs(String[]) - Method in class org.refcodes.cli.AbstractOption: Sets the command line argument(s) representing the Operand and its value as parsed by the AbstractOperand.parseArgs(String[], String[], CliContext) method.
setResetEscapeCode(String) - Method in class org.refcodes.cli.ArgsParserImpl
setSeparatorLnChar(char) - Method in interface org.refcodes.cli.ArgsParser: Set the character to be used when printing a separator line with the ArgsParser.printSeparatorLn() method.
setSeparatorLnChar(char) - Method in class org.refcodes.cli.ArgsParserImpl: Set the character to be used when printing a separator line with the ArgsParser.printSeparatorLn() method.
setShortOptionPrefix(Character) - Method in class org.refcodes.cli.ArgsParserImpl: Sets the short option prefix for the short option prefix property.
setShortOptionPrefix(Character) - Method in interface org.refcodes.cli.ShortOptionPrefixAccessor.ShortOptionPrefixMutator: Sets the short option prefix for the short option prefix property.
setStandardOut(PrintStream) - Method in interface org.refcodes.cli.ArgsParser: Set the standard out PrintStream and make other adjustments with the result (with regards to the Builder-Pattern).
setStandardOut(PrintStream) - Method in class org.refcodes.cli.ArgsParserImpl: Set the standard out PrintStream and make other adjustments with the result (with regards to the Builder-Pattern).
setSyntaxMetrics(SyntaxMetrics) - Method in interface org.refcodes.cli.ArgsParser: Set the SyntaxNotation.
setSyntaxMetrics(SyntaxMetrics) - Method in class org.refcodes.cli.ArgsParserImpl: Set the SyntaxNotation.
setSyntaxMetrics(SyntaxMetrics) - Method in interface org.refcodes.cli.SyntaxMetricsAccessor.SyntaxMetricsMutator: Sets the SyntaxMetrics for the SyntaxMetrics property.
setTextBoxGrid(TextBoxGrid) - Method in class org.refcodes.cli.ArgsParserImpl
setTitle(String) - Method in class org.refcodes.cli.ArgsParserImpl
setValue(T) - Method in class org.refcodes.cli.AbstractOperand: Sets the value for the Operand as parsed by the AbstractOperand.parseArgs(String[], String[], CliContext) method.
setValue(T) - Method in class org.refcodes.cli.AbstractOption: Sets the value for the Operand as parsed by the AbstractOperand.parseArgs(String[], String[], CliContext) method.
SHORT_OPTION - Static variable in class org.refcodes.cli.CleanFlag
SHORT_OPTION - Static variable in class org.refcodes.cli.ConfigOption
SHORT_OPTION - Static variable in class org.refcodes.cli.DaemonFlag
SHORT_OPTION - Static variable in class org.refcodes.cli.DebugFlag
SHORT_OPTION - Static variable in class org.refcodes.cli.ForceFlag
SHORT_OPTION - Static variable in class org.refcodes.cli.HelpFlag
SHORT_OPTION - Static variable in class org.refcodes.cli.InitFlag
SHORT_OPTION - Static variable in class org.refcodes.cli.QuietFlag
SHORT_OPTION - Static variable in class org.refcodes.cli.SysInfoFlag
SHORT_OPTION - Static variable in class org.refcodes.cli.VerboseFlag
ShortOptionPrefixAccessor - Interface in org.refcodes.cli: Provides an accessor for a short option prefix property.
ShortOptionPrefixAccessor.ShortOptionPrefixBuilder> - Interface in org.refcodes.cli: Provides a builder method for a short option prefix property returning the builder for applying multiple build operations.
ShortOptionPrefixAccessor.ShortOptionPrefixMutator - Interface in org.refcodes.cli: Provides a mutator for a short option prefix property.
ShortOptionPrefixAccessor.ShortOptionPrefixProperty - Interface in org.refcodes.cli: Provides a short option prefix property.
stringOperand(String, String) - Static method in class org.refcodes.cli.CliSugar: Instantiates a new StringOperand.
StringOperand - Class in org.refcodes.cli: An Operand (neither a short option nor a long option prepended nor being a switch) being s String.
StringOperand(String, String) - Constructor for class org.refcodes.cli.StringOperand: Instantiates a new StringOperand.
StringOperand(Relation<String, String>) - Constructor for class org.refcodes.cli.StringOperand: Instantiates a new {StringOperand Flag} with the alias being the proerty's key and the value being the property's value.
stringOption(Character, String, String) - Static method in class org.refcodes.cli.CliSugar: Instantiates a new StringOption with the given arguments.
stringOption(Character, String, String, String) - Static method in class org.refcodes.cli.CliSugar: Instantiates a new StringOption with the given arguments.
stringOption(String, String) - Static method in class org.refcodes.cli.CliSugar: Instantiates a new StringOption with the given arguments.
stringOption(String, String, String) - Static method in class org.refcodes.cli.CliSugar: Instantiates a new StringOption with the given arguments.
StringOption - Class in org.refcodes.cli: The StringOption represents an Option holding String values.
StringOption(Character, String, String) - Constructor for class org.refcodes.cli.StringOption: Instantiates a new StringOption with the given arguments.
StringOption(Character, String, String, String) - Constructor for class org.refcodes.cli.StringOption: Instantiates a new StringOption with the given arguments.
StringOption(String, String) - Constructor for class org.refcodes.cli.StringOption: Instantiates a new StringOption with the given arguments.
StringOption(String, String, String) - Constructor for class org.refcodes.cli.StringOption: Instantiates a new StringOption with the given arguments.
StringOption(Relation<String, String>) - Constructor for class org.refcodes.cli.StringOption: Instantiates a new StringOption with the alias being the proerty's key and the value being the property's value.
SuperfluousArgsException - Exception in org.refcodes.cli: Thrown in case there were arguments found not being used (superfluous arguments).
SuperfluousArgsException(String[], String) - Constructor for exception org.refcodes.cli.SuperfluousArgsException: Instantiates a new superfluous args exception.
SuperfluousArgsException(String[], String, String) - Constructor for exception org.refcodes.cli.SuperfluousArgsException: Instantiates a new superfluous args exception.
SuperfluousArgsException(String[], String, Throwable) - Constructor for exception org.refcodes.cli.SuperfluousArgsException: Instantiates a new superfluous args exception.
SuperfluousArgsException(String[], String, Throwable, String) - Constructor for exception org.refcodes.cli.SuperfluousArgsException: Instantiates a new superfluous args exception.
SuperfluousArgsException(String[], Throwable) - Constructor for exception org.refcodes.cli.SuperfluousArgsException: Instantiates a new superfluous args exception.
SuperfluousArgsException(String[], Throwable, String) - Constructor for exception org.refcodes.cli.SuperfluousArgsException: Instantiates a new superfluous args exception.
Synopsisable - Interface in org.refcodes.cli: The Synopsisable interface defines those methods required to create a human readable usage String similar to a manpage's synopsis from the implementing instance.
SyntaxMetrics - Interface in org.refcodes.cli: The SyntaxMetrics provides properties specific to a specific command line syntax notation.
SyntaxMetricsAccessor - Interface in org.refcodes.cli: Provides an accessor for a SyntaxMetrics property.
SyntaxMetricsAccessor.SyntaxMetricsBuilder> - Interface in org.refcodes.cli: Provides a builder method for a SyntaxMetrics property returning the builder for applying multiple build operations.
SyntaxMetricsAccessor.SyntaxMetricsMutator - Interface in org.refcodes.cli: Provides a mutator for a SyntaxMetrics property.
SyntaxMetricsAccessor.SyntaxMetricsProperty - Interface in org.refcodes.cli: Provides a SyntaxMetrics property.
SyntaxMetricsImpl - Class in org.refcodes.cli: The SyntaxMetricsImpl class implements the SyntaxMetrics interface for building custom SyntaxMetrics instances.
SyntaxMetricsImpl(Character, String, String, String, String, String, String, String, String, String, String, String, String, String, String, String, String, String, String) - Constructor for class org.refcodes.cli.SyntaxMetricsImpl: Constructs an accordingly configured SyntaxMetricsImpl instance.
SyntaxMetricsImpl.Builder - Class in org.refcodes.cli: Builder to build SyntaxMetrics instances.
SyntaxNotation - Enum Class in org.refcodes.cli: The SyntaxNotation is used by a the toSyntax(CliContext) method to determine which notation to be used for the generated syntax.
sysInfoFlag() - Static method in class org.refcodes.cli.CliSugar: Constructs the predefined system info Flag.
sysInfoFlag(boolean) - Static method in class org.refcodes.cli.CliSugar: Constructs the predefined system info Flag.
sysInfoFlag(String) - Static method in class org.refcodes.cli.CliSugar: Constructs the predefined system info Flag.
SysInfoFlag - Class in org.refcodes.cli: 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..
SysInfoFlag() - Constructor for class org.refcodes.cli.SysInfoFlag: Constructs the predefined system information Flag.
SysInfoFlag(boolean) - Constructor for class org.refcodes.cli.SysInfoFlag: Constructs the predefined system information Flag.
SysInfoFlag(String) - Constructor for class org.refcodes.cli.SysInfoFlag: Constructs the predefined system information Flag.
SysInfoFlag(String, boolean) - Constructor for class org.refcodes.cli.SysInfoFlag: Constructs the predefined system information Flag.

T

toAllOptions(Constituent) - Method in class org.refcodes.cli.CliContext: Determines all options (short and long) found in the provided Constituent node and its children.
toArgsDiff(String[], String[]) - Static method in class org.refcodes.cli.CliUtility: Creates the difference between the provided set and the provided subset.
toArgsDiff(String[], List<? extends Operand<?>>) - Static method in class org.refcodes.cli.CliUtility: Creates the difference between the provided set and the provided Lists therein found argument arrays subset (as of Operand.toParsedArgs()).
toArgsFilter(String) - Static method in enum class org.refcodes.cli.ArgsFilter: Retrieves a ArgsFilter depending on the given string, ignoring the case as well as being graceful regarding "-" and "_",.
toArgumentEscapeCode() - Method in class org.refcodes.cli.CliContext: Constructs the argument escape code depending on the escape code status (as of CliContext.isEscapeCodesEnabled()) and whether the argument escape code is not null or null (as of CliContext.getArgumentEscapeCode()).
toArgumentSpec(Operand<?>) - Method in class org.refcodes.cli.CliContext: Creates the argument specification from the provided Operand.
toArgumentSpec(Operand<?>, int, int) - Method in class org.refcodes.cli.CliContext: Creates the argument specification from the provided Operand.
toExpandOptions(String[]) - Method in class org.refcodes.cli.CliContext: Expands the provided args' short options and returns the resulting args.
toFiltered(String[]) - Method in enum class org.refcodes.cli.ArgsFilter: Filters the provided args by excluding (filtering) the args matching this enumerations criteria.
toFiltered(String[], Pattern) - Static method in enum class org.refcodes.cli.ArgsFilter: Filters the provided args by excluding (filtering) the args matching the provided Pattern.
toFiltered(List<String>) - Method in enum class org.refcodes.cli.ArgsFilter: Filters the provided args by excluding (filtering) the args matching this enumerations criteria.
toFiltered(List<String>, Pattern) - Static method in enum class org.refcodes.cli.ArgsFilter: Filters the provided args by excluding (filtering) the args matching the provided Pattern.
toLongOption(Option<?>) - Method in class org.refcodes.cli.CliContext: Creates the CliContext instance specific prefixed long option String from the provided Option by prefixing the Option's long option (as of Option.getLongOption()) with the long option prefix (as of LongOptionPrefixAccessor.getLongOptionPrefix()).
toOperand(Class<T>) - Method in interface org.refcodes.cli.Condition: Traverses the hierarchy of Condition tree and returns the (first) operand matching the given type.
toOperand(String) - Method in interface org.refcodes.cli.Condition: Traverses the hierarchy of Condition tree and returns the (first) operand matching the given alias.
toOperand(String, Class<T>) - Method in class org.refcodes.cli.AbstractCondition: Traverses the hierarchy of Condition tree and returns the (first) operand matching the given alias and type.
toOperand(String, Class<T>) - Method in interface org.refcodes.cli.Condition: Traverses the hierarchy of Condition tree and returns the (first) operand matching the given alias and type.
toOperands() - Method in class org.refcodes.cli.AbstractCondition: Traverses the hierarchy of Conditions and collects all therein found Operands and sub-types such as the Flag or the Option.
toOperands() - Method in interface org.refcodes.cli.Condition: Traverses the hierarchy of Conditions and collects all therein found Operands and sub-types such as the Flag or the Option.
toOption(Option<?>) - Method in class org.refcodes.cli.CliContext: Creates the CliContext instance specific preferred prefixed option String, being the short option (as of CliContext.toShortOption(Option)) or, in case of the short option being null, the long option (as of CliContext.toLongOption(Option)).
toOptionArgument(String[], String, String[]) - Static method in class org.refcodes.cli.AbstractOption: Takes the Option's short-option and long-option and tries to determine that Option's value in the provided command line arguments.
toOptionArgument(Option<?>, String[], String[], CliContext) - Static method in class org.refcodes.cli.AbstractOption: Takes the Option's short-option and long-option and tries to determine that Option's value in the provided command line arguments.
toOptionEscapeCode() - Method in class org.refcodes.cli.CliContext: Constructs the option escape code depending on the escape code status (as of CliContext.isEscapeCodesEnabled()) and whether the option escape code is not null or null (as of CliContext.getOptionEscapeCode()).
toOptionPrefixes() - Method in interface org.refcodes.cli.SyntaxMetrics: Returns an array of the prefixes configured by this SyntaxMetrics instance, omitting any null or empty prefixes as well as any duplicates.
toOptions(Option<?>) - Method in interface org.refcodes.cli.ArgsParser: Retrieves an array of the context specific options being configured for the given Option instance, being the long option (when set) and the short option (when set), by prepending the according runtime specific short option and long option prefix (if applicable).
toOptions(Option<?>) - Method in class org.refcodes.cli.CliContext: Retrieves an array of the context specific options being configured for the given Option instance, being the long option (when set) and the short option (when set), by prepending the according runtime specific short option and long option prefix (if applicable).
toOptions(Option<?>) - Method in interface org.refcodes.cli.Optionable: Retrieves an array of the context specific options being configured for the given Option instance, being the long option (when set) and the short option (when set), by prepending the according runtime specific short option and long option prefix (if applicable).
toParsedArgs() - Method in class org.refcodes.cli.AbstractOperand: Retrieves the (command line) args which represent this Operand after being "parsed" (provided with command line args).
toParsedArgs() - Method in interface org.refcodes.cli.ArgsAccessor: Retrieves the command line arguments from the args property.
toParsedArgs() - Method in class org.refcodes.cli.ArrayOperand: Retrieves the (command line) args which represent this Operand after being "parsed" (provided with command line args).
toParsedArgs() - Method in exception org.refcodes.cli.CliException.ConsoleArgsException: Gets the args.
toParsedArgs() - Method in interface org.refcodes.cli.Operand: Retrieves the (command line) args which represent this Operand after being "parsed" (provided with command line args).
toParsedArgs(List<? extends Operand<?>>...) - Static method in class org.refcodes.cli.CliUtility: Takes all Operand instances found in the provided Lists and adds all therein found argument arrays (as of Operand.toParsedArgs()) to the result.
toResetEscapeCode() - Method in class org.refcodes.cli.CliContext: Constructs the reset escape code depending on the escape code status (as of CliContext.isEscapeCodesEnabled()) and whether the reset escape code is not null or null (as of CliContext.getResetEscapeCode()).
toSchema() - Method in class org.refcodes.cli.AbstractCondition
toSchema() - Method in class org.refcodes.cli.AbstractOperand
toSchema() - Method in class org.refcodes.cli.AbstractOption
toSchema() - Method in class org.refcodes.cli.ArrayOperand
toShortOption(Option<?>) - Method in class org.refcodes.cli.CliContext: Creates the CliContext instance specific prefixed short option String from the provided Option by prefixing the Option's short option (as of Option.getShortOption()) with the short option prefix (as of ShortOptionPrefixAccessor.getShortOptionPrefix()).
toSpec() - Method in interface org.refcodes.cli.Operand: Creates a specification for this Operand, helpful e.g. in human readable messages.
toSpec(Operand<?>) - Method in class org.refcodes.cli.CliContext: Creates a specification for the given Operand consisting of the Option constituent's specification (if any) as of CliContext.toOption(Option) and the argument specification (if any) as of CliContext.toArgumentSpec(Operand).
toString() - Method in class org.refcodes.cli.AbstractCondition
toString() - Method in class org.refcodes.cli.AbstractOperand
toString() - Method in class org.refcodes.cli.AllCondition
toString() - Method in class org.refcodes.cli.AnyCondition
toString() - Method in class org.refcodes.cli.OrCondition
toSynopsis() - Method in interface org.refcodes.cli.Synopsisable: Returns the human readable (verbose) syntax of implementing class ATTENTION: As of different parenthesis settings for some notations regarding the root Constituent and the child Constituents, the method toSyntax(CliContext) is called from inside a Constituent hierarchy.
toSynopsis(String, String, String) - Method in interface org.refcodes.cli.Synopsisable: Returns the human readable (verbose) syntax of implementing class ATTENTION: As of different parenthesis settings for some notations regarding the root Constituent and the child Constituents, the method toSyntax(CliContext) is called from inside a Constituent hierarchy.
toSynopsis(CliContext) - Method in class org.refcodes.cli.AllCondition: Returns the human readable (verbose) syntax of implementing class ATTENTION: As of different parenthesis settings for some notations regarding the root Constituent and the child Constituents, the method toSyntax(CliContext) is called from inside a Constituent hierarchy.
toSynopsis(CliContext) - Method in class org.refcodes.cli.AndCondition: Returns the human readable (verbose) syntax of implementing class ATTENTION: As of different parenthesis settings for some notations regarding the root Constituent and the child Constituents, the method toSyntax(CliContext) is called from inside a Constituent hierarchy.
toSynopsis(CliContext) - Method in interface org.refcodes.cli.Constituent: Returns the human readable (verbose) syntax of implementing class ATTENTION: As of different parenthesis settings for some notations regarding the root Constituent and the child Constituents, the method toSyntax(CliContext) is called from inside a Constituent hierarchy.
toSynopsis(CliContext) - Method in class org.refcodes.cli.OrCondition: Returns the human readable (verbose) syntax of implementing class ATTENTION: As of different parenthesis settings for some notations regarding the root Constituent and the child Constituents, the method toSyntax(CliContext) is called from inside a Constituent hierarchy.
toSynopsis(CliContext) - Method in interface org.refcodes.cli.Synopsisable: Returns the human readable (verbose) syntax of implementing class ATTENTION: As of different parenthesis settings for some notations regarding the root Constituent and the child Constituents, the method toSyntax(CliContext) is called from inside a Constituent hierarchy.
toSynopsis(CliContext) - Method in class org.refcodes.cli.XorCondition: Returns the human readable (verbose) syntax of implementing class ATTENTION: As of different parenthesis settings for some notations regarding the root Constituent and the child Constituents, the method toSyntax(CliContext) is called from inside a Constituent hierarchy.
toSynopsis(SyntaxNotation) - Method in interface org.refcodes.cli.Synopsisable: Returns the human readable (verbose) syntax of implementing class ATTENTION: As of different parenthesis settings for some notations regarding the root Constituent and the child Constituents, the method toSyntax(CliContext) is called from inside a Constituent hierarchy.
toSynopsis(SyntaxNotation, String, String, String) - Method in interface org.refcodes.cli.Synopsisable: Returns the human readable (verbose) syntax of implementing class ATTENTION: As of different parenthesis settings for some notations regarding the root Constituent and the child Constituents, the method toSyntax(CliContext) is called from inside a Constituent hierarchy.
toSyntax() - Method in interface org.refcodes.cli.Constituent: This method is to be called from inside the Constituent hierarchy; use the method Synopsisable.toSynopsis(SyntaxNotation) in case you invoke syntax retrieval from the root Constituent.
toSyntax(String, String, String) - Method in interface org.refcodes.cli.Constituent: This method is to be called from inside the Constituent hierarchy; use the method Synopsisable.toSynopsis(SyntaxNotation) in case you invoke syntax retrieval from the root Constituent.
toSyntax(CliContext) - Method in class org.refcodes.cli.AbstractCondition: This method is to be called from inside the Constituent hierarchy; use the method Synopsisable.toSynopsis(SyntaxNotation) in case you invoke syntax retrieval from the root Constituent.
toSyntax(CliContext) - Method in class org.refcodes.cli.AbstractOperand: This method is to be called from inside the Constituent hierarchy; use the method Synopsisable.toSynopsis(SyntaxNotation) in case you invoke syntax retrieval from the root Constituent.
toSyntax(CliContext) - Method in class org.refcodes.cli.AbstractOption: This method is to be called from inside the Constituent hierarchy; use the method Synopsisable.toSynopsis(SyntaxNotation) in case you invoke syntax retrieval from the root Constituent.
toSyntax(CliContext) - Method in class org.refcodes.cli.AllCondition: This method is to be called from inside the Constituent hierarchy; use the method Synopsisable.toSynopsis(SyntaxNotation) in case you invoke syntax retrieval from the root Constituent.
toSyntax(CliContext) - Method in class org.refcodes.cli.AndCondition: This method is to be called from inside the Constituent hierarchy; use the method Synopsisable.toSynopsis(SyntaxNotation) in case you invoke syntax retrieval from the root Constituent.
toSyntax(CliContext) - Method in class org.refcodes.cli.AnyCondition: This method is to be called from inside the Constituent hierarchy; use the method Synopsisable.toSynopsis(SyntaxNotation) in case you invoke syntax retrieval from the root Constituent.
toSyntax(CliContext) - Method in class org.refcodes.cli.ArrayOperand: This method is to be called from inside the Constituent hierarchy; use the method Synopsisable.toSynopsis(SyntaxNotation) in case you invoke syntax retrieval from the root Constituent.
toSyntax(CliContext) - Method in class org.refcodes.cli.ArrayOption: This method is to be called from inside the Constituent hierarchy; use the method Synopsisable.toSynopsis(SyntaxNotation) in case you invoke syntax retrieval from the root Constituent.
toSyntax(CliContext) - Method in interface org.refcodes.cli.Constituent: This method is to be called from inside the Constituent hierarchy; use the method Synopsisable.toSynopsis(SyntaxNotation) in case you invoke syntax retrieval from the root Constituent.
toSyntax(CliContext) - Method in class org.refcodes.cli.Flag: This method is to be called from inside the Constituent hierarchy; use the method Synopsisable.toSynopsis(SyntaxNotation) in case you invoke syntax retrieval from the root Constituent.
toSyntax(CliContext) - Method in class org.refcodes.cli.NoneOperand: This method is to be called from inside the Constituent hierarchy; use the method Synopsisable.toSynopsis(SyntaxNotation) in case you invoke syntax retrieval from the root Constituent.
toSyntax(CliContext) - Method in class org.refcodes.cli.Operation: This method is to be called from inside the Constituent hierarchy; use the method Synopsisable.toSynopsis(SyntaxNotation) in case you invoke syntax retrieval from the root Constituent.
toSyntax(SyntaxNotation) - Method in interface org.refcodes.cli.Constituent: This method is to be called from inside the Constituent hierarchy; use the method Synopsisable.toSynopsis(SyntaxNotation) in case you invoke syntax retrieval from the root Constituent.
toSyntax(SyntaxNotation, String, String, String) - Method in interface org.refcodes.cli.Constituent: This method is to be called from inside the Constituent hierarchy; use the method Synopsisable.toSynopsis(SyntaxNotation) in case you invoke syntax retrieval from the root Constituent.
toSyntaxNotation(String) - Static method in enum class org.refcodes.cli.SyntaxNotation: Retrieves a SyntaxNotation depending on the given string, ignoring the case as well as being graceful regarding "-" and "_",.
toType(String) - Method in class org.refcodes.cli.AbstractOperand: Double dispatch hook to be implemented by subclasses of the AbstractOperand for converting a command line argument to the required Operand's type.
toType(String) - Method in class org.refcodes.cli.CharOption: Double dispatch hook to be implemented by subclasses of the AbstractOperand for converting a command line argument to the required Operand's type.
toType(String) - Method in class org.refcodes.cli.DoubleOption: Double dispatch hook to be implemented by subclasses of the AbstractOperand for converting a command line argument to the required Operand's type.
toType(String) - Method in class org.refcodes.cli.EnumOption: Double dispatch hook to be implemented by subclasses of the AbstractOperand for converting a command line argument to the required Operand's type.
toType(String) - Method in class org.refcodes.cli.FileOption: Double dispatch hook to be implemented by subclasses of the AbstractOperand for converting a command line argument to the required Operand's type.
toType(String) - Method in class org.refcodes.cli.Flag: Double dispatch hook to be implemented by subclasses of the AbstractOperand for converting a command line argument to the required Operand's type.
toType(String) - Method in class org.refcodes.cli.FloatOption: Double dispatch hook to be implemented by subclasses of the AbstractOperand for converting a command line argument to the required Operand's type.
toType(String) - Method in class org.refcodes.cli.IntOption: Double dispatch hook to be implemented by subclasses of the AbstractOperand for converting a command line argument to the required Operand's type.
toType(String) - Method in class org.refcodes.cli.LongOption: Double dispatch hook to be implemented by subclasses of the AbstractOperand for converting a command line argument to the required Operand's type.
toType(String) - Method in class org.refcodes.cli.NoneOperand: To value.
toType(String) - Method in class org.refcodes.cli.Operation: Double dispatch hook to be implemented by subclasses of the AbstractOperand for converting a command line argument to the required Operand's type.
toType(String) - Method in class org.refcodes.cli.StringOperand: To value.
toType(String) - Method in class org.refcodes.cli.StringOption: Double dispatch hook to be implemented by subclasses of the AbstractOperand for converting a command line argument to the required Operand's type.
toValue(String) - Method in class org.refcodes.cli.AbstractCondition: Searches for a value being set for the given for given alias in the syntax tree parsing the command line arguments; if a node in the syntax tree has a value for the given alias, then this value is returned.
toValue(String) - Method in interface org.refcodes.cli.Constituent: Searches for a value being set for the given for given alias in the syntax tree parsing the command line arguments; if a node in the syntax tree has a value for the given alias, then this value is returned.
toValue(String) - Method in interface org.refcodes.cli.Operand: Searches for a value being set for the given for given alias in the syntax tree parsing the command line arguments; if a node in the syntax tree has a value for the given alias, then this value is returned.

U

UnknownArgsException - Exception in org.refcodes.cli: Thrown in case command line arguments were not processed (did not match the expected arguments), e.g. the arguments were rejected as them did not work for the according syntax.
UnknownArgsException(String[], String) - Constructor for exception org.refcodes.cli.UnknownArgsException: Instantiates a new unknown args exception.
UnknownArgsException(String[], String, String) - Constructor for exception org.refcodes.cli.UnknownArgsException: Instantiates a new unknown args exception.
UnknownArgsException(String[], String, Throwable) - Constructor for exception org.refcodes.cli.UnknownArgsException: Instantiates a new unknown args exception.
UnknownArgsException(String[], String, Throwable, String) - Constructor for exception org.refcodes.cli.UnknownArgsException: Instantiates a new unknown args exception.
UnknownArgsException(String[], Throwable) - Constructor for exception org.refcodes.cli.UnknownArgsException: Instantiates a new unknown args exception.
UnknownArgsException(String[], Throwable, String) - Constructor for exception org.refcodes.cli.UnknownArgsException: Instantiates a new unknown args exception.

V

valueOf(String) - Static method in enum class org.refcodes.cli.ArgsFilter: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class org.refcodes.cli.SyntaxNotation: Returns the enum constant of this class with the specified name.
values() - Static method in enum class org.refcodes.cli.ArgsFilter: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class org.refcodes.cli.SyntaxNotation: Returns an array containing the constants of this enum class, in the order they are declared.
VERBOSE - Enum constant in enum class org.refcodes.cli.SyntaxNotation: A verbose notation using words instead of single character symbols.
verboseFlag() - Static method in class org.refcodes.cli.CliSugar: Constructs the predefined verbose Flag.
verboseFlag(boolean) - Static method in class org.refcodes.cli.CliSugar: Constructs the predefined verbose Flag.
verboseFlag(String) - Static method in class org.refcodes.cli.CliSugar: Constructs the predefined verbose Flag.
VerboseFlag - Class in org.refcodes.cli: 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.
VerboseFlag() - Constructor for class org.refcodes.cli.VerboseFlag: Constructs the predefined verbose Flag.
VerboseFlag(boolean) - Constructor for class org.refcodes.cli.VerboseFlag: Constructs the predefined verbose Flag.
VerboseFlag(String) - Constructor for class org.refcodes.cli.VerboseFlag: Constructs the predefined verbose Flag.
VerboseFlag(String, boolean) - Constructor for class org.refcodes.cli.VerboseFlag: Constructs the predefined clean Flag.

W

WINDOWS - Enum constant in enum class org.refcodes.cli.SyntaxNotation: A notation which tries to mimic CMD's notation and in case of lack of CMD notation conventions, the SyntaxNotation.GNU_POSIX equivalent is used.
withAllSymbol(String) - Method in class org.refcodes.cli.SyntaxMetricsImpl.Builder: Sets the symbol for representing an ALL notation.
withAndSymbol(String) - Method in class org.refcodes.cli.SyntaxMetricsImpl.Builder: Sets the symbol for representing an AND notation.
withAnySymbol(String) - Method in class org.refcodes.cli.SyntaxMetricsImpl.Builder: Sets the symbol for representing an ANY notation.
withArgsParser(ArgsParser) - Method in interface org.refcodes.cli.ArgsParserAccessor.ArgsParserBuilder: Sets the args-parser for the ArgsParser property.
withArgsSyntax(Constituent) - Method in interface org.refcodes.cli.ArgsSyntaxAccessor.ArgsSyntaxBuilder: Sets the root condition for the root condition property.
withArgumentEscapeCode(String) - Method in interface org.refcodes.cli.ArgsParser: Sets the parameter Escape-Code for the parameter Escape-Code property.
withArgumentEscapeCode(String) - Method in interface org.refcodes.cli.ArgumentEscapeCodeAccessor.ArgumentEscapeCodeBuilder: Sets the argument Escape-Code for the argument Escape-Code property.
withArgumentEscapeCode(String) - Method in class org.refcodes.cli.CliContext.Builder: Sets the argument Escape-Code for the argument Escape-Code property.
withArgumentPrefix(String) - Method in interface org.refcodes.cli.ArgumentPrefixAccessor.ArgumentPrefixBuilder: Sets the argument prefix for the argument prefix property.
withArgumentPrefix(String) - Method in class org.refcodes.cli.SyntaxMetricsImpl.Builder: Sets the argument prefix for the argument prefix property.
withArgumentSuffix(String) - Method in interface org.refcodes.cli.ArgumentSuffixAccessor.ArgumentSuffixBuilder: Sets the argument suffix for the argument suffix property.
withArgumentSuffix(String) - Method in class org.refcodes.cli.SyntaxMetricsImpl.Builder: Sets the argument suffix for the argument suffix property.
withBannerBorderEscapeCode(String) - Method in interface org.refcodes.cli.ArgsParser: Sets the banner's border Escape-Code for the banner border Escape-Code property.
withBannerEscapeCode(String) - Method in interface org.refcodes.cli.ArgsParser: Sets the banner's content Escape-Code for the banner Escape-Code property.
withBannerFont(Font) - Method in interface org.refcodes.cli.ArgsParser: With banner font.
withBannerFontPalette(char[]) - Method in interface org.refcodes.cli.ArgsParser: With banner font palette.
withBeginArraySymbol(String) - Method in class org.refcodes.cli.SyntaxMetricsImpl.Builder: Sets the symbol representing the beginning of an array, e.g. an opening square brace.
withBeginListSymbol(String) - Method in class org.refcodes.cli.SyntaxMetricsImpl.Builder: Sets the symbol representing the beginning of a list, e.g. an opening brace.
withBeginOptionalSymbol(String) - Method in class org.refcodes.cli.SyntaxMetricsImpl.Builder: Sets the symbol representing the beginning optional elements, e.g. an opening square brace.
withBeginRangeSymbol(String) - Method in class org.refcodes.cli.SyntaxMetricsImpl.Builder: Sets the symbol representing the beginning of a range, e.g. an opening square brace.
withCliContext(CliContext) - Method in interface org.refcodes.cli.CliContextAccessor.RootConditionBuilder: Sets the CliContext for the CliContext property.
withCommandEscapeCode(String) - Method in interface org.refcodes.cli.ArgsParser: Sets the command name's (CLI executable) Escape-Code for the command name Escape-Code property.
withConsoleWidth(int) - Method in interface org.refcodes.cli.ArgsParser: Set the console with.
withCopyrightNote(String) - Method in interface org.refcodes.cli.ArgsParser: Set the copyright note used by the ArgsParser.printHelp() method when writing out the copyright claim and make other adjustments with the result (with regards to the Builder-Pattern).
withDescription(String) - Method in interface org.refcodes.cli.ArgsParser: With description.
withDescriptionEscapeCode(String) - Method in interface org.refcodes.cli.ArgsParser: Sets the description Escape-Code for the description Escape-Code property.
withEMptySymbol(String) - Method in class org.refcodes.cli.SyntaxMetricsImpl.Builder: Sets the symbol for representing an EMPTY notation.
withEndArraySymbol(String) - Method in class org.refcodes.cli.SyntaxMetricsImpl.Builder: Sets the symbol representing the end of an array, e.g. a closing square brace.
withEndListSymbol(String) - Method in class org.refcodes.cli.SyntaxMetricsImpl.Builder: Sets the symbol representing the end of a list, e.g. a closing brace.
withEndOptionalSymbol(String) - Method in class org.refcodes.cli.SyntaxMetricsImpl.Builder: Sets the symbol representing the end of optional elements, e.g. a closing square brace.
withEndRangeSymbol(String) - Method in class org.refcodes.cli.SyntaxMetricsImpl.Builder: Sets the symbol representing the end of a range, e.g. a closing square brace.
withErrorOut(PrintStream) - Method in interface org.refcodes.cli.ArgsParser: Set the error out PrintStream and make other adjustments with the result (with regards to the Builder-Pattern).
withEscapeCodesEnabled(boolean) - Method in interface org.refcodes.cli.ArgsParser
withEscapeCodesEnabled(boolean) - Method in class org.refcodes.cli.CliContext.Builder
withEvalArgs(String[]) - Method in interface org.refcodes.cli.ArgsParser: Same as ArgsParser.evalArgs(String[]) with the difference that this class's instance being invoked is returned as of the builder pattern.
withEvalArgs(String[]) - Method in interface org.refcodes.cli.ArgsParserMixin: Evaluates the provided command line arguments.
withEvalArgs(String[], Pattern) - Method in interface org.refcodes.cli.ArgsParserMixin: Evaluates the provided command line arguments, filtering (excluding) the arguments matching the provided Pattern.
withEvalArgs(String[], ArgsFilter) - Method in interface org.refcodes.cli.ArgsParserMixin: Evaluates the provided command line arguments, filtering (excluding) the arguments matching the provided ArgsFilter.
withEvalArgs(List<String>) - Method in interface org.refcodes.cli.ArgsParser: Same as ArgsParser.evalArgs(List) with the difference that this class's instance being invoked is returned as of the builder pattern.
withEvalArgs(List<String>) - Method in interface org.refcodes.cli.ArgsParserMixin: Evaluates the provided command line arguments .
withEvalArgs(List<String>, Pattern) - Method in interface org.refcodes.cli.ArgsParserMixin: Evaluates the provided command line arguments, filtering (excluding) the arguments matching the provided Pattern.
withEvalArgs(List<String>, ArgsFilter) - Method in interface org.refcodes.cli.ArgsParserMixin: Evaluates the provided command line arguments, filtering (excluding) the arguments matching the provided ArgsFilter.
withExample(String, Operand<?>...) - Method in interface org.refcodes.cli.ArgsParser: Adds a usage example by providing a description of the example and the command line arguments required by the example.
withExample(Example) - Method in interface org.refcodes.cli.ArgsParser: Adds a usage example.
withExamples(Collection<Example>) - Method in interface org.refcodes.cli.ArgsParser: Adds all the bunch of Example elements provided.
withExamples(Example[]) - Method in interface org.refcodes.cli.ArgsParser: Adds all the bunch of Example elements provided.
withIntervalSymbol(String) - Method in class org.refcodes.cli.SyntaxMetricsImpl.Builder: Sets the symbol representing an interval, e.g. "..." or "-".
withLicenseNote(String) - Method in interface org.refcodes.cli.ArgsParser: Set the license note used by the ArgsParser.printHelp() method when writing out the licensing conditions and make other adjustments with the result (with regards to the Builder-Pattern).
withLineBreak(String) - Method in interface org.refcodes.cli.ArgsParser: Set the console's line break.
withLineSeparatorEscapeCode(String) - Method in interface org.refcodes.cli.ArgsParser: Sets the line separator Escape-Code for the line separator Escape-Code property.
withLongOptionPrefix(String) - Method in interface org.refcodes.cli.ArgsParser: Sets the long option prefix for the long option prefix property.
withLongOptionPrefix(String) - Method in interface org.refcodes.cli.LongOptionPrefixAccessor.LongOptionPrefixBuilder: Sets the long option prefix for the long option prefix property.
withLongOptionPrefix(String) - Method in class org.refcodes.cli.SyntaxMetricsImpl.Builder: Sets the long option prefix for the long option prefix property.
withMaxConsoleWidth(int) - Method in interface org.refcodes.cli.ArgsParser: Set the maximum console width to use in case the console width is greater than the maximum you want.
withName(String) - Method in interface org.refcodes.cli.ArgsParser: With name.
withOptionEscapeCode(String) - Method in interface org.refcodes.cli.ArgsParser: Sets the option Escape-Code for the option Escape-Code property.
withOptionEscapeCode(String) - Method in class org.refcodes.cli.CliContext.Builder: Sets the option Escape-Code for the option Escape-Code property.
withOptionEscapeCode(String) - Method in interface org.refcodes.cli.OptionEscapeCodeAccessor.OptionEscapeCodeBuilder: Sets the option Escape-Code for the option Escape-Code property.
withOrSymbol(String) - Method in class org.refcodes.cli.SyntaxMetricsImpl.Builder: Sets the symbol for representing an OR notation.
withResetEscapeCode(String) - Method in interface org.refcodes.cli.ArgsParser
withResetEscapeCode(String) - Method in class org.refcodes.cli.CliContext.Builder
withSeparatorLnChar(char) - Method in interface org.refcodes.cli.ArgsParser: Set the character to be used when printing a separator line with the ArgsParser.printSeparatorLn() method.
withShortOptionPrefix(Character) - Method in interface org.refcodes.cli.ArgsParser: Sets the short option prefix for the short option prefix property.
withShortOptionPrefix(Character) - Method in interface org.refcodes.cli.ShortOptionPrefixAccessor.ShortOptionPrefixBuilder: Sets the short option prefix for the short option prefix property.
withShortOptionPrefix(Character) - Method in class org.refcodes.cli.SyntaxMetricsImpl.Builder: Sets the short option prefix for the short option prefix property.
withStandardOut(PrintStream) - Method in interface org.refcodes.cli.ArgsParser: Set the standard out PrintStream and make other adjustments with the result (with regards to the Builder-Pattern).
withSyntaxMetrics(SyntaxMetrics) - Method in interface org.refcodes.cli.ArgsParser: Set the SyntaxNotation and make other adjustments with the result (with regards to the Builder-Pattern).
withSyntaxMetrics(SyntaxMetrics) - Method in class org.refcodes.cli.CliContext.Builder: Sets the SyntaxMetrics for the SyntaxMetrics property.
withSyntaxMetrics(SyntaxMetrics) - Method in interface org.refcodes.cli.SyntaxMetricsAccessor.SyntaxMetricsBuilder: Sets the SyntaxMetrics for the SyntaxMetrics property.
withTextBoxGrid(TextBoxGrid) - Method in interface org.refcodes.cli.ArgsParser
withTitle(String) - Method in interface org.refcodes.cli.ArgsParser: With title.
withXorSymbol(String) - Method in class org.refcodes.cli.SyntaxMetricsImpl.Builder: Sets the symbol for representing an XOR notation.

X

xor(Constituent...) - Static method in class org.refcodes.cli.CliSugar: Instantiates a new XorCondition with the Constituent (Condition) instances to be nested.
XorCondition - Class in org.refcodes.cli: An XorCondition represents a list of Condition (Constituent) instances of which only one is allowed to be parsed successfully when the parseArgs(String[], String[], CliContext) methods are invoked.
XorCondition(String, Constituent...) - Constructor for class org.refcodes.cli.XorCondition: Instantiates a new XorCondition with the Constituent (Condition) instances to be nested.
XorCondition(Constituent...) - Constructor for class org.refcodes.cli.XorCondition: Instantiates a new XorCondition with the Constituent (Condition) instances to be nested.
XX - Enum constant in enum class org.refcodes.cli.ArgsFilter: JVM command-line options that are specified with -XX: are not checked for validity.

_

_description - Variable in class org.refcodes.cli.AbstractCondition
_errStream - Variable in class org.refcodes.cli.ArgsParserImpl
_stdStream - Variable in class org.refcodes.cli.ArgsParserImpl
_value - Variable in class org.refcodes.cli.AbstractOperand

A B C D E F G H I L N O P Q R S T U V W X _
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form