Skip navigation links
A C E F G H I L O P Q R S T U V W X 

A

AbstractArgsException(String[], String, String) - Constructor for exception org.refcodes.console.AbstractConsoleException.AbstractArgsException
 
AbstractArgsException(String[], String, Throwable, String) - Constructor for exception org.refcodes.console.AbstractConsoleException.AbstractArgsException
 
AbstractArgsException(String[], String, Throwable) - Constructor for exception org.refcodes.console.AbstractConsoleException.AbstractArgsException
 
AbstractArgsException(String[], String) - Constructor for exception org.refcodes.console.AbstractConsoleException.AbstractArgsException
 
AbstractArgsException(String[], Throwable, String) - Constructor for exception org.refcodes.console.AbstractConsoleException.AbstractArgsException
 
AbstractArgsException(String[], Throwable) - Constructor for exception org.refcodes.console.AbstractConsoleException.AbstractArgsException
 
AbstractCliException(ExitCode, String, String) - Constructor for exception org.refcodes.console.AbstractConsoleException.AbstractCliException
 
AbstractCliException(ExitCode, String, Throwable, String) - Constructor for exception org.refcodes.console.AbstractConsoleException.AbstractCliException
 
AbstractCliException(ExitCode, String, Throwable) - Constructor for exception org.refcodes.console.AbstractConsoleException.AbstractCliException
 
AbstractCliException(ExitCode, String) - Constructor for exception org.refcodes.console.AbstractConsoleException.AbstractCliException
 
AbstractCliException(ExitCode, Throwable, String) - Constructor for exception org.refcodes.console.AbstractConsoleException.AbstractCliException
 
AbstractCliException(ExitCode, Throwable) - Constructor for exception org.refcodes.console.AbstractConsoleException.AbstractCliException
 
AbstractCondition - Class in org.refcodes.console.impls
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.impls.AbstractCondition
 
AbstractConsoleException - Exception in org.refcodes.console
Base exception for the console artifact.
AbstractConsoleException(String, String) - Constructor for exception org.refcodes.console.AbstractConsoleException
 
AbstractConsoleException(String, Throwable, String) - Constructor for exception org.refcodes.console.AbstractConsoleException
 
AbstractConsoleException(String, Throwable) - Constructor for exception org.refcodes.console.AbstractConsoleException
 
AbstractConsoleException(String) - Constructor for exception org.refcodes.console.AbstractConsoleException
 
AbstractConsoleException(Throwable, String) - Constructor for exception org.refcodes.console.AbstractConsoleException
 
AbstractConsoleException(Throwable) - Constructor for exception org.refcodes.console.AbstractConsoleException
 
AbstractConsoleException.AbstractArgsException - Exception in org.refcodes.console
This abstract exception is the base exception for all command line argument related exceptions.
AbstractConsoleException.AbstractCliException - Exception in org.refcodes.console
 
AbstractOperand<T> - Class in org.refcodes.console.impls
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.impls.AbstractOperand
Constructs a Operand with the given arguments.
AbstractOption<T> - Class in org.refcodes.console.impls
The AbstractOption is an abstract implementation of an Option providing the boiler plate when implementing the Option interface.
AbstractOption(String, String, Class<T>, String, String) - Constructor for class org.refcodes.console.impls.AbstractOption
Constructs a Option with the given arguments.
AbstractOption(String, String, Class<T>, String) - Constructor for class org.refcodes.console.impls.AbstractOption
Constructs a Option with the given arguments.
AbstractSyntaxable - Class in org.refcodes.console.impls
The AbstractSyntaxable just implements the #evalArgs(String[]) method which delegates to the Syntaxable.parseArgs(String[]) method and determines the superfluous arguments.
AbstractSyntaxable() - Constructor for class org.refcodes.console.impls.AbstractSyntaxable
 
addChild(Syntaxable) - Method in class org.refcodes.console.impls.AbstractCondition
 
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, String) - Constructor for exception org.refcodes.console.AmbiguousArgsException
 
