A C D E F G H I L N O P Q R S T U V W X _
All Classes All Packages

A

AbstractCondition - Class in org.refcodes.cli

The AbstractCondition is an abstract implementation of the ArgsSyntax interface providing the boiler plate when implementing the ArgsSyntax interface as done by the AbstractCondition's sub-classes.

AbstractCondition(Syntaxable...) - 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(String, String, Class<T>, String) - Constructor for class org.refcodes.cli.AbstractOption

Constructs a Option with the given arguments.

AbstractOption(String, String, Class<T>, String, String) - Constructor for class org.refcodes.cli.AbstractOption

Constructs a Option with the given arguments.

AbstractOption(Relation<String, T>, Class<T>) - Constructor for class org.refcodes.cli.AbstractOption

Instantiates a new option.

addChild(Syntaxable) - 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(Syntaxable) - Static method in class org.refcodes.cli.CliSugar

Instantiates a new AllCondition with the Syntaxable (ArgsSyntax) instance to be nested.

AllCondition - Class in org.refcodes.cli

The AllCondition enforces that the encapsulated Syntaxable consumes all arguments passed via invoking its Syntaxable.parseArgs(String[]), else a SuperfluousArgsException is thrown.

AllCondition(Syntaxable) - Constructor for class org.refcodes.cli.AllCondition

Instantiates a new AllCondition with the Syntaxable (ArgsSyntax) 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(Syntaxable...) - Static method in class org.refcodes.cli.CliSugar

Instantiates a new AndCondition with the Syntaxable (ArgsSyntax) instances to be nested.

AndCondition - Class in org.refcodes.cli

An AndCondition contains (represents) a list of ArgsSyntax (Syntaxable) instances (nested by the AndCondition) of which all are to be parsed successfully as of invoking the Syntaxable.parseArgs(String[], String[]) methods.

AndCondition(Syntaxable...) - Constructor for class org.refcodes.cli.AndCondition

Instantiates a new AndCondition with the Syntaxable (ArgsSyntax) instances to be nested.

any(Syntaxable...) - Static method in class org.refcodes.cli.CliSugar

Instantiates a new AnyCondition with the Syntaxable (ArgsSyntax) instances to be nested.

AnyCondition - Class in org.refcodes.cli

Any of the nested ArgsSyntax conditions may match for the AnyCondition to match, e.g. all of the nested conditions are optional.

AnyCondition(Syntaxable...) - Constructor for class org.refcodes.cli.AnyCondition

Instantiates a new AnyCondition with the Syntaxable (ArgsSyntax) 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.

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<B extends ArgsParserAccessor.ArgsParserBuilder<B>> - 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(ArgsSyntax) - Constructor for class org.refcodes.cli.ArgsParserImpl

Constructs the ArgsParser instance with the given root ArgsSyntax and the default SyntaxNotation.REFCODES.

ArgsParserImpl(Option<?>) - Constructor for class org.refcodes.cli.ArgsParserImpl

Constructs the ArgsParser instance with the given root Option and the default SyntaxNotation.REFCODES.

ArgsParserMixin<B extends ArgsParserMixin<B>> - 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.

ArgsSyntax - Interface in org.refcodes.cli

The ArgsSyntax interface represents a node (and therewith the syntax for the arguments) in the command line arguments syntax tree; simply extending the Syntaxable interface and adding the functionality of providing access to the added Operands (leafs).

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.

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.

C

cases(Syntaxable...) - Static method in class org.refcodes.cli.CliSugar

Instantiates a new CasesCondition with the Syntaxable (ArgsSyntax) 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(Syntaxable...) - Constructor for class org.refcodes.cli.CasesCondition

Instantiates a new CasesCondition with the Syntaxable (ArgsSyntax) instances to be nested.

charOption(String, String, String) - Static method in class org.refcodes.cli.CliSugar

Character option.

charOption(String, String, String, String) - Static method in class org.refcodes.cli.CliSugar

Character option.

CharOption - Class in org.refcodes.cli

The CharOption represents an Option holding String values.

CharOption(String, String, String) - Constructor for class org.refcodes.cli.CharOption

Instantiates a new character option.

CharOption(String, String, String, String) - Constructor for class org.refcodes.cli.CharOption

Instantiates a new character option.

CharOption(Relation<String, Character>) - Constructor for class org.refcodes.cli.CharOption

Instantiates a new character option.

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.

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.

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, ArgsSyntax, 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

Interface indicating that the ArgsSyntax semantically represents a condition which usally encapsulates other Syntaxable children.

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

Creates a ConfigOption representing a value specifying a configuration resource (file).

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

Instantiates a new configuration file option.

