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

A

AbstractCondition - Class in org.refcodes.console
The AbstractCondition is an abstract implementation of an Condition providing the boiler plate when implementing the Condition interface.
AbstractCondition(Syntaxable...) - Constructor for class org.refcodes.console.AbstractCondition
Instantiates a new abstract condition.
AbstractOperand<T> - Class in org.refcodes.console
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.console.AbstractOperand
Constructs a Operand with the given arguments.
AbstractOperand(Relation<String, T>, Class<T>) - Constructor for class org.refcodes.console.AbstractOperand
Instantiates a new operand.
AbstractOption<T> - Class in org.refcodes.console
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.console.AbstractOption
Constructs a Option with the given arguments.
AbstractOption(String, String, Class<T>, String, String) - Constructor for class org.refcodes.console.AbstractOption
Constructs a Option with the given arguments.
AbstractOption(Relation<String, T>, Class<T>) - Constructor for class org.refcodes.console.AbstractOption
Instantiates a new option.
addChild(Syntaxable) - Method in class org.refcodes.console.AbstractCondition
Adds the child.
ALIAS - Static variable in class org.refcodes.console.DebugFlag
 
ALIAS - Static variable in class org.refcodes.console.ForceFlag
 
ALIAS - Static variable in class org.refcodes.console.HelpFlag
 
ALIAS - Static variable in class org.refcodes.console.QuietFlag
 
ALIAS - Static variable in class org.refcodes.console.VerboseFlag
 
AmbiguousArgsException - Exception in org.refcodes.console
Thrown in case at least one command line argument is ambiguous regarding expected args vs. provided args.
AmbiguousArgsException(String[], String) - Constructor for exception org.refcodes.console.AmbiguousArgsException
Instantiates a new ambiguous args exception.
AmbiguousArgsException(String[], String, String) - Constructor for exception org.refcodes.console.AmbiguousArgsException
Instantiates a new ambiguous args exception.
AmbiguousArgsException(String[], String, Throwable) - Constructor for exception org.refcodes.console.AmbiguousArgsException
Instantiates a new ambiguous args exception.
AmbiguousArgsException(String[], String, Throwable, String) - Constructor for exception org.refcodes.console.AmbiguousArgsException
Instantiates a new ambiguous args exception.
AmbiguousArgsException(String[], Throwable) - Constructor for exception org.refcodes.console.AmbiguousArgsException
Instantiates a new ambiguous args exception.
AmbiguousArgsException(String[], Throwable, String) - Constructor for exception org.refcodes.console.AmbiguousArgsException
Instantiates a new ambiguous args exception.
and(Syntaxable...) - Static method in class org.refcodes.console.ConsoleSugar
And.
AndCondition - Class in org.refcodes.console
An AndCondition represents a list of Syntaxable instances of which all are be parsed successfully when the Syntaxables' parseArgs(String[], String[]) methods are invoked.
AndCondition(Syntaxable...) - Constructor for class org.refcodes.console.AndCondition
Instantiates a new and condition impl.
ARGS_ERROR - org.refcodes.console.ExitCode
 
ArgsAccessor - Interface in org.refcodes.console
Provides an accessor for a command line arguments (short "args") array.
ArgsAccessor.ArgsMutator - Interface in org.refcodes.console
Provides a mutator for a args property.
ArgsAccessor.ArgsProperty - Interface in org.refcodes.console
Provides a args property.
ArgsMismatchException - Exception in org.refcodes.console
Thrown in case a command line arguments mismatch regarding provided and expected args.
ArgsMismatchException(String[], String) - Constructor for exception org.refcodes.console.ArgsMismatchException
Instantiates a new args mismatch exception.
ArgsMismatchException(String[], String, String) - Constructor for exception org.refcodes.console.ArgsMismatchException
Instantiates a new args mismatch exception.
ArgsMismatchException(String[], String, Throwable) - Constructor for exception org.refcodes.console.ArgsMismatchException
Instantiates a new args mismatch exception.
ArgsMismatchException(String[], String, Throwable, String) - Constructor for exception org.refcodes.console.ArgsMismatchException
Instantiates a new args mismatch exception.
ArgsMismatchException(String[], Throwable) - Constructor for exception org.refcodes.console.ArgsMismatchException
Instantiates a new args mismatch exception.
ArgsMismatchException(String[], Throwable, String) - Constructor for exception org.refcodes.console.ArgsMismatchException
Instantiates a new args mismatch exception.
ArgsParser - Interface in org.refcodes.console
The ArgsParser provides means for parsing command line arguments and constructing a command line utility's help output.
ArgsParserAccessor - Interface in org.refcodes.console
Provides an accessor for a ArgsParser property.
ArgsParserAccessor.ArgsParserBuilder<B extends ArgsParserAccessor.ArgsParserBuilder<B>> - Interface in org.refcodes.console
Provides a builder method for a ArgsParser property returning the builder for applying multiple build operations.
ArgsParserAccessor.ArgsParserMutator - Interface in org.refcodes.console
Provides a mutator for a ArgsParser property.
ArgsParserAccessor.PropertiesProperty - Interface in org.refcodes.console
Provides a ArgsParser property.
ArgsParserImpl - Class in org.refcodes.console
A straightforward implementation of the ArgsParser interface.
ArgsParserImpl() - Constructor for class org.refcodes.console.ArgsParserImpl
Constructs the ArgsParser instance without any restrictions to the parsed arguments.
ArgsParserImpl(Condition) - Constructor for class org.refcodes.console.ArgsParserImpl
Constructs the ArgsParser instance with the given root Condition and the default SyntaxNotation.REFCODES.
ArgsParserMixin<B extends ArgsParserMixin<B>> - Interface in org.refcodes.console
This mixin provides builder additions (as of the builder pattern for chained configuring method calls) for parsing command line arguments.

C