AmbiguousArgsException(String[], String, Throwable, String) - Constructor for exception org.refcodes.console.AmbiguousArgsException
 
AmbiguousArgsException(String[], String, Throwable) - Constructor for exception org.refcodes.console.AmbiguousArgsException
 
AmbiguousArgsException(String[], String) - Constructor for exception org.refcodes.console.AmbiguousArgsException
 
AmbiguousArgsException(String[], Throwable, String) - Constructor for exception org.refcodes.console.AmbiguousArgsException
 
AmbiguousArgsException(String[], Throwable) - Constructor for exception org.refcodes.console.AmbiguousArgsException
 
AndConditionImpl - Class in org.refcodes.console.impls
An AndConditionImpl represents a list of Syntaxable instances of which all are be parsed successfully when the Syntaxables' Syntaxable.parseArgs(String[]) methods are invoked.
AndConditionImpl(Syntaxable...) - Constructor for class org.refcodes.console.impls.AndConditionImpl
 
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, String) - Constructor for exception org.refcodes.console.ArgsMismatchException
 
ArgsMismatchException(String[], String, Throwable, String) - Constructor for exception org.refcodes.console.ArgsMismatchException
 
ArgsMismatchException(String[], String, Throwable) - Constructor for exception org.refcodes.console.ArgsMismatchException
 
ArgsMismatchException(String[], String) - Constructor for exception org.refcodes.console.ArgsMismatchException
 
ArgsMismatchException(String[], Throwable, String) - Constructor for exception org.refcodes.console.ArgsMismatchException
 
ArgsMismatchException(String[], Throwable) - Constructor for exception org.refcodes.console.ArgsMismatchException
 
ArgsParser - Interface in org.refcodes.console
The ArgsParser provides means for parsing command line arguments and constructing a command line utility's help output.
ArgsParserImpl - Class in org.refcodes.console.impls
A straightforward implementation of the ArgsParser interface.
ArgsParserImpl(Condition) - Constructor for class org.refcodes.console.impls.ArgsParserImpl
Constructs the ArgsParser instance with the given root Condition and the default SyntaxNotation.REFCODES.

C

compareTo(Operand<?>) - Method in class org.refcodes.console.impls.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).
ConsoleConsts - Interface in org.refcodes.console
Constant definitions used by the refcodes-console artifact.
ConsoleSyntaxByDeclaration - Class in org.refcodes.console
 
ConsoleSyntaxByDeclaration() - Constructor for class org.refcodes.console.ConsoleSyntaxByDeclaration
 
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.

E

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.impls.ArgsParserImpl
 
ExitCode - Enum in org.refcodes.console
Some default exit codes defined for CLI applications.

F

ForceSwitchImpl - Class in org.refcodes.console.impls
A predefined force switch.
ForceSwitchImpl(String) - Constructor for class org.refcodes.console.impls.ForceSwitchImpl
Constructs the predefined help switch.

G

getArgs() - Method in exception org.refcodes.console.AbstractConsoleException.AbstractArgsException
 
getArgs() - Method in interface org.refcodes.console.ArgsAccessor
Retrieves the command line arguments from the args property.
getArgs() - Method in class org.refcodes.console.impls.AbstractOperand
 
getArgs() - Method in interface org.refcodes.console.Operand
When being parsed via the Syntaxable.parseArgs(String[]) method, then the Operand.getArgs() method returns the command line arguments representing this Operand instance (also including the short or the long options, see Operand).
getChildren() - Method in class org.refcodes.console.impls.AbstractCondition
 
getDescription() - Method in class org.refcodes.console.impls.AbstractOperand
 