ConfigOption(String) - Constructor for class org.refcodes.cli.ConfigOption

Instantiates a new configuration 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.

contains(String[], String) - Static method in class org.refcodes.cli.CliUtility

Determines whether a given String is contained in the given String array.

D

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.

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.

doubleOption(String, String, String) - Static method in class org.refcodes.cli.CliSugar

Double option.

doubleOption(String, String, String, String) - Static method in class org.refcodes.cli.CliSugar

Double option.

DoubleOption - Class in org.refcodes.cli

The DoubleOption represents an Option holding double values.

DoubleOption(String, String, String) - Constructor for class org.refcodes.cli.DoubleOption

Instantiates a new long option impl.

DoubleOption(String, String, String, String) - Constructor for class org.refcodes.cli.DoubleOption

Instantiates a new long option impl.

DoubleOption(Relation<String, Double>) - Constructor for class org.refcodes.cli.DoubleOption

Instantiates a new long option impl.

E

enumOption(String, Class<T>, String, String) - Static method in class org.refcodes.cli.CliSugar

Instantiates a new enum option.

enumOption(String, String, Class<T>, String, String) - Static method in class org.refcodes.cli.CliSugar

Instantiates a new enum option.

EnumOption<T extends Enum<T>> - Class in org.refcodes.cli

The Class EnumOption.

EnumOption(String, Class<T>, String, String) - Constructor for class org.refcodes.cli.EnumOption

Instantiates a new enum option.

EnumOption(String, String, Class<T>, String, String) - Constructor for class org.refcodes.cli.EnumOption

Instantiates a new enum option.

EnumOption(Relation<String, T>, Class<T>) - Constructor for class org.refcodes.cli.EnumOption

Instantiates a new enum option.

errorLn(String) - Method in interface org.refcodes.cli.ArgsParser

Prints the given line to standard error with regards to 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 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 ArgsSyntax.

evalArgs(String[]) - Method in class org.refcodes.cli.ArgsParserImpl

Evaluates the provided command line arguments and determines the according values by evaluating the root ArgsSyntax.

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.

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(String, String, String) - Static method in class org.refcodes.cli.CliSugar

Creates a FileOption for getting a File instance from a path.

fileOption(String, String, String, String) - Static method in class org.refcodes.cli.CliSugar

Creates a FileOption for getting a File instance from a path.

FileOption - Class in org.refcodes.cli

The FileOption represents an Option holding File values.

FileOption(String, String, String) - Constructor for class org.refcodes.cli.FileOption

Instantiates a new file option.

FileOption(String, String, String, String) - Constructor for class org.refcodes.cli.FileOption

Instantiates a new file option.

FileOption(Relation<String, File>) - Constructor for class org.refcodes.cli.FileOption

Instantiates a new file option.

flag(String, String, String) - Static method in class org.refcodes.cli.CliSugar