compareTo(Operand<?>) - Method in class org.refcodes.console.AbstractOperand
Condition - Interface in org.refcodes.console
The Condition interface represents a node in the command line arguments syntax tree; simply extending the Syntaxable interface and adding the functionality of providing access to the added Operands (leafs).
ConsoleArgsException(String[], String) - Constructor for exception org.refcodes.console.ConsoleException.ConsoleArgsException
Instantiates a new console args exception.
ConsoleArgsException(String[], String, String) - Constructor for exception org.refcodes.console.ConsoleException.ConsoleArgsException
Instantiates a new console args exception.
ConsoleArgsException(String[], String, Throwable) - Constructor for exception org.refcodes.console.ConsoleException.ConsoleArgsException
Instantiates a new console args exception.
ConsoleArgsException(String[], String, Throwable, String) - Constructor for exception org.refcodes.console.ConsoleException.ConsoleArgsException
Instantiates a new console args exception.
ConsoleArgsException(String[], Throwable) - Constructor for exception org.refcodes.console.ConsoleException.ConsoleArgsException
Instantiates a new console args exception.
ConsoleArgsException(String[], Throwable, String) - Constructor for exception org.refcodes.console.ConsoleException.ConsoleArgsException
Instantiates a new console args exception.
ConsoleCliException(ExitCode, String) - Constructor for exception org.refcodes.console.ConsoleException.ConsoleCliException
Instantiates a new console cli exception.
ConsoleCliException(ExitCode, String, String) - Constructor for exception org.refcodes.console.ConsoleException.ConsoleCliException
Instantiates a new console cli exception.
ConsoleCliException(ExitCode, String, Throwable) - Constructor for exception org.refcodes.console.ConsoleException.ConsoleCliException
Instantiates a new console cli exception.
ConsoleCliException(ExitCode, String, Throwable, String) - Constructor for exception org.refcodes.console.ConsoleException.ConsoleCliException
Instantiates a new console cli exception.
ConsoleCliException(ExitCode, Throwable) - Constructor for exception org.refcodes.console.ConsoleException.ConsoleCliException
Instantiates a new console cli exception.
ConsoleCliException(ExitCode, Throwable, String) - Constructor for exception org.refcodes.console.ConsoleException.ConsoleCliException
Instantiates a new console cli exception.
ConsoleException - Exception in org.refcodes.console
Base exception for the console artifact.
ConsoleException(String) - Constructor for exception org.refcodes.console.ConsoleException
Instantiates a new console exception.
ConsoleException(String, String) - Constructor for exception org.refcodes.console.ConsoleException
Instantiates a new console exception.
ConsoleException(String, Throwable) - Constructor for exception org.refcodes.console.ConsoleException
Instantiates a new console exception.
ConsoleException(String, Throwable, String) - Constructor for exception org.refcodes.console.ConsoleException
Instantiates a new console exception.
ConsoleException(Throwable) - Constructor for exception org.refcodes.console.ConsoleException
Instantiates a new console exception.
ConsoleException(Throwable, String) - Constructor for exception org.refcodes.console.ConsoleException
Instantiates a new console exception.
ConsoleException.ConsoleArgsException - Exception in org.refcodes.console
This abstract exception is the base exception for all command line argument related exceptions.
ConsoleException.ConsoleCliException - Exception in org.refcodes.console
The Class ConsoleCliException.
ConsoleSugar - Class in org.refcodes.console
Declarative syntactic sugar which may be statically imported in order to allow declarative definitions for the command line Flag, Condition, Option and Operand elements.
ConsoleSugar() - Constructor for class org.refcodes.console.ConsoleSugar
 
ConsoleUtility - Class in org.refcodes.console
This utility class provides method useful for the refcodes-console artifact and whose implementation has been motivated by the implementation of the refcodes-console artifact.
contains(String[], String) - Static method in class org.refcodes.console.ConsoleUtility
Determines whether a given String is contained in the given String array.

D

debugFlag() - Static method in class org.refcodes.console.ConsoleSugar
Debug flag.
DebugFlag - Class in org.refcodes.console
A predefined debug switch.
DebugFlag() - Constructor for class org.refcodes.console.DebugFlag
Constructs the predefined debug switch.
DebugFlag(String) - Constructor for class org.refcodes.console.DebugFlag
Constructs the predefined debug switch.

E

enumOption(String, Class<T>, String, String) - Static method in class org.refcodes.console.ConsoleSugar
Enum option.
enumOption(String, String, Class<T>, String, String) - Static method in class org.refcodes.console.ConsoleSugar
Enum option.
EnumOption<T extends java.lang.Enum<T>> - Class in org.refcodes.console
The Class EnumOption.
EnumOption(String, Class<T>, String, String) - Constructor for class org.refcodes.console.EnumOption
Instantiates a new enum option.
EnumOption(String, String, Class<T>, String, String) - Constructor for class org.refcodes.console.EnumOption
Instantiates a new enum option.
EnumOption(Relation<String, T>, Class<T>) - Constructor for class org.refcodes.console.EnumOption
Instantiates a new enum option.
errorLn(String) - Method in interface org.refcodes.console.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.console.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.console.ArgsParser
Evaluates the provided command line arguments and determines the according values by evaluating the root Condition.
evalArgs(String[]) - Method in class org.refcodes.console.ArgsParserImpl
Evaluates the provided command line arguments and determines the according values by evaluating the root Condition.
evalArgs(List<String>) - Method in interface org.refcodes.console.ArgsParser
Same as ArgsParser.evalArgs(String[]) with the difference that the elements representing the arguments are passed as a list instead of an array.
ExitCode - Enum in org.refcodes.console
Some default exit codes defined for CLI applications.

F

FAIL - org.refcodes.console.ExitCode
 
