- AbstractCondition - Class in org.refcodes.console
-
- AbstractCondition(Syntaxable...) - Constructor for class org.refcodes.console.AbstractCondition
-
Instantiates a new abstract condition.
- AbstractOperand<T> - Class in org.refcodes.console
-
- AbstractOperand(Class<T>, String, String) - Constructor for class org.refcodes.console.AbstractOperand
-
Constructs a
Operand
with the given arguments.
- AbstractOption<T> - Class in org.refcodes.console
-
- AbstractOption(String, String, Class<T>, String, String) - Constructor for class org.refcodes.console.AbstractOption
-
Constructs a
Option
with the given arguments.
- AbstractOption(String, String, Class<T>, String) - Constructor for class org.refcodes.console.AbstractOption
-
Constructs a
Option
with the given arguments.
- addChild(Syntaxable) - Method in class org.refcodes.console.AbstractCondition
-
Adds the child.
- 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
-
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[], String, Throwable) - Constructor for exception org.refcodes.console.AmbiguousArgsException
-
Instantiates a new ambiguous args exception.
- AmbiguousArgsException(String[], String) - 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.
- AmbiguousArgsException(String[], Throwable) - Constructor for exception org.refcodes.console.AmbiguousArgsException
-
Instantiates a new ambiguous args exception.
- and(Syntaxable...) - Static method in class org.refcodes.console.ConsoleSugar
-
And.
- AndConditionImpl - Class in org.refcodes.console
-
- AndConditionImpl(Syntaxable...) - Constructor for class org.refcodes.console.AndConditionImpl
-
Instantiates a new and condition impl.
- 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
-
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[], String, Throwable) - Constructor for exception org.refcodes.console.ArgsMismatchException
-
Instantiates a new args mismatch exception.
- ArgsMismatchException(String[], String) - 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.
- ArgsMismatchException(String[], Throwable) - 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.
- ArgsParserImpl - Class in org.refcodes.console
-
A straightforward implementation of the
ArgsParser
interface.
- ArgsParserImpl(Condition) - Constructor for class org.refcodes.console.ArgsParserImpl
-
- 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
Operand
s
(leafs).
- ConsoleArgsException(String[], String, String) - 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[], String, Throwable) - Constructor for exception org.refcodes.console.ConsoleException.ConsoleArgsException
-
Instantiates a new console args exception.
- ConsoleArgsException(String[], String) - 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.
- ConsoleArgsException(String[], Throwable) - Constructor for exception org.refcodes.console.ConsoleException.ConsoleArgsException
-
Instantiates a new console args exception.
- ConsoleCliException(ExitCode, String, String) - 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, String, Throwable) - Constructor for exception org.refcodes.console.ConsoleException.ConsoleCliException
-
Instantiates a new console cli exception.
- ConsoleCliException(ExitCode, String) - 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.
- ConsoleCliException(ExitCode, Throwable) - 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, String) - 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(String, Throwable) - Constructor for exception org.refcodes.console.ConsoleException
-
Instantiates a new console exception.
- ConsoleException(String) - 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(Throwable) - 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
Switch
,
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.
- setArgs(String[]) - Method in class org.refcodes.console.AbstractOperand
-
- setArgs(String[]) - Method in class org.refcodes.console.AbstractOption
-
- setArgs(String[]) - Method in interface org.refcodes.console.ArgsAccessor.ArgsMutator
-
Sets the command line arguments for the args property.
- setBannerFont(Font) - Method in interface org.refcodes.console.ArgsParser
-
Sets the banner font.
- setBannerFont(Font) - Method in class org.refcodes.console.ArgsParserImpl
-
- setBannerFontPalette(char[]) - Method in interface org.refcodes.console.ArgsParser
-
Sets the banner font palette.
- setBannerFontPalette(char[]) - Method in class org.refcodes.console.ArgsParserImpl
-
- setConsoleWidth(int) - Method in interface org.refcodes.console.ArgsParser
-
Set the console with.
- setConsoleWidth(int) - Method in class org.refcodes.console.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.ArgsParserImpl
-
- 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
-
- setLicenseNote(String) - Method in interface org.refcodes.console.ArgsParser
-
- setLicenseNote(String) - Method in class org.refcodes.console.ArgsParserImpl
-
- setLineBreak(String) - Method in interface org.refcodes.console.ArgsParser
-
Set the console's line break.
- setLineBreak(String) - Method in class org.refcodes.console.ArgsParserImpl
-
- 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
-
- setName(String) - Method in class org.refcodes.console.ArgsParserImpl
-
- setSeparatorChar(char) - Method in interface org.refcodes.console.ArgsParser
-
- setSeparatorChar(char) - Method in class org.refcodes.console.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.ArgsParserImpl
-
- 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
-
- setUsageLabel(String) - Method in class org.refcodes.console.ArgsParserImpl
-
- setValue(T) - Method in class org.refcodes.console.AbstractOperand
-
- setValue(T) - Method in class org.refcodes.console.AbstractOption
-
- SHORT_OPTION - Static variable in class org.refcodes.console.ForceSwitchImpl
-
- SHORT_OPTION - Static variable in class org.refcodes.console.HelpSwitchImpl
-
- SHORT_OPTION - Static variable in class org.refcodes.console.QuietSwitchImpl
-
- SHORT_OPTION - Static variable in class org.refcodes.console.SysInfoSwitchImpl
-
- SHORT_OPTION - Static variable in class org.refcodes.console.VerboseSwitchImpl
-
- stringOperand(String, String) - Static method in class org.refcodes.console.ConsoleSugar
-
String operand.
- StringOperandImpl - Class in org.refcodes.console
-
An
Operand
(neither a short option nor a long option prepended nor
being a switch) being s
String
.
- StringOperandImpl(String, String) - Constructor for class org.refcodes.console.StringOperandImpl
-
Instantiates a new string operand impl.
- stringOption(String, String, String, String) - Static method in class org.refcodes.console.ConsoleSugar
-
String option.
- StringOptionImpl - Class in org.refcodes.console
-
The Class StringOptionImpl.
- StringOptionImpl(String, String, String, String) - Constructor for class org.refcodes.console.StringOptionImpl
-
Instantiates a new string option impl.
- 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
-
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[], String, Throwable) - Constructor for exception org.refcodes.console.SuperfluousArgsException
-
Instantiates a new superfluous args exception.
- SuperfluousArgsException(String[], String) - 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.
- SuperfluousArgsException(String[], Throwable) - Constructor for exception org.refcodes.console.SuperfluousArgsException
-
Instantiates a new superfluous args exception.
- Switch - Interface in org.refcodes.console
-
- SwitchImpl - Class in org.refcodes.console
-
The Class SwitchImpl.
- SwitchImpl(String, String, String) - Constructor for class org.refcodes.console.SwitchImpl
-
- switsh(String, String, String) - Static method in class org.refcodes.console.ConsoleSugar
-
As "switch" is a reserved word in Java, we use "switsh" :-(.
- 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
-
- sysInfoSwitch(String) - Static method in class org.refcodes.console.ConsoleSugar
-
Sys info switch.
- sysInfoSwitch() - Static method in class org.refcodes.console.ConsoleSugar
-
Sys info switch.
- SysInfoSwitchImpl - Class in org.refcodes.console
-
A predefined system information switch.
- SysInfoSwitchImpl(String) - Constructor for class org.refcodes.console.SysInfoSwitchImpl
-
Constructs the predefined system information switch.
- SysInfoSwitchImpl() - Constructor for class org.refcodes.console.SysInfoSwitchImpl
-
Constructs the predefined system information switch.