As "switch" is a reserved word in Java, we use "flag" :-(.

flag(String, String, String, String) - Static method in class org.refcodes.cli.CliSugar

As "switch" is a reserved word in Java, we use "flag" :-(.

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(String, boolean) - Constructor for class org.refcodes.cli.Flag

Constructs a Flag.

Flag(String, String, String) - Constructor for class org.refcodes.cli.Flag

Constructs a Flag.

Flag(String, String, String, String) - Constructor for class org.refcodes.cli.Flag

Constructs a Flag.

floatOption(String, String, String) - Static method in class org.refcodes.cli.CliSugar

Float option.

floatOption(String, String, String, String) - Static method in class org.refcodes.cli.CliSugar

Float option.

FloatOption - Class in org.refcodes.cli

The FloatOption represents an Option holding float values.

FloatOption(String, String, String) - Constructor for class org.refcodes.cli.FloatOption

Instantiates a new long option impl.

FloatOption(String, String, String, String) - Constructor for class org.refcodes.cli.FloatOption

Instantiates a new long option impl.

FloatOption(Relation<String, Float>) - Constructor for class org.refcodes.cli.FloatOption

Instantiates a new long option impl.

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.

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 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.

getArgs() - Method in class org.refcodes.cli.AbstractOperand

Retrieves the command line arguments from the args property.

getArgs() - Method in interface org.refcodes.cli.ArgsAccessor

Retrieves the command line arguments from the args property.

getArgs() - Method in class org.refcodes.cli.ArrayOperand

Retrieves the command line arguments from the args property.

getArgs() - Method in exception org.refcodes.cli.CliException.ConsoleArgsException

Gets the args.

getArgs() - Method in interface org.refcodes.cli.Operand

Retrieves the command line arguments from the args property.

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 Syntaxable 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 Syntaxable 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.RootConditionAccessor

Retrieves the root condition from the root condition 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.

getChildren() - Method in class org.refcodes.cli.AbstractCondition

Gets the children.

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.AbstractOperand

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.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.

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...).

getFirst() - Method in class org.refcodes.cli.AbstractCondition

Gets the first child.

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.

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.

getOptionArgument(Option<?>, String[], String[]) - Static method in class org.refcodes.cli.CliUtility

Takes the Option's short-option and long-option and tries to determine that Option's value in the provided command line arguments.

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.

getOptionPrefixes() - Method in class org.refcodes.cli.AbstractOption

Determines the prefixes suitable for the environment.

getOptions() - Method in interface org.refcodes.cli.Option

Retrieves an array of the options being configured for the implementing instance, being the long option (when set) and the short option (when set).

getParamEscapeCode() - Method in interface org.refcodes.cli.ArgsParser

Retrieves the parameter Escape-Code from the parameter Escape-Code property.

getParamEscapeCode() - Method in class org.refcodes.cli.ArgsParserImpl

Retrieves the parameter Escape-Code from the parameter Escape-Code property.

getResetEscapeCode() - Method in class org.refcodes.cli.ArgsParserImpl

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.

getStatusCode() - Method in exception org.refcodes.cli.CliException.ConsoleCliException

Gets the status code.

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 interface org.refcodes.cli.Operand

GNU_POSIX - 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 Syntaxable.parseArgs(String[], String[]) 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 switch.

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.

intOption(String, String, String) - Static method in class org.refcodes.cli.CliSugar

Int option.

intOption(String, String, String, String) - Static method in class org.refcodes.cli.CliSugar

Int option.

IntOption - Class in org.refcodes.cli

The IntOption represents an Option holding int values.

IntOption(String, String, String) - Constructor for class org.refcodes.cli.IntOption

Instantiates a new integer option impl.

IntOption(String, String, String, String) - Constructor for class org.refcodes.cli.IntOption

Instantiates a new integer option impl.

IntOption(Relation<String, Integer>) - Constructor for class org.refcodes.cli.IntOption

Instantiates a new integer option impl.

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

isOptionArgument(String) - Static method in class org.refcodes.cli.CliUtility

Determines whether the provided String starts with one of the prefixes Identifying an Option.

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).

letRootArgsSyntax(ArgsSyntax) - Method in interface org.refcodes.cli.RootConditionAccessor.RootConditionProperty

This method stores and passes through the given argument, which is very useful for builder APIs: Sets the given ArgsSyntax (setter) as of RootConditionAccessor.RootConditionMutator.setRootArgsSyntax(ArgsSyntax) and returns the very same value (getter).

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(String, String, String) - Static method in class org.refcodes.cli.CliSugar

Long option.

longOption(String, String, String, String) - Static method in class org.refcodes.cli.CliSugar

Long option.

LongOption - Class in org.refcodes.cli

The LongOption represents an Option holding long values.

LongOption(String, String, String) - Constructor for class org.refcodes.cli.LongOption

Instantiates a new long option impl.

LongOption(String, String, String, String) - Constructor for class org.refcodes.cli.LongOption

Instantiates a new long option impl.

LongOption(Relation<String, Long>) - Constructor for class org.refcodes.cli.LongOption

Instantiates a new long option impl.

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.

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.

optional(Syntaxable...) - Static method in class org.refcodes.cli.CliSugar

Semantically identical synonym for the CliSugar.optional(Syntaxable...) declaration.

OptionCondition - Class in org.refcodes.cli

A no-operation ArgsSyntax used to wrap an Option in places where a ArgsSyntax is expected.

OptionCondition(Option<?>) - Constructor for class org.refcodes.cli.OptionCondition

Instantiates a new OptionCondition with the Option (Syntaxable) instance to be wrapped.

or(Syntaxable...) - Static method in class org.refcodes.cli.CliSugar

Instantiates a new OrCondition with the Syntaxable (ArgsSyntax) instances to be nested.

OrCondition - Class in org.refcodes.cli

An OrCondition represents a list of ArgsSyntax (Syntaxable) instances of which at least one must be parsed successfully when the Syntaxable s' Syntaxable.parseArgs(String[], String[]) methods are invoked.

OrCondition(Syntaxable...) - Constructor for class org.refcodes.cli.OrCondition

Instantiates a new OrCondition with the Syntaxable (ArgsSyntax) instances to be nested.

org.refcodes.cli - module org.refcodes.cli

org.refcodes.cli - package org.refcodes.cli

Getting started:

P

parseArgs(String[]) - Method in interface org.refcodes.cli.Syntaxable