getLongOption() - Method in class org.refcodes.console.impls.AbstractOption
 
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.
getOptionArgument(Option<?>, 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.
getParameterName() - Method in class org.refcodes.console.impls.AbstractOperand
 
getParameterName() - Method in interface org.refcodes.console.Operand
Retrieves the name 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.
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.impls.ArgsParserImpl
 
getShortOption() - Method in class org.refcodes.console.impls.AbstractOption
 
getShortOption() - Method in interface org.refcodes.console.Option
Returns the short-option representing an Option instance.
getStatusCode() - Method in exception org.refcodes.console.AbstractConsoleException.AbstractCliException
 
getStatusCode() - Method in enum org.refcodes.console.ExitCode
 
getType() - Method in class org.refcodes.console.impls.AbstractOperand
 
getValue() - Method in class org.refcodes.console.impls.AbstractOperand
 
getValue() - Method in interface org.refcodes.console.Operand
When being parsed via the Syntaxable.parseArgs(String[]) method, then the Operand.getValue() method returns the parsed value.

H

HelpSwitchImpl - Class in org.refcodes.console.impls
A predefined help switch.
HelpSwitchImpl(String) - Constructor for class org.refcodes.console.impls.HelpSwitchImpl
Constructs the predefined help switch.

I

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.impls.ForceSwitchImpl
 
LONG_OPTION - Static variable in class org.refcodes.console.impls.HelpSwitchImpl
 
LONG_OPTION - Static variable in class org.refcodes.console.impls.QuietSwitchImpl
 
LONG_OPTION - Static variable in class org.refcodes.console.impls.VerboseSwitchImpl
 
LONG_OPTION_PREFIX - Static variable in interface org.refcodes.console.ConsoleConsts
A long-option is prefixed with a double hyphen-minus "--".

O

Operand<T> - Interface in org.refcodes.console
An Operand represents a value parsed from command line arguments.An Operand has a state which changes with each invocation of the Syntaxable.parseArgs(String[]) method.
Option<T> - Interface in org.refcodes.console
An Option represents a command line option with the according option's value.
OPTION_PREFIXES - Static variable in interface org.refcodes.console.ConsoleConsts
All option prefixes as defines by this ConsoleConsts interface; being the ConsoleConsts.SHORT_OPTION_PREFIX and the "--".
OptionalImpl - Class in org.refcodes.console.impls
 
OptionalImpl(Syntaxable) - Constructor for class org.refcodes.console.impls.OptionalImpl
 
OrConditionImpl - Class in org.refcodes.console.impls
An OrConditionImpl represents a list of Syntaxable instances of which at least one must be parsed successfully when the Syntaxable s' Syntaxable.parseArgs(String[]) methods are invoked.
OrConditionImpl(Syntaxable...) - Constructor for class org.refcodes.console.impls.OrConditionImpl
 
org.refcodes.console - package org.refcodes.console
Getting started: Consider you have a tool called "foo-bar" to be invoked with the below allowed argument combinations (syntax): foo-bar [{ -a | -d }] -f <file> "foo-bar" can be invoked either with an optional "-a" or with an optional "-d" switch, but not both of them at the same time, and a file "-f <file>" must be provided, else the passed arguments are rejected as not being valid.
org.refcodes.console.impls - package org.refcodes.console.impls
Implementations: The impls package contains implementations of the types defined by this artifact.

P

parseArgs(String[]) - Method in class org.refcodes.console.impls.AbstractOperand
 
parseArgs(String[]) - Method in class org.refcodes.console.impls.AbstractOption
 
parseArgs(String[]) - Method in class org.refcodes.console.impls.AndConditionImpl
 
parseArgs(String[]) - Method in class org.refcodes.console.impls.OptionalImpl
 
parseArgs(String[]) - Method in class org.refcodes.console.impls.OrConditionImpl
 
parseArgs(String[]) - Method in class org.refcodes.console.impls.SwitchImpl
 
parseArgs(String[]) - Method in class org.refcodes.console.impls.XorConditionImpl
 
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' Syntaxable.parseArgs(String[]) methods.
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, String) - Constructor for exception org.refcodes.console.ParseArgsException
 
ParseArgsException(String[], String, Throwable, String) - Constructor for exception org.refcodes.console.ParseArgsException
 
ParseArgsException(String[], String, Throwable) - Constructor for exception org.refcodes.console.ParseArgsException
 
ParseArgsException(String[], String) - Constructor for exception org.refcodes.console.ParseArgsException
 