fileOption(String, String, String) - Static method in class org.refcodes.console.ConsoleSugar
Creates a FileOption for getting a File instance from a path.
fileOption(String, String, String, String) - Static method in class org.refcodes.console.ConsoleSugar
String option.
FileOption - Class in org.refcodes.console
The FileOption represents an Option holding File values.
FileOption(String, String, String) - Constructor for class org.refcodes.console.FileOption
Instantiates a new file option.
FileOption(String, String, String, String) - Constructor for class org.refcodes.console.FileOption
Instantiates a new file option.
FileOption(Relation<String, File>) - Constructor for class org.refcodes.console.FileOption
Instantiates a new file option.
flag(String, String, String) - Static method in class org.refcodes.console.ConsoleSugar
As "flag" is a reserved word in Java, we use "flag" :-(.
flag(String, String, String, String) - Static method in class org.refcodes.console.ConsoleSugar
As "flag" is a reserved word in Java, we use "flag" :-(.
Flag - Class in org.refcodes.console
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.
Flag(String, boolean) - Constructor for class org.refcodes.console.Flag
Constructs a Flag.
Flag(String, String, String) - Constructor for class org.refcodes.console.Flag
Constructs a Flag.
Flag(String, String, String, String) - Constructor for class org.refcodes.console.Flag
Constructs a Flag.
ForceFlag - Class in org.refcodes.console
A predefined force switch.
ForceFlag() - Constructor for class org.refcodes.console.ForceFlag
Constructs the predefined force switch.
ForceFlag(String) - Constructor for class org.refcodes.console.ForceFlag
Constructs the predefined force switch.
forcesFlag() - Static method in class org.refcodes.console.ConsoleSugar
Forces flag.
forcesFlag(String) - Static method in class org.refcodes.console.ConsoleSugar
Forces flag.
fromArgs(String[], char) - Static method in class org.refcodes.console.ArgsParserImpl
Heuristically loads the arguments without any syntax required, e.g.

G

get(String) - Method in class org.refcodes.console.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.
get(String) - Method in interface org.refcodes.console.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.
get(String) - Method in interface org.refcodes.console.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.
getAlias() - Method in class org.refcodes.console.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 interface org.refcodes.console.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.console.AbstractOperand
Retrieves the command line arguments from the args property.
getArgs() - Method in interface org.refcodes.console.ArgsAccessor
Retrieves the command line arguments from the args property.
getArgs() - Method in exception org.refcodes.console.ConsoleException.ConsoleArgsException
Gets the args.
getArgs() - Method in interface org.refcodes.console.Operand
Retrieves the command line arguments from the args property.
getArgsParser() - Method in interface org.refcodes.console.ArgsParserAccessor
Retrieves the args-parser from the ArgsParser property.
getBannerBorderEscapeCode() - Method in interface org.refcodes.console.ArgsParser
Retrieves the banner's border Escape-Code from the banner border Escape-Code property.
getBannerBorderEscapeCode() - Method in class org.refcodes.console.ArgsParserImpl
Retrieves the banner's border Escape-Code from the banner border Escape-Code property.
getBannerEscapeCode() - Method in interface org.refcodes.console.ArgsParser
Retrieves the banner's content Escape-Code from the banner Escape-Code property.
getBannerEscapeCode() - Method in class org.refcodes.console.ArgsParserImpl
Retrieves the banner's content Escape-Code from the banner Escape-Code property.
getChildren() - Method in class org.refcodes.console.AbstractCondition
Gets the children.
getCopyrightNote() - Method in interface org.refcodes.console.ArgsParser
Retrieves the copyright.
getCopyrightNote() - Method in class org.refcodes.console.ArgsParserImpl
Retrieves the copyright.
getDelimiter() - Method in class org.refcodes.console.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.console.AbstractOperand
getDescription() - Method in interface org.refcodes.console.ArgsParser
Retrieves the description.
getDescription() - Method in class org.refcodes.console.ArgsParserImpl
Retrieves the description.
getLicenseNote() - Method in interface org.refcodes.console.ArgsParser
Retrieves the license.
getLicenseNote() - Method in class org.refcodes.console.ArgsParserImpl
Retrieves the license.
getLineSeparatorEscapeCode() - Method in interface org.refcodes.console.ArgsParser
Retrieves the line separator Escape-Code from the line separator Escape-Code property.
getLineSeparatorEscapeCode() - Method in class org.refcodes.console.ArgsParserImpl
Retrieves the line separator Escape-Code from the line separator Escape-Code property.
getLongOption() - Method in class org.refcodes.console.AbstractOption
TODO: Make the option to be required without the hyphen-minuses "--" Returns the long-option representing an Option instance.
getLongOption() - Method in interface org.refcodes.console.Option
TODO: Make the option to be required without the hyphen-minuses "--" Returns the long-option representing an Option instance.
getName() - Method in class org.refcodes.console.ArgsParserImpl
getOptionArgument(Option<?>, String[], String[]) - Static method in class org.refcodes.console.ConsoleUtility
Takes the Option's short-option and long-option and tries to determine that Option's value in the provided command line arguments.
getOptionPrefixes() - Method in class org.refcodes.console.AbstractOption
Determines the prefixes suitable for the environment.
getParameterDescriptionEscapeCode() - Method in interface org.refcodes.console.ArgsParser
Retrieves the parameter's description Escape-Code from the parameter's description Escape-Code property.
getParameterDescriptionEscapeCode() - Method in class org.refcodes.console.ArgsParserImpl
Retrieves the parameter's description Escape-Code from the parameter's description Escape-Code property.
getParameterEscapeCode() - Method in interface org.refcodes.console.ArgsParser
Retrieves the parameter Escape-Code from the parameter Escape-Code property.
getParameterEscapeCode() - Method in class org.refcodes.console.ArgsParserImpl
Retrieves the parameter Escape-Code from the parameter Escape-Code property.
getResetEscapeCode() - Method in class org.refcodes.console.ArgsParserImpl
getRootCondition() - Method in interface org.refcodes.console.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.
getRootCondition() - Method in class org.refcodes.console.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.
getRootCondition() - Method in interface org.refcodes.console.RootConditionAccessor
Retrieves the rootCondition from the rootCondition property.
getShortOption() - Method in class org.refcodes.console.AbstractOption
Returns the short-option representing an Option instance.
getShortOption() - Method in interface org.refcodes.console.Option
Returns the short-option representing an Option instance.
getStatusCode() - Method in exception org.refcodes.console.ConsoleException.ConsoleCliException
Gets the status code.
getStatusCode() - Method in enum org.refcodes.console.ExitCode
Gets the status code.
getTitle() - Method in class org.refcodes.console.ArgsParserImpl
getType() - Method in class org.refcodes.console.AbstractOperand
getValue() - Method in class org.refcodes.console.AbstractOperand
getValue() - Method in interface org.refcodes.console.Operand
GNU_POSIX - org.refcodes.console.SyntaxNotation
A syntax notation derived from GNU and POSIX utility conventions and utility argument syntax.

H

hasValue() - Method in interface org.refcodes.console.Operand
When being parsed via the parseArgs(String[], String[]) method, use this method to determine whether the Operand.getValue() method contains parsed value.
helpFlag() - Static method in class org.refcodes.console.ConsoleSugar
Help flag.
helpFlag(String) - Static method in class org.refcodes.console.ConsoleSugar
Help flag.
HelpFlag - Class in org.refcodes.console
A predefined help switch.
HelpFlag() - Constructor for class org.refcodes.console.HelpFlag
Constructs the predefined help switch.
HelpFlag(String) - Constructor for class org.refcodes.console.HelpFlag
Constructs the predefined help switch.

I

IntegerOption - Class in org.refcodes.console
The IntegerOption represents an Option holding int values.
IntegerOption(String, String, String) - Constructor for class org.refcodes.console.IntegerOption
Instantiates a new integer option impl.
IntegerOption(String, String, String, String) - Constructor for class org.refcodes.console.IntegerOption
Instantiates a new integer option impl.
IntegerOption(Relation<String, Integer>) - Constructor for class org.refcodes.console.IntegerOption
Instantiates a new integer option impl.
intOption(String, String, String) - Static method in class org.refcodes.console.ConsoleSugar
Int option.
intOption(String, String, String, String) - Static method in class org.refcodes.console.ConsoleSugar
Int option.
IO_ERROR - org.refcodes.console.ExitCode
 
isEnabled() - Method in class org.refcodes.console.Flag
Returns true if the switch has been set (enabled).
isEscapeCodesEnabled() - Method in class org.refcodes.console.ArgsParserImpl
isOptionArgument(String) - Static method in class org.refcodes.console.ConsoleUtility
Determines whether the provided String starts with one of the prefixes Identifying an Option.

L

LONG_OPTION - Static variable in class org.refcodes.console.DebugFlag
 
LONG_OPTION - Static variable in class org.refcodes.console.ForceFlag
 
LONG_OPTION - Static variable in class org.refcodes.console.HelpFlag
 
LONG_OPTION - Static variable in class org.refcodes.console.QuietFlag
 
LONG_OPTION - Static variable in class org.refcodes.console.SysInfoFlag
 
LONG_OPTION - Static variable in class org.refcodes.console.VerboseFlag
 
longOption(String, String, String) - Static method in class org.refcodes.console.ConsoleSugar
Long option.
longOption(String, String, String, String) - Static method in class org.refcodes.console.ConsoleSugar
Long option.
LongOption - Class in org.refcodes.console
The LongOption represents an Option holding long values.
LongOption(String, String, String) - Constructor for class org.refcodes.console.LongOption
Instantiates a new long option impl.
LongOption(String, String, String, String) - Constructor for class org.refcodes.console.LongOption
Instantiates a new long option impl.
LongOption(Relation<String, Long>) - Constructor for class org.refcodes.console.LongOption
Instantiates a new long option impl.

O

Operand<T> - Interface in org.refcodes.console
An Operand represents a value parsed from command line arguments.
Option<T> - Interface in org.refcodes.console
An Option represents a command line option with the according option's value.
optional(Syntaxable...) - Static method in class org.refcodes.console.ConsoleSugar
Optional.
OptionalCondition - Class in org.refcodes.console
The Class OptionalCondition.
OptionalCondition(Syntaxable...) - Constructor for class org.refcodes.console.OptionalCondition
Instantiates a new optional condition impl.
or(Syntaxable...) - Static method in class org.refcodes.console.ConsoleSugar
Or.
OrCondition - Class in org.refcodes.console
An OrCondition represents a list of Syntaxable instances of which at least one must be parsed successfully when the Syntaxable s' parseArgs(String[], String[]) methods are invoked.
OrCondition(Syntaxable...) - Constructor for class org.refcodes.console.OrCondition
Instantiates a new or condition impl.
org.refcodes.console - package org.refcodes.console
Getting started:

P

parseArgs(String[]) - Method in interface org.refcodes.console.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 Condition, traversing the child Syntaxable instances' parseArgs(String[], String[]) methods.
parseArgs(String[], String[]) - Method in class org.refcodes.console.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 Condition, traversing the child Syntaxable instances' parseArgs(String[], String[]) methods.
parseArgs(String[], String[]) - Method in class org.refcodes.console.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 Condition, traversing the child Syntaxable instances' parseArgs(String[], String[]) methods.
parseArgs(String[], String[]) - Method in class org.refcodes.console.AndCondition
 
parseArgs(String[], String[]) - Method in class org.refcodes.console.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 Condition, traversing the child Syntaxable instances' parseArgs(String[], String[]) methods.
parseArgs(String[], String[]) - Method in class org.refcodes.console.OptionalCondition
 
parseArgs(String[], String[]) - Method in class org.refcodes.console.OrCondition
 
parseArgs(String[], String[]) - Method in interface org.refcodes.console.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 Condition, traversing the child Syntaxable instances' parseArgs(String[], String[]) methods.
parseArgs(String[], String[]) - Method in class org.refcodes.console.XorCondition
 
ParseArgsException - Exception in org.refcodes.console
Thrown in case the provided command line arguments do not respect the required syntax or cannot be converted to the required type.
ParseArgsException(String[], String) - Constructor for exception org.refcodes.console.ParseArgsException
Instantiates a new parses the args exception.
ParseArgsException(String[], String, String) - Constructor for exception org.refcodes.console.ParseArgsException
Instantiates a new parses the args exception.
ParseArgsException(String[], String, Throwable) - Constructor for exception org.refcodes.console.ParseArgsException
Instantiates a new parses the args exception.
ParseArgsException(String[], String, Throwable, String) - Constructor for exception org.refcodes.console.ParseArgsException
Instantiates a new parses the args exception.
ParseArgsException(String[], Throwable) - Constructor for exception org.refcodes.console.ParseArgsException
Instantiates a new parses the args exception.
ParseArgsException(String[], Throwable, String) - Constructor for exception org.refcodes.console.ParseArgsException
Instantiates a new parses the args exception.
printBanner() - Method in interface org.refcodes.console.ArgsParser
Prints the banner; the banner most probably is an ASCII art text block which's look depends strongly on the taste of the author implementing this interface.
printBanner() - Method in class org.refcodes.console.ArgsParserImpl
Prints the banner; the banner most probably is an ASCII art text block which's look depends strongly on the taste of the author implementing this interface.
printBody() - Method in interface org.refcodes.console.ArgsParser
Prints the help as of ArgsParser.printHelp() without the banner.
printCopyrightNote() - Method in interface org.refcodes.console.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.console.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.console.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.console.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.
printHelp() - Method in interface org.refcodes.console.ArgsParser
Prints the help to the standard output specified by the ArgsParser.withStandardOut(PrintStream) method.
printLicenseNote() - Method in interface org.refcodes.console.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.console.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.console.ArgsParser
Prints an empty line / a line break.
printLn() - Method in class org.refcodes.console.ArgsParserImpl
Prints an empty line / a line break.
printLn(String) - Method in interface org.refcodes.console.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.console.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.console.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.console.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.console.ArgsParser
Prints a separator line using the separator character as specified by the ArgsParser.withSeparatorChar(char) method; with regards to to the console width as specified by the ArgsParser.withConsoleWidth(int) method.
printSeparatorLn() - Method in class org.refcodes.console.ArgsParserImpl
Prints a separator line using the separator character as specified by the ArgsParser.withSeparatorChar(char) method; with regards to to the console width as specified by the ArgsParser.withConsoleWidth(int) method.
printUsage() - Method in interface org.refcodes.console.ArgsParser
Prints the syntax as retrieved by the root Condition with regards to the SyntaxNotation set by the ArgsParser.withSyntaxNotation(SyntaxNotation) method; making use of the usage label as passed by the ArgsParser.withUsageLabel(String) method.
printUsage() - Method in class org.refcodes.console.ArgsParserImpl
Prints the syntax as retrieved by the root Condition with regards to the SyntaxNotation set by the ArgsParser.withSyntaxNotation(SyntaxNotation) method; making use of the usage label as passed by the ArgsParser.withUsageLabel(String) method.

Q

quietFlag() - Static method in class org.refcodes.console.ConsoleSugar
Quiet flag.
quietFlag(String) - Static method in class org.refcodes.console.ConsoleSugar
Quiet flag.
QuietFlag - Class in org.refcodes.console
A predefined "be quiet" switch.
QuietFlag() - Constructor for class org.refcodes.console.QuietFlag
Constructs the predefined quiet switch.
QuietFlag(String) - Constructor for class org.refcodes.console.QuietFlag
Constructs the predefined quiet switch.

R

REFCODES - org.refcodes.console.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-console artifact.
reset() - Method in class org.refcodes.console.AbstractCondition
reset() - Method in class org.refcodes.console.AbstractOperand
reset() - Method in class org.refcodes.console.ArgsParserImpl
reset() - Method in class org.refcodes.console.Flag
reset() - Method in class org.refcodes.console.OptionalCondition
RootConditionAccessor - Interface in org.refcodes.console
Provides an accessor for a rootCondition property.
RootConditionAccessor.RootConditionBuilder<B extends RootConditionAccessor.RootConditionBuilder<B>> - Interface in org.refcodes.console
Provides a builder method for a rootCondition property returning the builder for applying multiple build operations.
RootConditionAccessor.RootConditionMutator - Interface in org.refcodes.console
Provides a mutator for a rootCondition property.
RootConditionAccessor.RootConditionProperty - Interface in org.refcodes.console
Provides a rootCondition property.

S

setArgs(String[]) - Method in class org.refcodes.console.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.console.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.console.ArgsAccessor.ArgsMutator
Sets the command line arguments for the args property.
setArgsParser(ArgsParser) - Method in interface org.refcodes.console.ArgsParserAccessor.ArgsParserMutator
Sets the args-parser for the ArgsParser property.
setBannerBorderEscapeCode(String) - Method in interface org.refcodes.console.ArgsParser
Sets the banner's border Escape-Code for the banner border Escape-Code property.
setBannerBorderEscapeCode(String) - Method in class org.refcodes.console.ArgsParserImpl
Sets the banner's border Escape-Code for the banner border Escape-Code property.
setBannerEscapeCode(String) - Method in interface org.refcodes.console.ArgsParser
Sets the banner's content Escape-Code for the banner Escape-Code property.
setBannerEscapeCode(String) - Method in class org.refcodes.console.ArgsParserImpl
Sets the banner's content Escape-Code for the banner Escape-Code property.
setBannerFont(Font) - Method in interface org.refcodes.console.ArgsParser
Sets the banner font.
setBannerFont(Font) - Method in class org.refcodes.console.ArgsParserImpl
Sets the banner font.
setBannerFontPalette(char[]) - Method in interface org.refcodes.console.ArgsParser
Sets the banner font palette.
setBannerFontPalette(char[]) - Method in class org.refcodes.console.ArgsParserImpl
Sets the banner font palette.
setConsoleWidth(int) - Method in interface org.refcodes.console.ArgsParser
Set the console with.
setConsoleWidth(int) - Method in class org.refcodes.console.ArgsParserImpl
Set the console with.
setCopyrightNote(String) - Method in interface org.refcodes.console.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.console.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.console.ArgsParserImpl
setErrorOut(PrintStream) - Method in interface org.refcodes.console.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.console.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.console.ArgsParserImpl
setLicenseNote(String) - Method in interface org.refcodes.console.ArgsParser
Set the license note used by the ArgsParser.printHelp() method when writing out the licensing conditions.
setLicenseNote(String) - Method in class org.refcodes.console.ArgsParserImpl
Set the license note used by the ArgsParser.printHelp() method when writing out the licensing conditions.
setLineBreak(String) - Method in interface org.refcodes.console.ArgsParser
Set the console's line break.
setLineBreak(String) - Method in class org.refcodes.console.ArgsParserImpl
Set the console's line break.
setLineSeparatorEscapeCode(String) - Method in interface org.refcodes.console.ArgsParser
Sets the line separator Escape-Code for the line separator Escape-Code property.
setLineSeparatorEscapeCode(String) - Method in class org.refcodes.console.ArgsParserImpl
Sets the line separator Escape-Code for the line separator Escape-Code property.
setMaxConsoleWidth(int) - Method in interface org.refcodes.console.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.console.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.console.ArgsParserImpl
setParameterDescriptionEscapeCode(String) - Method in interface org.refcodes.console.ArgsParser
Sets the parameter's description Escape-Code for the parameter's description Escape-Code property.
setParameterDescriptionEscapeCode(String) - Method in class org.refcodes.console.ArgsParserImpl
Sets the parameter's description Escape-Code for the parameter's description Escape-Code property.
setParameterEscapeCode(String) - Method in interface org.refcodes.console.ArgsParser
Sets the parameter Escape-Code for the parameter Escape-Code property.
setParameterEscapeCode(String) - Method in class org.refcodes.console.ArgsParserImpl
Sets the parameter Escape-Code for the parameter Escape-Code property.
setResetEscapeCode(String) - Method in class org.refcodes.console.ArgsParserImpl
setRootCondition(Condition) - Method in interface org.refcodes.console.RootConditionAccessor.RootConditionMutator
Sets the rootCondition for the rootCondition property.
setSeparatorChar(char) - Method in interface org.refcodes.console.ArgsParser
Set the character to be used when printing a separator line with the ArgsParser.printSeparatorLn() method.
setSeparatorChar(char) - Method in class org.refcodes.console.ArgsParserImpl
Set the character to be used when printing a separator line with the ArgsParser.printSeparatorLn() method.
setStandardOut(PrintStream) - Method in interface org.refcodes.console.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.console.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.console.ArgsParser
setSyntaxNotation(SyntaxNotation) - Method in class org.refcodes.console.ArgsParserImpl
setTitle(String) - Method in class org.refcodes.console.ArgsParserImpl
setUsageLabel(String) - Method in interface org.refcodes.console.ArgsParser
Set the usage label used by the ArgsParser.printHelp() method when writing out the syntax.
setUsageLabel(String) - Method in class org.refcodes.console.ArgsParserImpl
Set the usage label used by the ArgsParser.printHelp() method when writing out the syntax.
setValue(T) - Method in class org.refcodes.console.AbstractOperand
Sets the value for the Operand as parsed by the AbstractOperand.parseArgs(String[], String[]) method.
setValue(T) - Method in class org.refcodes.console.AbstractOption
Sets the value for the Operand as parsed by the AbstractOperand.parseArgs(String[], String[]) method.
SHORT_OPTION - Static variable in class org.refcodes.console.DebugFlag
 
SHORT_OPTION - Static variable in class org.refcodes.console.ForceFlag
 
SHORT_OPTION - Static variable in class org.refcodes.console.HelpFlag
 
SHORT_OPTION - Static variable in class org.refcodes.console.QuietFlag
 
SHORT_OPTION - Static variable in class org.refcodes.console.SysInfoFlag
 
SHORT_OPTION - Static variable in class org.refcodes.console.VerboseFlag
 
stringOperand(String, String) - Static method in class org.refcodes.console.ConsoleSugar
String operand.
StringOperand - Class in org.refcodes.console
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.console.StringOperand
Instantiates a new string operand impl.
StringOperand(Relation<String, String>) - Constructor for class org.refcodes.console.StringOperand
Instantiates a new string operand impl.
stringOption(String, String, String) - Static method in class org.refcodes.console.ConsoleSugar
String option.
stringOption(String, String, String, String) - Static method in class org.refcodes.console.ConsoleSugar
String option.
StringOption - Class in org.refcodes.console
The StringOption represents an Option holding String values.
StringOption(String, String, String) - Constructor for class org.refcodes.console.StringOption
Instantiates a new string option.
StringOption(String, String, String, String) - Constructor for class org.refcodes.console.StringOption
Instantiates a new string option.
StringOption(Relation<String, String>) - Constructor for class org.refcodes.console.StringOption
Instantiates a new string option.
SUCCESS - org.refcodes.console.ExitCode
 
SuperfluousArgsException - Exception in org.refcodes.console
Thrown in case there were arguments found not being used (superfluous arguments).
SuperfluousArgsException(String[], String) - Constructor for exception org.refcodes.console.SuperfluousArgsException
Instantiates a new superfluous args exception.
SuperfluousArgsException(String[], String, String) - Constructor for exception org.refcodes.console.SuperfluousArgsException
Instantiates a new superfluous args exception.
SuperfluousArgsException(String[], String, Throwable) - Constructor for exception org.refcodes.console.SuperfluousArgsException
Instantiates a new superfluous args exception.
SuperfluousArgsException(String[], String, Throwable, String) - Constructor for exception org.refcodes.console.SuperfluousArgsException
Instantiates a new superfluous args exception.
SuperfluousArgsException(String[], Throwable) - Constructor for exception org.refcodes.console.SuperfluousArgsException
Instantiates a new superfluous args exception.
SuperfluousArgsException(String[], Throwable, String) - Constructor for exception org.refcodes.console.SuperfluousArgsException
Instantiates a new superfluous args exception.
Syntaxable - Interface in org.refcodes.console
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.console
The SyntaxNotation is used by a the toSyntax(SyntaxNotation, String, String) method to determine which notation to be used for the generated syntax.
SyntaxUsage - Interface in org.refcodes.console
The SyntaxUsage interface defines those methods required to create a human readable usage String from the implementing instance.
SYSINFO - Static variable in class org.refcodes.console.SysInfoFlag
 
sysInfoFlag() - Static method in class org.refcodes.console.ConsoleSugar
Sys info flag.
sysInfoFlag(String) - Static method in class org.refcodes.console.ConsoleSugar
Sys info flag.
SysInfoFlag - Class in org.refcodes.console
A predefined system information switch.
SysInfoFlag() - Constructor for class org.refcodes.console.SysInfoFlag
Constructs the predefined system information switch.
SysInfoFlag(String) - Constructor for class org.refcodes.console.SysInfoFlag
Constructs the predefined system information switch.

T

toArgs(List<? extends Operand<?>>...) - Static method in class org.refcodes.console.ConsoleUtility
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.console.ConsoleUtility
Creates the difference between the provided set and the provided subset.
toDiff(String[], List<? extends Operand<?>>) - Static method in class org.refcodes.console.ConsoleUtility
Creates the difference between the provided set and the provided Lists therein found argument arrays subset (as of Operand.getArgs()).
toOperands() - Method in class org.refcodes.console.AbstractCondition
Traverses the hierarchy of Conditions and collects all therein found Operands and sub-types such as the Flag or the Option.
toOperands() - Method in interface org.refcodes.console.Condition
Traverses the hierarchy of Conditions and collects all therein found Operands and sub-types such as the Flag or the Option.
toOptionsSpec(Operand<?>) - Static method in class org.refcodes.console.ConsoleUtility
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.console.ConsoleUtility
Creates the parameter specification from the provided Operand.
toSpec(Operand<?>) - Static method in class org.refcodes.console.ConsoleUtility
Creates a specification for the given Operand consisting of the options specification (if any) as of ConsoleUtility.toOptionsSpec(Operand) and the parameter specification (if any) as of ConsoleUtility.toParameterSpec(Operand).
toState() - Method in class org.refcodes.console.AbstractOperand
The 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.console.AbstractOption
The 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.console.AndCondition
The 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.console.OptionalCondition
The 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.console.OrCondition
The 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.console.Syntaxable
The 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.console.XorCondition
The 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.console.AbstractCondition
toString() - Method in class org.refcodes.console.AbstractOperand
toString() - Method in class org.refcodes.console.OptionalCondition
toSyntax(SyntaxNotation) - Method in interface org.refcodes.console.Syntaxable
This method is to be called from inside the Syntaxable hierarchy; use the method SyntaxUsage.toUsage(SyntaxNotation) in case you invoke syntax retrieval from the root Syntaxable.
toSyntax(SyntaxNotation, String, String) - Method in class org.refcodes.console.AbstractCondition
This method is to be called from inside the Syntaxable hierarchy; use the method SyntaxUsage.toUsage(SyntaxNotation) in case you invoke syntax retrieval from the root Syntaxable.
toSyntax(SyntaxNotation, String, String) - Method in class org.refcodes.console.AbstractOperand
This method is to be called from inside the Syntaxable hierarchy; use the method SyntaxUsage.toUsage(SyntaxNotation) in case you invoke syntax retrieval from the root Syntaxable.
toSyntax(SyntaxNotation, String, String) - Method in class org.refcodes.console.AbstractOption
This method is to be called from inside the Syntaxable hierarchy; use the method SyntaxUsage.toUsage(SyntaxNotation) in case you invoke syntax retrieval from the root Syntaxable.
toSyntax(SyntaxNotation, String, String) - Method in interface org.refcodes.console.Syntaxable
This method is to be called from inside the Syntaxable hierarchy; use the method SyntaxUsage.toUsage(SyntaxNotation) in case you invoke syntax retrieval from the root Syntaxable.
toSyntax(SyntaxNotation, String, String) - Method in class org.refcodes.console.XorCondition
This method is to be called from inside the Syntaxable hierarchy; use the method SyntaxUsage.toUsage(SyntaxNotation) in case you invoke syntax retrieval from the root Syntaxable.
toUsage() - Method in interface org.refcodes.console.SyntaxUsage
 
toUsage(SyntaxNotation) - Method in interface org.refcodes.console.SyntaxUsage
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 toSyntax(SyntaxNotation, String, String) is called from inside a Syntaxable hierarchy.
toUsage(SyntaxNotation, String, String) - Method in class org.refcodes.console.AndCondition
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 toSyntax(SyntaxNotation, String, String) is called from inside a Syntaxable hierarchy.
toUsage(SyntaxNotation, String, String) - Method in class org.refcodes.console.OptionalCondition
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 toSyntax(SyntaxNotation, String, String) is called from inside a Syntaxable hierarchy.
toUsage(SyntaxNotation, String, String) - Method in class org.refcodes.console.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 toSyntax(SyntaxNotation, String, String) is called from inside a Syntaxable hierarchy.
toUsage(SyntaxNotation, String, String) - Method in interface org.refcodes.console.SyntaxUsage
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 toSyntax(SyntaxNotation, String, String) is called from inside a Syntaxable hierarchy.
toUsage(SyntaxNotation, String, String) - Method in class org.refcodes.console.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 toSyntax(SyntaxNotation, String, String) is called from inside a Syntaxable hierarchy.
toValue(String) - Method in class org.refcodes.console.AbstractOperand
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.console.EnumOption
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.console.FileOption
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.console.Flag
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.console.IntegerOption
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.console.LongOption
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.console.StringOperand
To value.
toValue(String) - Method in class org.refcodes.console.StringOption
Double dispatch hook to be implemented by subclasses of the AbstractOperand for converting a command line argument to the required Operand's type.

U

UnknownArgsException - Exception in org.refcodes.console
Thrown in case not one command line argument matched regarding the provided args vs. the expected args.
UnknownArgsException(String[], String) - Constructor for exception org.refcodes.console.UnknownArgsException
Instantiates a new unknown args exception.
UnknownArgsException(String[], String, String) - Constructor for exception org.refcodes.console.UnknownArgsException
Instantiates a new unknown args exception.
UnknownArgsException(String[], String, Throwable) - Constructor for exception org.refcodes.console.UnknownArgsException
Instantiates a new unknown args exception.
UnknownArgsException(String[], String, Throwable, String) - Constructor for exception org.refcodes.console.UnknownArgsException
Instantiates a new unknown args exception.
UnknownArgsException(String[], Throwable) - Constructor for exception org.refcodes.console.UnknownArgsException
Instantiates a new unknown args exception.
UnknownArgsException(String[], Throwable, String) - Constructor for exception org.refcodes.console.UnknownArgsException
Instantiates a new unknown args exception.

V

valueOf(String) - Static method in enum org.refcodes.console.ExitCode
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.refcodes.console.SyntaxNotation
Returns the enum constant of this type with the specified name.
values() - Static method in enum org.refcodes.console.ExitCode
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.refcodes.console.SyntaxNotation
Returns an array containing the constants of this enum type, in the order they are declared.
verboseDebug(String) - Static method in class org.refcodes.console.ConsoleSugar
Debug flag.
verboseFlag() - Static method in class org.refcodes.console.ConsoleSugar
Verbose flag.
verboseFlag(String) - Static method in class org.refcodes.console.ConsoleSugar
Verbose flag.
VerboseFlag - Class in org.refcodes.console
A predefined verbose switch.
VerboseFlag() - Constructor for class org.refcodes.console.VerboseFlag
Constructs the predefined verbose switch.
VerboseFlag(String) - Constructor for class org.refcodes.console.VerboseFlag
Constructs the predefined verbose switch.

W

withArgsParser(ArgsParser) - Method in interface org.refcodes.console.ArgsParserAccessor.ArgsParserBuilder
Sets the args-parser for the ArgsParser property.
withBannerBorderEscapeCode(String) - Method in interface org.refcodes.console.ArgsParser
Sets the banner's border Escape-Code for the banner border Escape-Code property.
withBannerEscapeCode(String) - Method in interface org.refcodes.console.ArgsParser
Sets the banner's content Escape-Code for the banner Escape-Code property.
withBannerFont(Font) - Method in interface org.refcodes.console.ArgsParser
With banner font.
withBannerFontPalette(char[]) - Method in interface org.refcodes.console.ArgsParser
With banner font palette.
withConsoleWidth(int) - Method in interface org.refcodes.console.ArgsParser
Set the console with.
withCopyrightNote(String) - Method in interface org.refcodes.console.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.console.ArgsParser
With description.
withErrorOut(PrintStream) - Method in interface org.refcodes.console.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.console.ArgsParser
withEvalArgs(String[]) - Method in interface org.refcodes.console.ArgsParser
Same as ArgsParser.evalArgs(String[]) 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.console.ArgsParser
Same as ArgsParser.evalArgs(List) with the difference that this class's instance being invoked is returned as of the builder pattern.
withLicenseNote(String) - Method in interface org.refcodes.console.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.console.ArgsParser
Set the console's line break.
withLineSeparatorEscapeCode(String) - Method in interface org.refcodes.console.ArgsParser
Sets the line separator Escape-Code for the line separator Escape-Code property.
withMaxConsoleWidth(int) - Method in interface org.refcodes.console.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.console.ArgsParser
With name.
withParameterDescriptionEscapeCode(String) - Method in interface org.refcodes.console.ArgsParser
Sets the parameter's description Escape-Code for the parameter's description Escape-Code property.
withParameterEscapeCode(String) - Method in interface org.refcodes.console.ArgsParser
Sets the parameter Escape-Code for the parameter Escape-Code property.
withParseArgs(String[]) - Method in interface org.refcodes.console.ArgsParser
Calls ArgsParser.evalArgs(String[]) and returns this invoked instance as of the builder pattern.
withParseArgs(String[]) - Method in interface org.refcodes.console.ArgsParserMixin
Evaluates the provided command line arguments.
withParseArgs(List<String>) - Method in interface org.refcodes.console.ArgsParserMixin
Evaluates the provided command line arguments .
withResetEscapeCode(String) - Method in interface org.refcodes.console.ArgsParser
withRootCondition(Condition) - Method in interface org.refcodes.console.RootConditionAccessor.RootConditionBuilder
Sets the rootCondition for the rootCondition property.
withSeparatorChar(char) - Method in interface org.refcodes.console.ArgsParser
Set the character to be used when printing a separator line with the ArgsParser.printSeparatorLn() method.
withStandardOut(PrintStream) - Method in interface org.refcodes.console.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.console.ArgsParser
Set the SyntaxNotation and make other adjustments with the result (with regards to the Builder-Pattern).
withTitle(String) - Method in interface org.refcodes.console.ArgsParser
With title.
withUsageLabel(String) - Method in interface org.refcodes.console.ArgsParser
Set the usage label used by the ArgsParser.printHelp() method when writing out the syntax and make other adjustments with the result (with regards to the Builder-Pattern).

X

xor(Syntaxable...) - Static method in class org.refcodes.console.ConsoleSugar
Xor.
XorCondition - Class in org.refcodes.console
An XorCondition represents a list of Syntaxable instances of which only one is allowed to be parsed successfully when the Syntaxables' parseArgs(String[], String[]) methods are invoked.
XorCondition(Syntaxable...) - Constructor for class org.refcodes.console.XorCondition
Instantiates a new xor condition impl.

_

_value - Variable in class org.refcodes.console.AbstractOperand
 
A C D E F G H I L O P Q R S T U V W X _