Parses the provided command line arguments and determines the according values by evaluating this Syntaxable instance or, in case of being a node in the syntax tree (such as a ArgsSyntax, traversing the child Syntaxable instances' Syntaxable.parseArgs(String[], String[]) methods.

parseArgs(String[], String[]) - Method in class org.refcodes.cli.AbstractOperand

Parses the provided command line arguments and determines the according values by evaluating this Syntaxable instance or, in case of being a node in the syntax tree (such as a ArgsSyntax, traversing the child Syntaxable instances' Syntaxable.parseArgs(String[], String[]) methods.

parseArgs(String[], String[]) - Method in class org.refcodes.cli.AbstractOption

Parses the provided command line arguments and determines the according values by evaluating this Syntaxable instance or, in case of being a node in the syntax tree (such as a ArgsSyntax, traversing the child Syntaxable instances' Syntaxable.parseArgs(String[], String[]) methods.

parseArgs(String[], String[]) - Method in class org.refcodes.cli.AllCondition

Parses the provided command line arguments and determines the according values by evaluating this Syntaxable instance or, in case of being a node in the syntax tree (such as a ArgsSyntax, traversing the child Syntaxable instances' Syntaxable.parseArgs(String[], String[]) methods.

parseArgs(String[], String[]) - Method in class org.refcodes.cli.AndCondition

Parses the provided command line arguments and determines the according values by evaluating this Syntaxable instance or, in case of being a node in the syntax tree (such as a ArgsSyntax, traversing the child Syntaxable instances' Syntaxable.parseArgs(String[], String[]) methods.

parseArgs(String[], String[]) - Method in class org.refcodes.cli.AnyCondition

Parses the provided command line arguments and determines the according values by evaluating this Syntaxable instance or, in case of being a node in the syntax tree (such as a ArgsSyntax, traversing the child Syntaxable instances' Syntaxable.parseArgs(String[], String[]) methods.

parseArgs(String[], String[]) - Method in class org.refcodes.cli.ArrayOperand

Parses the provided command line arguments and determines the according values by evaluating this Syntaxable instance or, in case of being a node in the syntax tree (such as a ArgsSyntax, traversing the child Syntaxable instances' Syntaxable.parseArgs(String[], String[]) methods.

parseArgs(String[], String[]) - Method in class org.refcodes.cli.Flag

Parses the provided command line arguments and determines the according values by evaluating this Syntaxable instance or, in case of being a node in the syntax tree (such as a ArgsSyntax, traversing the child Syntaxable instances' Syntaxable.parseArgs(String[], String[]) methods.

parseArgs(String[], String[]) - Method in class org.refcodes.cli.NoneOperand

Parses the provided command line arguments and determines the according values by evaluating this Syntaxable instance or, in case of being a node in the syntax tree (such as a ArgsSyntax, traversing the child Syntaxable instances' Syntaxable.parseArgs(String[], String[]) methods.

parseArgs(String[], String[]) - Method in class org.refcodes.cli.Operation

Parses the provided command line arguments and determines the according values by evaluating this Syntaxable instance or, in case of being a node in the syntax tree (such as a ArgsSyntax, traversing the child Syntaxable instances' Syntaxable.parseArgs(String[], String[]) methods.

parseArgs(String[], String[]) - Method in class org.refcodes.cli.OptionCondition

Parses the provided command line arguments and determines the according values by evaluating this Syntaxable instance or, in case of being a node in the syntax tree (such as a ArgsSyntax, traversing the child Syntaxable instances' Syntaxable.parseArgs(String[], String[]) methods.

parseArgs(String[], String[]) - Method in class org.refcodes.cli.OrCondition

Parses the provided command line arguments and determines the according values by evaluating this Syntaxable instance or, in case of being a node in the syntax tree (such as a ArgsSyntax, traversing the child Syntaxable instances' Syntaxable.parseArgs(String[], String[]) methods.

parseArgs(String[], String[]) - Method in interface org.refcodes.cli.Syntaxable

Parses the provided command line arguments and determines the according values by evaluating this Syntaxable instance or, in case of being a node in the syntax tree (such as a ArgsSyntax, traversing the child Syntaxable instances' Syntaxable.parseArgs(String[], String[]) methods.

parseArgs(String[], String[]) - Method in class org.refcodes.cli.XorCondition

Parses the provided command line arguments and determines the according values by evaluating this Syntaxable instance or, in case of being a node in the syntax tree (such as a ArgsSyntax, traversing the child Syntaxable instances' Syntaxable.parseArgs(String[], String[]) 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 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 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.

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 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 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 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 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 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 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 ArgsSyntax element as of Synopsis.toSynopsis(SyntaxNotation) with regards to the SyntaxNotation set by the ArgsParser.withSyntaxNotation(SyntaxNotation) method.

printSynopsis() - Method in class org.refcodes.cli.ArgsParserImpl

Prints the syntax as retrieved by the root ArgsSyntax element as of Synopsis.toSynopsis(SyntaxNotation) with regards to the SyntaxNotation set by the ArgsParser.withSyntaxNotation(SyntaxNotation) 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.

R

REFCODES - 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.

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

RootConditionAccessor - Interface in org.refcodes.cli

Provides an accessor for a root condition property.

RootConditionAccessor.RootConditionBuilder<B extends RootConditionAccessor.RootConditionBuilder<B>> - Interface in org.refcodes.cli

Provides a builder method for a root condition property returning the builder for applying multiple build operations.

RootConditionAccessor.RootConditionMutator - Interface in org.refcodes.cli

Provides a mutator for a root condition property.

RootConditionAccessor.RootConditionProperty - Interface in org.refcodes.cli

Provides a root condition property.

S

setArgs(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[]) method.

setArgs(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[]) method.

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.

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.

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.

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.

setParamEscapeCode(String) - Method in interface org.refcodes.cli.ArgsParser

Sets the parameter Escape-Code for the parameter Escape-Code property.

setParamEscapeCode(String) - Method in class org.refcodes.cli.ArgsParserImpl

Sets the parameter Escape-Code for the parameter Escape-Code property.

setResetEscapeCode(String) - Method in class org.refcodes.cli.ArgsParserImpl

setRootArgsSyntax(ArgsSyntax) - Method in interface org.refcodes.cli.RootConditionAccessor.RootConditionMutator

Sets the root condition for the root condition property.

setRootOption(Option<?>) - Method in interface org.refcodes.cli.RootConditionAccessor.RootConditionMutator

Sets the root option for the root condition property.

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.

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).

setSyntaxNotation(SyntaxNotation) - Method in interface org.refcodes.cli.ArgsParser

Set the SyntaxNotation.

setSyntaxNotation(SyntaxNotation) - Method in class org.refcodes.cli.ArgsParserImpl

Set the SyntaxNotation.

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[]) method.

setValue(T) - Method in class org.refcodes.cli.AbstractOption

Sets the value for the Operand as parsed by the AbstractOperand.parseArgs(String[], String[]) 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

stringOperand(String, String) - Static method in class org.refcodes.cli.CliSugar

String operand.

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 string operand.

StringOperand(Relation<String, String>) - Constructor for class org.refcodes.cli.StringOperand

Instantiates a new string operand.

stringOption(String, String, String) - Static method in class org.refcodes.cli.CliSugar

String option.

stringOption(String, String, String, String) - Static method in class org.refcodes.cli.CliSugar

String option.

StringOption - Class in org.refcodes.cli

The StringOption represents an Option holding String values.

StringOption(String, String, String) - Constructor for class org.refcodes.cli.StringOption

Instantiates a new string option.

StringOption(String, String, String, String) - Constructor for class org.refcodes.cli.StringOption

Instantiates a new string option.

StringOption(Relation<String, String>) - Constructor for class org.refcodes.cli.StringOption

Instantiates a new string option.

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.

Synopsis - Interface in org.refcodes.cli

The Synopsis interface defines those methods required to create a human readable usage String from the implementing instance.

Syntaxable - Interface in org.refcodes.cli

A Syntaxable 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.

SyntaxNotation - Enum in org.refcodes.cli

The SyntaxNotation is used by a the Syntaxable.toSyntax(SyntaxNotation, String, String, String) 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.

T

toArgs(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.getArgs()) to the result.

toDiff(String[], String[]) - Static method in class org.refcodes.cli.CliUtility

Creates the difference between the provided set and the provided subset.

toDiff(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.getArgs()).

toOperand(Class<T>) - Method in interface org.refcodes.cli.ArgsSyntax

Traverses the hierarchy of ArgsSyntax tree and returns the (first) operand matching the given type.

toOperand(String) - Method in interface org.refcodes.cli.ArgsSyntax

Traverses the hierarchy of ArgsSyntax 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 ArgsSyntax tree and returns the (first) operand matching the given alias and type.

toOperand(String, Class<T>) - Method in interface org.refcodes.cli.ArgsSyntax

Traverses the hierarchy of ArgsSyntax tree and returns the (first) operand matching the given alias and type.

toOperands() - Method in class org.refcodes.cli.AbstractCondition

Traverses the hierarchy of ArgsSyntaxs and collects all therein found Operands and sub-types such as the Flag or the Option.

toOperands() - Method in interface org.refcodes.cli.ArgsSyntax

Traverses the hierarchy of ArgsSyntaxs and collects all therein found Operands and sub-types such as the Flag or the Option.

toOptionsSpec(Operand<?>) - Static method in class org.refcodes.cli.CliUtility

Creates the options specification containing the short option (if any) and the long option (if any) from the provided Operand.

toOptionsSpec(Operand<?>, String, String) - Static method in class org.refcodes.cli.CliUtility

Creates the options specification containing the short option (if any) and the long option (if any) from the provided Operand.

toParameterSpec(Operand<?>) - Static method in class org.refcodes.cli.CliUtility

Creates the parameter specification from the provided Operand.

toParameterSpec(Operand<?>, int, int) - Static method in class org.refcodes.cli.CliUtility

Creates the parameter specification from the provided Operand.

toParameterSpec(Operand<?>, int, int, String, String) - Static method in class org.refcodes.cli.CliUtility

Creates the parameter specification from the provided Operand.

toParameterSpec(Operand<?>, String, String) - Static method in class org.refcodes.cli.CliUtility

Creates the parameter specification from the provided Operand.

toShortOptionsSpec(Operand<?>) - Static method in class org.refcodes.cli.CliUtility

Creates the options specification containing the short option only (if any) or(!)

toShortOptionsSpec(Operand<?>, String, String) - Static method in class org.refcodes.cli.CliUtility

Creates the options specification containing the short option only (if any) or(!)

toShortSpec(Operand<?>) - Static method in class org.refcodes.cli.CliUtility

Creates a specification for the given Operand consisting of the short option specification (if any) or the long option specification(if any) and the parameter specification (if any) as of CliUtility.toParameterSpec(Operand).

toShortSpec(Operand<?>, String, String, String) - Static method in class org.refcodes.cli.CliUtility

Creates a specification for the given Operand consisting of the short option specification (if any) or the long option specification(if any) and the parameter specification (if any) as of CliUtility.toParameterSpec(Operand).

toSpec(Operand<?>) - Static method in class org.refcodes.cli.CliUtility

Creates a specification for the given Operand consisting of the options specification (if any) as of CliUtility.toOptionsSpec(Operand) and the parameter specification (if any) as of CliUtility.toParameterSpec(Operand).

toSpec(Operand<?>, String, String, String) - Static method in class org.refcodes.cli.CliUtility

Creates a specification for the given Operand consisting of the options specification (if any) as of CliUtility.toOptionsSpec(Operand) and the parameter specification (if any) as of CliUtility.toParameterSpec(Operand).

toState() - Method in class org.refcodes.cli.AbstractOperand

The Syntaxable.toState() method might be used by the Object.toString() method and prints out the state of the syntaxable and (if any) its children.

toState() - Method in class org.refcodes.cli.AbstractOption

The Syntaxable.toState() method might be used by the Object.toString() method and prints out the state of the syntaxable and (if any) its children.

toState() - Method in class org.refcodes.cli.AllCondition

The Syntaxable.toState() method might be used by the Object.toString() method and prints out the state of the syntaxable and (if any) its children.

toState() - Method in class org.refcodes.cli.AndCondition

The Syntaxable.toState() method might be used by the Object.toString() method and prints out the state of the syntaxable and (if any) its children.

toState() - Method in class org.refcodes.cli.AnyCondition

The Syntaxable.toState() method might be used by the Object.toString() method and prints out the state of the syntaxable and (if any) its children.

toState() - Method in class org.refcodes.cli.ArrayOperand

The Syntaxable.toState() method might be used by the Object.toString() method and prints out the state of the syntaxable and (if any) its children.

toState() - Method in class org.refcodes.cli.NoneOperand

The Syntaxable.toState() method might be used by the Object.toString() method and prints out the state of the syntaxable and (if any) its children.

toState() - Method in class org.refcodes.cli.Operation

The Syntaxable.toState() method might be used by the Object.toString() method and prints out the state of the syntaxable and (if any) its children.

toState() - Method in class org.refcodes.cli.OptionCondition

The Syntaxable.toState() method might be used by the Object.toString() method and prints out the state of the syntaxable and (if any) its children.

toState() - Method in class org.refcodes.cli.OrCondition

The Syntaxable.toState() method might be used by the Object.toString() method and prints out the state of the syntaxable and (if any) its children.

toState() - Method in interface org.refcodes.cli.Syntaxable

The Syntaxable.toState() method might be used by the Object.toString() method and prints out the state of the syntaxable and (if any) its children.

toState() - Method in class org.refcodes.cli.XorCondition

The Syntaxable.toState() method might be used by the Object.toString() method and prints out the state of the syntaxable and (if any) its children.

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

toSynopsis() - Method in interface org.refcodes.cli.Synopsis

Returns the human readable (verbose) syntax of implementing class ATTENTION: As of different parenthesis settings for some notations regarding the root Syntaxable and the child Syntaxables, the method Syntaxable.toSyntax(SyntaxNotation, String, String, String) is called from inside a Syntaxable hierarchy.

toSynopsis(String, String, String) - Method in interface org.refcodes.cli.Synopsis

Returns the human readable (verbose) syntax of implementing class ATTENTION: As of different parenthesis settings for some notations regarding the root Syntaxable and the child Syntaxables, the method Syntaxable.toSyntax(SyntaxNotation, String, String, String) is called from inside a Syntaxable hierarchy.

toSynopsis(SyntaxNotation) - Method in interface org.refcodes.cli.Synopsis

Returns the human readable (verbose) syntax of implementing class ATTENTION: As of different parenthesis settings for some notations regarding the root Syntaxable and the child Syntaxables, the method Syntaxable.toSyntax(SyntaxNotation, String, String, String) is called from inside a Syntaxable hierarchy.

toSynopsis(SyntaxNotation, String, String, String) - 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 Syntaxable and the child Syntaxables, the method Syntaxable.toSyntax(SyntaxNotation, String, String, String) is called from inside a Syntaxable hierarchy.

toSynopsis(SyntaxNotation, String, String, String) - 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 Syntaxable and the child Syntaxables, the method Syntaxable.toSyntax(SyntaxNotation, String, String, String) is called from inside a Syntaxable hierarchy.

toSynopsis(SyntaxNotation, String, String, String) - Method in interface org.refcodes.cli.Synopsis

Returns the human readable (verbose) syntax of implementing class ATTENTION: As of different parenthesis settings for some notations regarding the root Syntaxable and the child Syntaxables, the method Syntaxable.toSyntax(SyntaxNotation, String, String, String) is called from inside a Syntaxable hierarchy.

toSynopsis(SyntaxNotation, String, String, String) - 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 Syntaxable and the child Syntaxables, the method Syntaxable.toSyntax(SyntaxNotation, String, String, String) is called from inside a Syntaxable hierarchy.

toSyntax() - Method in interface org.refcodes.cli.Syntaxable

This method is to be called from inside the Syntaxable hierarchy; use the method Synopsis.toSynopsis(SyntaxNotation) in case you invoke syntax retrieval from the root Syntaxable.

toSyntax(String, String, String) - Method in interface org.refcodes.cli.Syntaxable

This method is to be called from inside the Syntaxable hierarchy; use the method Synopsis.toSynopsis(SyntaxNotation) in case you invoke syntax retrieval from the root Syntaxable.

toSyntax(SyntaxNotation) - Method in interface org.refcodes.cli.Syntaxable

This method is to be called from inside the Syntaxable hierarchy; use the method Synopsis.toSynopsis(SyntaxNotation) in case you invoke syntax retrieval from the root Syntaxable.

toSyntax(SyntaxNotation, String, String, String) - Method in class org.refcodes.cli.AbstractCondition

This method is to be called from inside the Syntaxable hierarchy; use the method Synopsis.toSynopsis(SyntaxNotation) in case you invoke syntax retrieval from the root Syntaxable.

toSyntax(SyntaxNotation, String, String, String) - Method in class org.refcodes.cli.AbstractOperand

This method is to be called from inside the Syntaxable hierarchy; use the method Synopsis.toSynopsis(SyntaxNotation) in case you invoke syntax retrieval from the root Syntaxable.

toSyntax(SyntaxNotation, String, String, String) - Method in class org.refcodes.cli.AbstractOption

This method is to be called from inside the Syntaxable hierarchy; use the method Synopsis.toSynopsis(SyntaxNotation) in case you invoke syntax retrieval from the root Syntaxable.

toSyntax(SyntaxNotation, String, String, String) - Method in class org.refcodes.cli.AllCondition

This method is to be called from inside the Syntaxable hierarchy; use the method Synopsis.toSynopsis(SyntaxNotation) in case you invoke syntax retrieval from the root Syntaxable.

toSyntax(SyntaxNotation, String, String, String) - Method in class org.refcodes.cli.AndCondition

This method is to be called from inside the Syntaxable hierarchy; use the method Synopsis.toSynopsis(SyntaxNotation) in case you invoke syntax retrieval from the root Syntaxable.

toSyntax(SyntaxNotation, String, String, String) - Method in class org.refcodes.cli.AnyCondition

This method is to be called from inside the Syntaxable hierarchy; use the method Synopsis.toSynopsis(SyntaxNotation) in case you invoke syntax retrieval from the root Syntaxable.

toSyntax(SyntaxNotation, String, String, String) - Method in class org.refcodes.cli.ArrayOperand

This method is to be called from inside the Syntaxable hierarchy; use the method Synopsis.toSynopsis(SyntaxNotation) in case you invoke syntax retrieval from the root Syntaxable.

toSyntax(SyntaxNotation, String, String, String) - Method in class org.refcodes.cli.ArrayOption

This method is to be called from inside the Syntaxable hierarchy; use the method Synopsis.toSynopsis(SyntaxNotation) in case you invoke syntax retrieval from the root Syntaxable.

toSyntax(SyntaxNotation, String, String, String) - Method in class org.refcodes.cli.Flag

This method is to be called from inside the Syntaxable hierarchy; use the method Synopsis.toSynopsis(SyntaxNotation) in case you invoke syntax retrieval from the root Syntaxable.

toSyntax(SyntaxNotation, String, String, String) - Method in class org.refcodes.cli.NoneOperand

This method is to be called from inside the Syntaxable hierarchy; use the method Synopsis.toSynopsis(SyntaxNotation) in case you invoke syntax retrieval from the root Syntaxable.

toSyntax(SyntaxNotation, String, String, String) - Method in class org.refcodes.cli.Operation

This method is to be called from inside the Syntaxable hierarchy; use the method Synopsis.toSynopsis(SyntaxNotation) in case you invoke syntax retrieval from the root Syntaxable.

toSyntax(SyntaxNotation, String, String, String) - Method in class org.refcodes.cli.OptionCondition

This method is to be called from inside the Syntaxable hierarchy; use the method Synopsis.toSynopsis(SyntaxNotation) in case you invoke syntax retrieval from the root Syntaxable.

toSyntax(SyntaxNotation, String, String, String) - Method in class org.refcodes.cli.OrCondition

This method is to be called from inside the Syntaxable hierarchy; use the method Synopsis.toSynopsis(SyntaxNotation) in case you invoke syntax retrieval from the root Syntaxable.

toSyntax(SyntaxNotation, String, String, String) - Method in interface org.refcodes.cli.Syntaxable

This method is to be called from inside the Syntaxable hierarchy; use the method Synopsis.toSynopsis(SyntaxNotation) in case you invoke syntax retrieval from the root Syntaxable.

toSyntax(SyntaxNotation, String, String, String) - Method in class org.refcodes.cli.XorCondition

This method is to be called from inside the Syntaxable hierarchy; use the method Synopsis.toSynopsis(SyntaxNotation) in case you invoke syntax retrieval from the root Syntaxable.

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.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.

toValue(String) - Method in interface org.refcodes.cli.Syntaxable

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 org.refcodes.cli.SyntaxNotation

Returns the enum constant of this type with the specified name.

values() - Static method in enum org.refcodes.cli.SyntaxNotation

Returns an array containing the constants of this enum type, in the order they are declared.

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.

W

withArgsParser(ArgsParser) - Method in interface org.refcodes.cli.ArgsParserAccessor.ArgsParserBuilder

Sets the args-parser for the ArgsParser 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.

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.

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

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(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 .

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.

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.

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.

withParamEscapeCode(String) - Method in interface org.refcodes.cli.ArgsParser

Sets the parameter Escape-Code for the parameter Escape-Code property.

withResetEscapeCode(String) - Method in interface org.refcodes.cli.ArgsParser

withRootArgsSyntax(ArgsSyntax) - Method in interface org.refcodes.cli.RootConditionAccessor.RootConditionBuilder

Sets the root condition for the root condition property.

withRootOption(Option<?>) - Method in interface org.refcodes.cli.RootConditionAccessor.RootConditionBuilder

Sets the root option for the root condition property.

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.

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).

withSyntaxNotation(SyntaxNotation) - Method in interface org.refcodes.cli.ArgsParser

Set the SyntaxNotation and make other adjustments with the result (with regards to the Builder-Pattern).

withTextBoxGrid(TextBoxGrid) - Method in interface org.refcodes.cli.ArgsParser

withTitle(String) - Method in interface org.refcodes.cli.ArgsParser

With title.

X

xor(Syntaxable...) - Static method in class org.refcodes.cli.CliSugar

Instantiates a new XorCondition with the Syntaxable (ArgsSyntax) instances to be nested.

XorCondition - Class in org.refcodes.cli

An XorCondition represents a list of ArgsSyntax (Syntaxable) instances of which only one is allowed to be parsed successfully when the Syntaxable.parseArgs(String[], String[]) methods are invoked.

XorCondition(Syntaxable...) - Constructor for class org.refcodes.cli.XorCondition

Instantiates a new XorCondition with the Syntaxable (ArgsSyntax) instances to be nested.

_

_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 C D E F G H I L N O P Q R S T U V W X _
All Classes All Packages