ParseArgsException(String[], Throwable, String) - Constructor for exception org.refcodes.console.ParseArgsException
 
ParseArgsException(String[], Throwable) - Constructor for exception org.refcodes.console.ParseArgsException
 
parseSyntax(SyntaxNotation) - Method in class org.refcodes.console.impls.AbstractSyntaxable
 
parseSyntax(SyntaxNotation) - Method in class org.refcodes.console.impls.AndConditionImpl
 
parseSyntax(SyntaxNotation) - Method in class org.refcodes.console.impls.OrConditionImpl
 
parseSyntax(SyntaxNotation) - Method in class org.refcodes.console.impls.XorConditionImpl
 
parseSyntax(SyntaxNotation) - Method in interface org.refcodes.console.Syntaxable
This method is to be called from from the root Syntaxable; when invoking syntax retrieval inside the Syntaxable hierarchy use the method Syntaxable.toSyntax(SyntaxNotation) .
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.impls.ArgsParserImpl
 
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.impls.ArgsParserImpl
 
printDescription() - Method in interface org.refcodes.console.ArgsParser
Prints the description as set by the DescriptionAccessor.DescriptionBuilder.withDescription(String) method with regards to the console width as specified by the ArgsParser.withConsoleWidth(int) method.
printDescription() - Method in class org.refcodes.console.impls.ArgsParserImpl
 
printHelp() - Method in interface org.refcodes.console.ArgsParser
Prints the help to the standard output specified by the ArgsParser.withStandardOut(PrintStream) method.
printHelp() - Method in class org.refcodes.console.impls.ArgsParserImpl
 
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.impls.ArgsParserImpl
 
printLn(String) - Method in interface org.refcodes.console.ArgsParser
Prints the given line 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(String) - Method in class org.refcodes.console.impls.ArgsParserImpl
 
printLn() - Method in class org.refcodes.console.impls.ArgsParserImpl
 
printOptions() - Method in interface org.refcodes.console.ArgsParser
Prints the Options (short- and the long-options), the Switches and the Operator and their description with regards to the console width as specified by the ArgsParser.withConsoleWidth(int) method.
printOptions() - Method in class org.refcodes.console.impls.ArgsParserImpl
 
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.impls.ArgsParserImpl
 
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.impls.ArgsParserImpl
 

Q

QuietSwitchImpl - Class in org.refcodes.console.impls
A predefined "be quiet" switch.
QuietSwitchImpl(String) - Constructor for class org.refcodes.console.impls.QuietSwitchImpl
Constructs the predefined verbose switch.

R

reset() - Method in class org.refcodes.console.impls.AbstractCondition
 
reset() - Method in class org.refcodes.console.impls.AbstractOperand
 
reset() - Method in class org.refcodes.console.impls.ArgsParserImpl
 
reset() - Method in class org.refcodes.console.impls.OptionalImpl
 
reset() - Method in class org.refcodes.console.impls.SwitchImpl
 

S

setArgs(String[]) - Method in interface org.refcodes.console.ArgsAccessor.ArgsMutator
Sets the command line arguments for the args property.
setArgs(String[]) - Method in class org.refcodes.console.impls.AbstractOperand
Sets the command line argument(s) representing the Operand and its value as parsed by the AbstractOperand.parseArgs(String[]) method.
setArgs(String[]) - Method in class org.refcodes.console.impls.AbstractOption
 
setConsoleWidth(int) - Method in interface org.refcodes.console.ArgsParser
Set the console with and make other adjustments with the result (with regards to the builder pattern).
setConsoleWidth(int) - Method in class org.refcodes.console.impls.ArgsParserImpl
 
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.impls.ArgsParserImpl
 
setDescription(String) - Method in class org.refcodes.console.impls.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 and make other adjustments with the result (with regards to the builder pattern).
setLicenseNote(String) - Method in class org.refcodes.console.impls.ArgsParserImpl
 
setLineBreak(String) - Method in interface org.refcodes.console.ArgsParser
Set the console's line break and make other adjustments with the result (with regards to the builder pattern).
setLineBreak(String) - Method in class org.refcodes.console.impls.ArgsParserImpl
 
setName(String) - Method in class org.refcodes.console.impls.ArgsParserImpl
 
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.impls.ArgsParserImpl
 
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.impls.ArgsParserImpl
 
setSyntaxNotation(SyntaxNotation) - Method in interface org.refcodes.console.ArgsParser
Set the SyntaxNotation and make other adjustments with the result (with regards to the builder pattern).
setSyntaxNotation(SyntaxNotation) - Method in class org.refcodes.console.impls.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 and make other adjustments with the result (with regards to the builder pattern).
setUsageLabel(String) - Method in class org.refcodes.console.impls.ArgsParserImpl
 
setValue(T) - Method in class org.refcodes.console.impls.AbstractOperand
Sets the value for the Operand as parsed by the AbstractOperand.parseArgs(String[]) method.
setValue(T) - Method in class org.refcodes.console.impls.AbstractOption
 
SHORT_OPTION - Static variable in class org.refcodes.console.impls.ForceSwitchImpl
 
SHORT_OPTION - Static variable in class org.refcodes.console.impls.HelpSwitchImpl
 
SHORT_OPTION - Static variable in class org.refcodes.console.impls.QuietSwitchImpl
 
SHORT_OPTION - Static variable in class org.refcodes.console.impls.VerboseSwitchImpl
 
SHORT_OPTION_PREFIX - Static variable in interface org.refcodes.console.ConsoleConsts
A short-option is prefixed with a single hyphen-minus "-".
StringOperandImpl - Class in org.refcodes.console.impls
 
StringOperandImpl(String, String) - Constructor for class org.refcodes.console.impls.StringOperandImpl
 
StringOptionImpl - Class in org.refcodes.console.impls
 
StringOptionImpl(String, String, String, String) - Constructor for class org.refcodes.console.impls.StringOptionImpl
 
SuperfluousArgsException - Exception in org.refcodes.console
Thrown in case there were arguments found not being used (superfluous arguments).
SuperfluousArgsException(String[], String, String) - Constructor for exception org.refcodes.console.SuperfluousArgsException
 
SuperfluousArgsException(String[], String, Throwable, String) - Constructor for exception org.refcodes.console.SuperfluousArgsException
 
SuperfluousArgsException(String[], String, Throwable) - Constructor for exception org.refcodes.console.SuperfluousArgsException
 
SuperfluousArgsException(String[], String) - Constructor for exception org.refcodes.console.SuperfluousArgsException
 
SuperfluousArgsException(String[], Throwable, String) - Constructor for exception org.refcodes.console.SuperfluousArgsException
 
SuperfluousArgsException(String[], Throwable) - Constructor for exception org.refcodes.console.SuperfluousArgsException
 
Switch - Interface in org.refcodes.console
A Switch is an Option with a Boolean state.
SwitchImpl - Class in org.refcodes.console.impls
 
SwitchImpl(String, String, String) - Constructor for class org.refcodes.console.impls.SwitchImpl
Constructs a Switch
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 Syntaxable.toSyntax(SyntaxNotation) method to determine which notation to be used for the generated syntax.

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 interface org.refcodes.console.Condition
Traverses the hierarchy of Conditions and collects all therein found Operands and sub-types such as the Switch or the Option; This is most useful when creating a list of Options, Switches and Operands when printing out detailed help.o
toOperands() - Method in class org.refcodes.console.impls.AbstractCondition
 
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.impls.AbstractOperand
 
toState() - Method in class org.refcodes.console.impls.AbstractOption
 
toState() - Method in class org.refcodes.console.impls.AndConditionImpl
 
toState() - Method in class org.refcodes.console.impls.OptionalImpl
 
toState() - Method in class org.refcodes.console.impls.OrConditionImpl
 
toState() - Method in class org.refcodes.console.impls.XorConditionImpl
 
toState() - Method in interface org.refcodes.console.Syntaxable
The Syntaxable.toState() method might be used by the #toString() method and prints out the state of the syntaxable and (if any) its children.
toString() - Method in class org.refcodes.console.impls.AbstractCondition
 
toString() - Method in class org.refcodes.console.impls.AbstractOperand
 
toString() - Method in class org.refcodes.console.impls.OptionalImpl
 
toSyntax(SyntaxNotation) - Method in class org.refcodes.console.impls.AbstractCondition
 
toSyntax(SyntaxNotation) - Method in class org.refcodes.console.impls.AbstractOperand
 
toSyntax(SyntaxNotation) - Method in class org.refcodes.console.impls.AbstractOption
 
toSyntax(SyntaxNotation) - Method in class org.refcodes.console.impls.OptionalImpl
 
toSyntax(SyntaxNotation) - Method in class org.refcodes.console.impls.XorConditionImpl
 
toSyntax(SyntaxNotation) - Method in interface org.refcodes.console.Syntaxable
This method is to be called from inside the Syntaxable hierarchy; use the method Syntaxable.parseSyntax(SyntaxNotation) in case you invoke syntax retrieval from the root Syntaxable.
toValue(String) - Method in class org.refcodes.console.impls.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.impls.StringOperandImpl
 
toValue(String) - Method in class org.refcodes.console.impls.StringOptionImpl
 
toValue(String) - Method in class org.refcodes.console.impls.SwitchImpl
 

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, String) - Constructor for exception org.refcodes.console.UnknownArgsException
 
UnknownArgsException(String[], String, Throwable, String) - Constructor for exception org.refcodes.console.UnknownArgsException
 
UnknownArgsException(String[], String, Throwable) - Constructor for exception org.refcodes.console.UnknownArgsException
 
UnknownArgsException(String[], String) - Constructor for exception org.refcodes.console.UnknownArgsException
 
UnknownArgsException(String[], Throwable, String) - Constructor for exception org.refcodes.console.UnknownArgsException
 
UnknownArgsException(String[], Throwable) - Constructor for exception org.refcodes.console.UnknownArgsException
 

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.
VerboseSwitchImpl - Class in org.refcodes.console.impls
A predefined verbose switch.
VerboseSwitchImpl(String) - Constructor for class org.refcodes.console.impls.VerboseSwitchImpl
Constructs the predefined verbose switch.

W

withConsoleWidth(int) - Method in interface org.refcodes.console.ArgsParser
Set the console with and make other adjustments with the result (with regards to the builder pattern).
withConsoleWidth(int) - Method in class org.refcodes.console.impls.ArgsParserImpl
 
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).
withCopyrightNote(String) - Method in class org.refcodes.console.impls.ArgsParserImpl
 
withDescription(String) - Method in class org.refcodes.console.impls.ArgsParserImpl
 
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).
withLicenseNote(String) - Method in class org.refcodes.console.impls.ArgsParserImpl
 
withLineBreak(String) - Method in interface org.refcodes.console.ArgsParser
Set the console's line break and make other adjustments with the result (with regards to the builder pattern).
withLineBreak(String) - Method in class org.refcodes.console.impls.ArgsParserImpl
 
withName(String) - Method in class org.refcodes.console.impls.ArgsParserImpl
 
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.
withSeparatorChar(char) - Method in class org.refcodes.console.impls.ArgsParserImpl
 
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).
withStandardOut(PrintStream) - Method in class org.refcodes.console.impls.ArgsParserImpl
 
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).
withSyntaxNotation(SyntaxNotation) - Method in class org.refcodes.console.impls.ArgsParserImpl
 
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).
withUsageLabel(String) - Method in class org.refcodes.console.impls.ArgsParserImpl
 

X

XorConditionImpl - Class in org.refcodes.console.impls
An XorConditionImpl represents a list of Syntaxable instances of which only one is allowed to be parsed successfully when the Syntaxables' Syntaxable.parseArgs(String[]) methods are invoked.
XorConditionImpl(Syntaxable...) - Constructor for class org.refcodes.console.impls.XorConditionImpl
 
A C E F G H I L O P Q R S T U V W X 
Skip navigation links

Copyright © 2015. All rights reserved.