Index

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

A

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

B

BannerBorderEscapeCodeAccessor - Interface in org.refcodes.cli
Provides an accessor for a banner border Escape-Code property.
BannerBorderEscapeCodeAccessor.BannerBorderEscapeCodeBuilder<B extends BannerBorderEscapeCodeAccessor.BannerBorderEscapeCodeBuilder<B>> - Interface in org.refcodes.cli
Provides a builder method for a banner border Escape-Code property returning the builder for applying multiple build operations.
BannerBorderEscapeCodeAccessor.BannerBorderEscapeCodeMutator - Interface in org.refcodes.cli
Provides a mutator for a banner border Escape-Code property.
BannerBorderEscapeCodeAccessor.BannerBorderEscapeCodeProperty - Interface in org.refcodes.cli
Provides a banner border Escape-Code property.
BannerEscapeCodeAccessor - Interface in org.refcodes.cli
Provides an accessor for a banner Escape-Code property.
BannerEscapeCodeAccessor.BannerEscapeCodeBuilder<B extends BannerEscapeCodeAccessor.BannerEscapeCodeBuilder<B>> - Interface in org.refcodes.cli
Provides a builder method for a banner Escape-Code property returning the builder for applying multiple build operations.
BannerEscapeCodeAccessor.BannerEscapeCodeMutator - Interface in org.refcodes.cli
Provides a mutator for a banner Escape-Code property.
BannerEscapeCodeAccessor.BannerEscapeCodeProperty - Interface in org.refcodes.cli
Provides a banner Escape-Code property.
BannerFontAccessor - Interface in org.refcodes.cli
Provides an accessor for a banner Font property.
BannerFontAccessor.BannerFontBuilder<B extends BannerFontAccessor.BannerFontBuilder<B>> - Interface in org.refcodes.cli
Provides a builder method for a banner Font property returning the builder for applying multiple build operations.
BannerFontAccessor.BannerFontMutator - Interface in org.refcodes.cli
Provides a mutator for a banner Font property.
BannerFontAccessor.BannerFontProperty - Interface in org.refcodes.cli
Provides a banner Font property.
BannerFontPaletteAccessor - Interface in org.refcodes.cli
Provides an accessor for a banner font palette property.
BannerFontPaletteAccessor.BannerFontPaletteBuilder<B extends BannerFontPaletteAccessor.BannerFontPaletteBuilder<B>> - Interface in org.refcodes.cli
Provides a builder method for a banner font palette property returning the builder for applying multiple build operations.
BannerFontPaletteAccessor.BannerFontPaletteMutator - Interface in org.refcodes.cli
Provides a mutator for a banner font palette property.
BannerFontPaletteAccessor.BannerFontPaletteProperty - Interface in org.refcodes.cli
Provides a banner font palette property.
booleanOption(Character, String, String) - Static method in class org.refcodes.cli.CliSugar
Instantiates a new BooleanOption with the given arguments.
booleanOption(Character, String, String, String) - Static method in class org.refcodes.cli.CliSugar
Instantiates a new BooleanOption with the given arguments.
booleanOption(Character, String, String, String, Consumer<BooleanOption>) - Static method in class org.refcodes.cli.CliSugar
Instantiates a new BooleanOption with the given arguments.
booleanOption(Character, String, String, Consumer<BooleanOption>) - Static method in class org.refcodes.cli.CliSugar
Instantiates a new BooleanOption with the given arguments.
booleanOption(String, String) - Static method in class org.refcodes.cli.CliSugar
Instantiates a new BooleanOption with the given arguments.
booleanOption(String, String, String) - Static method in class org.refcodes.cli.CliSugar
Instantiates a new BooleanOption with the given arguments.
booleanOption(String, String, String, Consumer<BooleanOption>) - Static method in class org.refcodes.cli.CliSugar
Instantiates a new BooleanOption with the given arguments.
booleanOption(String, String, Consumer<BooleanOption>) - Static method in class org.refcodes.cli.CliSugar
Instantiates a new BooleanOption with the given arguments.
BooleanOption - Class in org.refcodes.cli
The BooleanOption represents an Option holding boolean values.
BooleanOption(Character, String, String) - Constructor for class org.refcodes.cli.BooleanOption
Instantiates a new BooleanOption with the given arguments.
BooleanOption(Character, String, String, String) - Constructor for class org.refcodes.cli.BooleanOption
Instantiates a new BooleanOption with the given arguments.
BooleanOption(Character, String, String, String, Consumer<BooleanOption>) - Constructor for class org.refcodes.cli.BooleanOption
Instantiates a new BooleanOption with the given arguments.
BooleanOption(Character, String, String, Consumer<BooleanOption>) - Constructor for class org.refcodes.cli.BooleanOption
Instantiates a new BooleanOption with the given arguments.
BooleanOption(String, String) - Constructor for class org.refcodes.cli.BooleanOption
Instantiates a new BooleanOption with the given arguments.
BooleanOption(String, String, String) - Constructor for class org.refcodes.cli.BooleanOption
Instantiates a new BooleanOption with the given arguments.
BooleanOption(String, String, String, Consumer<BooleanOption>) - Constructor for class org.refcodes.cli.BooleanOption
Instantiates a new BooleanOption with the given arguments.
BooleanOption(String, String, Consumer<BooleanOption>) - Constructor for class org.refcodes.cli.BooleanOption
Instantiates a new BooleanOption with the given arguments.
BooleanOption(Relation<String, Boolean>) - Constructor for class org.refcodes.cli.BooleanOption
Instantiates a new BooleanOption with the alias being the proerty's key and the value being the property's value.
BooleanOption(Relation<String, Boolean>, Consumer<BooleanOption>) - Constructor for class org.refcodes.cli.BooleanOption
Instantiates a new BooleanOption with the alias being the proerty's key and the value being the property's value.
booleanProperty(Character, String, String) - Static method in class org.refcodes.cli.CliSugar
Instantiates a new BooleanProperty with the given arguments.
booleanProperty(Character, String, String, String) - Static method in class org.refcodes.cli.CliSugar
Instantiates a new BooleanProperty with the given arguments.
booleanProperty(Character, String, String, String, Consumer<BooleanProperty>) - Static method in class org.refcodes.cli.CliSugar
Instantiates a new BooleanProperty with the given arguments.
booleanProperty(Character, String, String, Consumer<BooleanProperty>) - Static method in class org.refcodes.cli.CliSugar
Instantiates a new BooleanProperty with the given arguments.
booleanProperty(String, String) - Static method in class org.refcodes.cli.CliSugar
Instantiates a new BooleanProperty with the given arguments.
booleanProperty(String, String, String) - Static method in class org.refcodes.cli.CliSugar
Instantiates a new BooleanProperty with the given arguments.
booleanProperty(String, String, String, Consumer<BooleanProperty>) - Static method in class org.refcodes.cli.CliSugar
Instantiates a new BooleanProperty with the given arguments.
booleanProperty(String, String, Consumer<BooleanProperty>) - Static method in class org.refcodes.cli.CliSugar
Instantiates a new BooleanProperty with the given arguments.
BooleanProperty - Class in org.refcodes.cli
The BooleanProperty represents an PropertyOption holding boolean values.
BooleanProperty(Character, String, String) - Constructor for class org.refcodes.cli.BooleanProperty
Instantiates a new BooleanProperty with the given arguments.
BooleanProperty(Character, String, String, String) - Constructor for class org.refcodes.cli.BooleanProperty
Instantiates a new BooleanProperty with the given arguments.
BooleanProperty(Character, String, String, String, Consumer<BooleanProperty>) - Constructor for class org.refcodes.cli.BooleanProperty
Instantiates a new BooleanProperty with the given arguments.
BooleanProperty(Character, String, String, Consumer<BooleanProperty>) - Constructor for class org.refcodes.cli.BooleanProperty
Instantiates a new BooleanProperty with the given arguments.
BooleanProperty(String, String) - Constructor for class org.refcodes.cli.BooleanProperty
Instantiates a new BooleanProperty with the given arguments.
BooleanProperty(String, String, String) - Constructor for class org.refcodes.cli.BooleanProperty
Instantiates a new BooleanProperty with the given arguments.
BooleanProperty(String, String, String, Consumer<BooleanProperty>) - Constructor for class org.refcodes.cli.BooleanProperty
Instantiates a new BooleanProperty with the given arguments.
BooleanProperty(String, String, Consumer<BooleanProperty>) - Constructor for class org.refcodes.cli.BooleanProperty
Instantiates a new BooleanProperty with the given arguments.
BooleanProperty(Relation<String, Boolean>) - Constructor for class org.refcodes.cli.BooleanProperty
Instantiates a new BooleanProperty with the alias being the proerty's key and the value being the property's value.
BooleanProperty(Relation<String, Boolean>, Consumer<BooleanProperty>) - Constructor for class org.refcodes.cli.BooleanProperty
Instantiates a new BooleanProperty with the alias being the proerty's key and the value being the property's value.
build() - Method in class org.refcodes.cli.CliContext.Builder
CliContext.Builder for fluently building a CliContext instances.
build() - Method in class org.refcodes.cli.SyntaxMetricsImpl.Builder
SyntaxMetricsImpl.Builder for fluently building a SyntaxMetrics instances.
builder() - Static method in class org.refcodes.cli.CliContext
Creates a CliContext.Builder used to fluently construct CliContext instances.
builder() - Static method in class org.refcodes.cli.SyntaxMetricsImpl
Creates a SyntaxMetricsImpl.Builder used to fluently construct SyntaxMetrics instances.

C

cases(Term...) - Static method in class org.refcodes.cli.CliSugar
Instantiates a new CasesCondition with the Term (Condition) instances to be nested.
CasesCondition - Class in org.refcodes.cli
The CasesCondition is an XorCondition making sure that all possible cases inside the XorCondition must(!)
CasesCondition(Term...) - Constructor for class org.refcodes.cli.CasesCondition
Instantiates a new CasesCondition with the Term (Condition) instances to be nested.
charOption(Character, String, String) - Static method in class org.refcodes.cli.CliSugar
Instantiates a new CharOption with the given arguments.
charOption(Character, String, String, String) - Static method in class org.refcodes.cli.CliSugar
Instantiates a new CharOption with the given arguments.
charOption(Character, String, String, String, Consumer<CharOption>) - Static method in class org.refcodes.cli.CliSugar
Instantiates a new CharOption with the given arguments.
charOption(Character, String, String, Consumer<CharOption>) - Static method in class org.refcodes.cli.CliSugar
Instantiates a new CharOption with the given arguments.
charOption(String, String) - Static method in class org.refcodes.cli.CliSugar
Instantiates a new CharOption with the given arguments.
charOption(String, String, String) - Static method in class org.refcodes.cli.CliSugar
Instantiates a new CharOption with the given arguments.
charOption(String, String, String, Consumer<CharOption>) - Static method in class org.refcodes.cli.CliSugar
Instantiates a new CharOption with the given arguments.
charOption(String, String, Consumer<CharOption>) - Static method in class org.refcodes.cli.CliSugar
Instantiates a new CharOption with the given arguments.
CharOption - Class in org.refcodes.cli
The CharOption represents an Option holding String values.
CharOption(Character, String, String) - Constructor for class org.refcodes.cli.CharOption
Instantiates a new CharOption with the given arguments.
CharOption(Character, String, String, String) - Constructor for class org.refcodes.cli.CharOption
Instantiates a new CharOption with the given arguments.
CharOption(Character, String, String, String, Consumer<CharOption>) - Constructor for class org.refcodes.cli.CharOption
Instantiates a new CharOption with the given arguments.
CharOption(Character, String, String, Consumer<CharOption>) - Constructor for class org.refcodes.cli.CharOption
Instantiates a new CharOption with the given arguments.
CharOption(String, String) - Constructor for class org.refcodes.cli.CharOption
Instantiates a new CharOption with the given arguments.
CharOption(String, String, String) - Constructor for class org.refcodes.cli.CharOption
Instantiates a new CharOption with the given arguments.
CharOption(String, String, String, Consumer<CharOption>) - Constructor for class org.refcodes.cli.CharOption
Instantiates a new CharOption with the given arguments.
CharOption(String, String, Consumer<CharOption>) - Constructor for class org.refcodes.cli.CharOption
Instantiates a new CharOption with the given arguments.
CharOption(Relation<String, Character>) - Constructor for class org.refcodes.cli.CharOption
Instantiates a new CharOption with the alias being the proerty's key and the value being the property's value.
CharOption(Relation<String, Character>, Consumer<CharOption>) - Constructor for class org.refcodes.cli.CharOption
Instantiates a new CharOption with the alias being the proerty's key and the value being the property's value.
charProperty(Character, String, String) - Static method in class org.refcodes.cli.CliSugar
Instantiates a new CharProperty with the given arguments.
charProperty(Character, String, String, String) - Static method in class org.refcodes.cli.CliSugar
Instantiates a new CharProperty with the given arguments.
charProperty(Character, String, String, String, Consumer<CharProperty>) - Static method in class org.refcodes.cli.CliSugar
Instantiates a new CharProperty with the given arguments.
charProperty(Character, String, String, Consumer<CharProperty>) - Static method in class org.refcodes.cli.CliSugar
Instantiates a new CharProperty with the given arguments.
charProperty(String, String) - Static method in class org.refcodes.cli.CliSugar
Instantiates a new CharProperty with the given arguments.
charProperty(String, String, String) - Static method in class org.refcodes.cli.CliSugar
Instantiates a new CharProperty with the given arguments.
charProperty(String, String, String, Consumer<CharProperty>) - Static method in class org.refcodes.cli.CliSugar
Instantiates a new CharProperty with the given arguments.
charProperty(String, String, Consumer<CharProperty>) - Static method in class org.refcodes.cli.CliSugar
Instantiates a new CharProperty with the given arguments.
CharProperty - Class in org.refcodes.cli
The CharProperty represents an PropertyOption holding String values.
CharProperty(Character, String, String) - Constructor for class org.refcodes.cli.CharProperty
Instantiates a new CharProperty with the given arguments.
CharProperty(Character, String, String, String) - Constructor for class org.refcodes.cli.CharProperty
Instantiates a new CharProperty with the given arguments.
CharProperty(Character, String, String, String, Consumer<CharProperty>) - Constructor for class org.refcodes.cli.CharProperty
Instantiates a new CharProperty with the given arguments.
CharProperty(Character, String, String, Consumer<CharProperty>) - Constructor for class org.refcodes.cli.CharProperty
Instantiates a new CharProperty with the given arguments.
CharProperty(String, String) - Constructor for class org.refcodes.cli.CharProperty
Instantiates a new CharProperty with the given arguments.
CharProperty(String, String, String) - Constructor for class org.refcodes.cli.CharProperty
Instantiates a new CharProperty with the given arguments.
CharProperty(String, String, String, Consumer<CharProperty>) - Constructor for class org.refcodes.cli.CharProperty
Instantiates a new CharProperty with the given arguments.
CharProperty(String, String, Consumer<CharProperty>) - Constructor for class org.refcodes.cli.CharProperty
Instantiates a new CharProperty with the given arguments.
CharProperty(Relation<String, Character>) - Constructor for class org.refcodes.cli.CharProperty
Instantiates a new CharProperty with the alias being the proerty's key and the value being the property's value.
CharProperty(Relation<String, Character>, Consumer<CharProperty>) - Constructor for class org.refcodes.cli.CharProperty
Instantiates a new CharProperty with the alias being the proerty's key and the value being the property's value.
cleanFlag() - Static method in class org.refcodes.cli.CliSugar
Constructs the predefined clean Flag.
cleanFlag(boolean) - Static method in class org.refcodes.cli.CliSugar
Constructs the predefined clean Flag.
cleanFlag(String) - Static method in class org.refcodes.cli.CliSugar
Constructs the predefined clean Flag.
CleanFlag - Class in org.refcodes.cli
A predefined clean Flag: A predefined Flag gives its CleanFlag.SHORT_OPTION, its CleanFlag.LONG_OPTION as well as its CleanFlag.ALIAS an according semantics regarded by other subsystems.
CleanFlag() - Constructor for class org.refcodes.cli.CleanFlag
Constructs the predefined clean Flag.
CleanFlag(boolean) - Constructor for class org.refcodes.cli.CleanFlag
Constructs the predefined clean Flag.
CleanFlag(String) - Constructor for class org.refcodes.cli.CleanFlag
Constructs the predefined clean Flag.
CleanFlag(String, boolean) - Constructor for class org.refcodes.cli.CleanFlag
Constructs the predefined clean Flag.
CliArgsException(String[], Throwable) - Constructor for exception org.refcodes.cli.CliException.CliArgsException
CliArgsException(String[], Throwable, String) - Constructor for exception org.refcodes.cli.CliException.CliArgsException
CliArgsException(String, String[]) - Constructor for exception org.refcodes.cli.CliException.CliArgsException
CliArgsException(String, String[], String) - Constructor for exception org.refcodes.cli.CliException.CliArgsException
CliArgsException(String, String[], Throwable) - Constructor for exception org.refcodes.cli.CliException.CliArgsException
CliArgsException(String, String[], Throwable, String) - Constructor for exception org.refcodes.cli.CliException.CliArgsException
CliContext - Class in org.refcodes.cli
The CliContext describes the context in which an ParseArgs is running.
CliContext() - Constructor for class org.refcodes.cli.CliContext
Constructs an accordingly preconfigured CliContext instance.
CliContext(boolean) - Constructor for class org.refcodes.cli.CliContext
Constructs an accordingly configured CliContext instance.
CliContext(String, String, String) - Constructor for class org.refcodes.cli.CliContext
Constructs an accordingly configured CliContext instance.
CliContext(CliMetrics) - Constructor for class org.refcodes.cli.CliContext
Constructs an accordingly configured CliContext instance.
CliContext(CliMetrics, SyntaxMetrics) - Constructor for class org.refcodes.cli.CliContext
Constructs an accordingly configured CliContext instance.
CliContext(CliMetrics, SyntaxMetrics, boolean) - Constructor for class org.refcodes.cli.CliContext
Constructs an accordingly configured CliContext instance.
CliContext(SyntaxMetrics) - Constructor for class org.refcodes.cli.CliContext
Constructs an accordingly configured CliContext instance.
CliContext(SyntaxMetrics, boolean) - Constructor for class org.refcodes.cli.CliContext
Constructs an accordingly configured CliContext instance.
CliContext(SyntaxMetrics, Character, String, boolean, String, String, String) - Constructor for class org.refcodes.cli.CliContext
Constructs an accordingly configured CliContext instance.
CliContext(SyntaxMetrics, String, String, String) - Constructor for class org.refcodes.cli.CliContext
Constructs an accordingly configured CliContext instance.
CliContext.Builder - Class in org.refcodes.cli
Builder to build SyntaxMetricsAccessor.SyntaxMetricsBuilder instances.
CliContextAccessor - Interface in org.refcodes.cli
Provides an accessor for a CliContext property.
CliContextAccessor.CliContextBuilder<B extends CliContextAccessor.CliContextBuilder<B>> - Interface in org.refcodes.cli
Provides a builder method for a CliContext property returning the builder for applying multiple build operations.
CliContextAccessor.CliContextMutator - Interface in org.refcodes.cli
Provides a mutator for a CliContext property.
CliContextAccessor.CliContextProperty - Interface in org.refcodes.cli
Provides a CliContext property.
CliException - Exception in org.refcodes.cli
Base exception for the CLI artifact.
CliException(String) - Constructor for exception org.refcodes.cli.CliException
CliException(String, String) - Constructor for exception org.refcodes.cli.CliException
CliException(String, Throwable) - Constructor for exception org.refcodes.cli.CliException
CliException(String, Throwable, String) - Constructor for exception org.refcodes.cli.CliException
CliException(Throwable) - Constructor for exception org.refcodes.cli.CliException
CliException(Throwable, String) - Constructor for exception org.refcodes.cli.CliException
CliException.CliArgsException - Exception in org.refcodes.cli
This abstract exception is the base exception for all command line argument related exceptions.
CliMetrics - Interface in org.refcodes.cli
The CliMetrics define the attributes required to parse a Term tree's syntax by an ParseArgs.
CliSchema - Class in org.refcodes.cli
The purpose of a CliSchema is automatically generate documentation of Term structures.
CliSchema(Class<?>, String, Object) - Constructor for class org.refcodes.cli.CliSchema
Instantiates a new CliSchema.
CliSchema(Class<?>, String, Schema...) - Constructor for class org.refcodes.cli.CliSchema
Instantiates a new CliSchema.
CliSchema(String, Class<?>, Object, String, Schema...) - Constructor for class org.refcodes.cli.CliSchema
Instantiates a new CliSchema.
CliSchema(String, Class<?>, String, Schema...) - Constructor for class org.refcodes.cli.CliSchema
Instantiates a new CliSchema.
CliSugar - Class in org.refcodes.cli
Declarative syntactic sugar which may be statically imported in order to allow declarative definitions for the command line Flag, Condition, Option and Operand elements.
clone() - Method in class org.refcodes.cli.AbstractOperand
clone() - Method in class org.refcodes.cli.AbstractOption
clone() - Method in class org.refcodes.cli.ArrayOperand
clone() - Method in class org.refcodes.cli.Operation
CommandEscapeCodeAccessor - Interface in org.refcodes.cli
Provides an accessor for a command Escape-Code property.
CommandEscapeCodeAccessor.CommandEscapeCodeBuilder<B extends CommandEscapeCodeAccessor.CommandEscapeCodeBuilder<B>> - Interface in org.refcodes.cli
Provides a builder method for a command Escape-Code property returning the builder for applying multiple build operations.
CommandEscapeCodeAccessor.CommandEscapeCodeMutator - Interface in org.refcodes.cli
Provides a mutator for a command Escape-Code property.
CommandEscapeCodeAccessor.CommandEscapeCodeProperty - Interface in org.refcodes.cli
Provides a command Escape-Code property.
compareTo(Operand<?>) - Method in class org.refcodes.cli.AbstractOperand
compareTo(Operand<?>) - Method in class org.refcodes.cli.ArrayOperand
Condition - Interface in org.refcodes.cli
The Condition interface represents a node (and therewith the syntax for the arguments) in the command line arguments syntax tree by simply extending the Term interface and adding the functionality of providing access to the added Operands (leafs).
configOption() - Static method in class org.refcodes.cli.CliSugar
Creates a ConfigOption representing value specifying a configuration resource (file).
configOption(String) - Static method in class org.refcodes.cli.CliSugar
Instantiates a new config (file) Option.
ConfigOption - Class in org.refcodes.cli
The ConfigOption represents an Option holding a value specifying a configuration resource (file).
ConfigOption() - Constructor for class org.refcodes.cli.ConfigOption
Constructs the predefined config (file) Option.
ConfigOption(boolean) - Constructor for class org.refcodes.cli.ConfigOption
Constructs the predefined config (file) Option.
ConfigOption(String) - Constructor for class org.refcodes.cli.ConfigOption
Instantiates a new config (file) Option.
ConfigOption(String, boolean) - Constructor for class org.refcodes.cli.ConfigOption
Constructs the predefined config (file) Option.
ConfigProperty - Class in org.refcodes.cli
The ConfigProperty represents an PropertyOption holding a value specifying a configuration resource (file).
ConfigProperty() - Constructor for class org.refcodes.cli.ConfigProperty
Constructs the predefined config (file) PropertyOption.
ConfigProperty(boolean) - Constructor for class org.refcodes.cli.ConfigProperty
Constructs the predefined config (file) PropertyOption.
ConfigProperty(String) - Constructor for class org.refcodes.cli.ConfigProperty
Instantiates a new config (file) PropertyOption.
ConfigProperty(String, boolean) - Constructor for class org.refcodes.cli.ConfigProperty
Constructs the predefined config (file) PropertyOption.
contains(String[], String) - Static method in class org.refcodes.cli.AbstractOption
Determines whether a given String is contained in the given String array.
CopyrightAccessor - Interface in org.refcodes.cli
Provides an accessor for a copyright property.
CopyrightAccessor.CopyrightBuilder<B extends CopyrightAccessor.CopyrightBuilder<B>> - Interface in org.refcodes.cli
Provides a builder method for a copyright property returning the builder for applying multiple build operations.
CopyrightAccessor.CopyrightMutator - Interface in org.refcodes.cli
Provides a mutator for a copyright property.
CopyrightAccessor.CopyrightProperty - Interface in org.refcodes.cli
Provides a copyright property.

D

D - Enum constant in enum class org.refcodes.cli.ArgsFilter
Java system properties are to be filtered.
D_XX - Enum constant in enum class org.refcodes.cli.ArgsFilter
Matches ArgsFilter.D as well as ArgsFilter.XX.
daemonFlag() - Static method in class org.refcodes.cli.CliSugar
Constructs the predefined daemon Flag.
daemonFlag(boolean) - Static method in class org.refcodes.cli.CliSugar
Constructs the predefined daemon Flag.
daemonFlag(String) - Static method in class org.refcodes.cli.CliSugar
Constructs the predefined daemon Flag.
DaemonFlag - Class in org.refcodes.cli
A predefined daemon Flag: A predefined Flag gives its DaemonFlag.SHORT_OPTION, its DaemonFlag.LONG_OPTION as well as its DaemonFlag.ALIAS an according semantics regarded by other subsystems.
DaemonFlag() - Constructor for class org.refcodes.cli.DaemonFlag
Constructs the predefined daemon Flag.
DaemonFlag(boolean) - Constructor for class org.refcodes.cli.DaemonFlag
Constructs the predefined daemon Flag.
DaemonFlag(String) - Constructor for class org.refcodes.cli.DaemonFlag
Constructs the predefined daemon Flag.
DaemonFlag(String, boolean) - Constructor for class org.refcodes.cli.DaemonFlag
Constructs the predefined daemon Flag.
debugFlag() - Static method in class org.refcodes.cli.CliSugar
Constructs the predefined debug Flag.
debugFlag(boolean) - Static method in class org.refcodes.cli.CliSugar
Constructs the predefined debug Flag.
debugFlag(String) - Static method in class org.refcodes.cli.CliSugar
Constructs the predefined debug Flag.
DebugFlag - Class in org.refcodes.cli
A predefined debug Flag: A predefined Flag gives its DebugFlag.SHORT_OPTION, its DebugFlag.LONG_OPTION as well as its DebugFlag.ALIAS an according semantics regarded by other subsystems.
DebugFlag() - Constructor for class org.refcodes.cli.DebugFlag
Constructs the predefined debug Flag.
DebugFlag(boolean) - Constructor for class org.refcodes.cli.DebugFlag
Constructs the predefined debug Flag.
DebugFlag(String) - Constructor for class org.refcodes.cli.DebugFlag
Constructs the predefined debug Flag.
DebugFlag(String, boolean) - Constructor for class org.refcodes.cli.DebugFlag
Constructs the predefined debug Flag.
DEFAULT - Static variable in enum class org.refcodes.cli.SyntaxNotation
 
DescriptionEscapeCodeAccessor - Interface in org.refcodes.cli
Provides an accessor for a description Escape-Code property.
DescriptionEscapeCodeAccessor.DescriptionEscapeCodeBuilder<B extends DescriptionEscapeCodeAccessor.DescriptionEscapeCodeBuilder<B>> - Interface in org.refcodes.cli
Provides a builder method for a description Escape-Code property returning the builder for applying multiple build operations.
DescriptionEscapeCodeAccessor.DescriptionEscapeCodeMutator - Interface in org.refcodes.cli
Provides a mutator for a description Escape-Code property.
DescriptionEscapeCodeAccessor.DescriptionEscapeCodeProperty - Interface in org.refcodes.cli
Provides a description Escape-Code property.
doubleOption(Character, String, String) - Static method in class org.refcodes.cli.CliSugar
Instantiates a new DoubleOption with the given arguments.
doubleOption(Character, String, String, String) - Static method in class org.refcodes.cli.CliSugar
Instantiates a new DoubleOption with the given arguments.
doubleOption(Character, String, String, String, Consumer<DoubleOption>) - Static method in class org.refcodes.cli.CliSugar
Instantiates a new DoubleOption with the given arguments.
doubleOption(Character, String, String, Consumer<DoubleOption>) - Static method in class org.refcodes.cli.CliSugar
Instantiates a new DoubleOption with the given arguments.
doubleOption(String, String) - Static method in class org.refcodes.cli.CliSugar
Instantiates a new DoubleOption with the given arguments.
doubleOption(String, String, String) - Static method in class org.refcodes.cli.CliSugar
Instantiates a new DoubleOption with the given arguments.
doubleOption(String, String, String, Consumer<DoubleOption>) - Static method in class org.refcodes.cli.CliSugar
Instantiates a new DoubleOption with the given arguments.
doubleOption(String, String, Consumer<DoubleOption>) - Static method in class org.refcodes.cli.CliSugar
Instantiates a new DoubleOption with the given arguments.
DoubleOption - Class in org.refcodes.cli
The DoubleOption represents an Option holding double values.
DoubleOption(Character, String, String) - Constructor for class org.refcodes.cli.DoubleOption
Instantiates a new DoubleOption with the given arguments.
DoubleOption(Character, String, String, String) - Constructor for class org.refcodes.cli.DoubleOption
Instantiates a new DoubleOption with the given arguments.
DoubleOption(Character, String, String, String, Consumer<DoubleOption>) - Constructor for class org.refcodes.cli.DoubleOption
Instantiates a new DoubleOption with the given arguments.
DoubleOption(Character, String, String, Consumer<DoubleOption>) - Constructor for class org.refcodes.cli.DoubleOption
Instantiates a new DoubleOption with the given arguments.
DoubleOption(String, String) - Constructor for class org.refcodes.cli.DoubleOption
Instantiates a new DoubleOption with the given arguments.
DoubleOption(String, String, String) - Constructor for class org.refcodes.cli.DoubleOption
Instantiates a new DoubleOption with the given arguments.
DoubleOption(String, String, String, Consumer<DoubleOption>) - Constructor for class org.refcodes.cli.DoubleOption
Instantiates a new DoubleOption with the given arguments.
DoubleOption(String, String, Consumer<DoubleOption>) - Constructor for class org.refcodes.cli.DoubleOption
Instantiates a new DoubleOption with the given arguments.
DoubleOption(Relation<String, Double>) - Constructor for class org.refcodes.cli.DoubleOption
Instantiates a new DoubleOption with the alias being the proerty's key and the value being the property's value.
DoubleOption(Relation<String, Double>, Consumer<DoubleOption>) - Constructor for class org.refcodes.cli.DoubleOption
Instantiates a new DoubleOption with the alias being the proerty's key and the value being the property's value.
doubleProperty(Character, String, String) - Static method in class org.refcodes.cli.CliSugar
Instantiates a new DoubleProperty with the given arguments.
doubleProperty(Character, String, String, String) - Static method in class org.refcodes.cli.CliSugar
Instantiates a new DoubleProperty with the given arguments.
doubleProperty(Character, String, String, String, Consumer<DoubleProperty>) - Static method in class org.refcodes.cli.CliSugar
Instantiates a new DoubleProperty with the given arguments.
doubleProperty(Character, String, String, Consumer<DoubleProperty>) - Static method in class org.refcodes.cli.CliSugar
Instantiates a new DoubleProperty with the given arguments.
doubleProperty(String, String) - Static method in class org.refcodes.cli.CliSugar
Instantiates a new DoubleProperty with the given arguments.
doubleProperty(String, String, String) - Static method in class org.refcodes.cli.CliSugar
Instantiates a new DoubleProperty with the given arguments.
doubleProperty(String, String, String, Consumer<DoubleProperty>) - Static method in class org.refcodes.cli.CliSugar
Instantiates a new DoubleProperty with the given arguments.
doubleProperty(String, String, Consumer<DoubleProperty>) - Static method in class org.refcodes.cli.CliSugar
Instantiates a new DoubleProperty with the given arguments.
DoubleProperty - Class in org.refcodes.cli
The DoubleProperty represents an PropertyOption holding double values.
DoubleProperty(Character, String, String) - Constructor for class org.refcodes.cli.DoubleProperty
Instantiates a new DoubleProperty with the given arguments.
DoubleProperty(Character, String, String, String) - Constructor for class org.refcodes.cli.DoubleProperty
Instantiates a new DoubleProperty with the given arguments.
DoubleProperty(Character, String, String, String, Consumer<DoubleProperty>) - Constructor for class org.refcodes.cli.DoubleProperty
Instantiates a new DoubleProperty with the given arguments.
DoubleProperty(Character, String, String, Consumer<DoubleProperty>) - Constructor for class org.refcodes.cli.DoubleProperty
Instantiates a new DoubleProperty with the given arguments.
DoubleProperty(String, String) - Constructor for class org.refcodes.cli.DoubleProperty
Instantiates a new DoubleProperty with the given arguments.
DoubleProperty(String, String, String) - Constructor for class org.refcodes.cli.DoubleProperty
Instantiates a new DoubleProperty with the given arguments.
DoubleProperty(String, String, String, Consumer<DoubleProperty>) - Constructor for class org.refcodes.cli.DoubleProperty
Instantiates a new DoubleProperty with the given arguments.
DoubleProperty(String, String, Consumer<DoubleProperty>) - Constructor for class org.refcodes.cli.DoubleProperty
Instantiates a new DoubleProperty with the given arguments.
DoubleProperty(Relation<String, Double>) - Constructor for class org.refcodes.cli.DoubleProperty
Instantiates a new DoubleProperty with the alias being the proerty's key and the value being the property's value.
DoubleProperty(Relation<String, Double>, Consumer<DoubleProperty>) - Constructor for class org.refcodes.cli.DoubleProperty
Instantiates a new DoubleProperty with the alias being the proerty's key and the value being the property's value.

E

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

F

fileOption(Character, String, String) - Static method in class org.refcodes.cli.CliSugar
Instantiates a new FileOption with the given arguments.
fileOption(Character, String, String, String) - Static method in class org.refcodes.cli.CliSugar
Instantiates a new FileOption with the given arguments.
fileOption(Character, String, String, String, Consumer<FileOption>) - Static method in class org.refcodes.cli.CliSugar
Instantiates a new FileOption with the given arguments.
fileOption(Character, String, String, Consumer<FileOption>) - Static method in class org.refcodes.cli.CliSugar
Instantiates a new FileOption with the given arguments.
fileOption(String, String) - Static method in class org.refcodes.cli.CliSugar
Instantiates a new FileOption with the given arguments.
fileOption(String, String, String) - Static method in class org.refcodes.cli.CliSugar
Instantiates a new FileOption with the given arguments.
fileOption(String, String, String, Consumer<FileOption>) - Static method in class org.refcodes.cli.CliSugar
Instantiates a new FileOption with the given arguments.
fileOption(String, String, Consumer<FileOption>) - Static method in class org.refcodes.cli.CliSugar
Instantiates a new FileOption with the given arguments.
FileOption - Class in org.refcodes.cli
The FileOption represents an Option holding File values.
FileOption(Character, String, String) - Constructor for class org.refcodes.cli.FileOption
Instantiates a new FileOption with the given arguments.
FileOption(Character, String, String, String) - Constructor for class org.refcodes.cli.FileOption
Instantiates a new FileOption with the given arguments.
FileOption(Character, String, String, String, Consumer<FileOption>) - Constructor for class org.refcodes.cli.FileOption
Instantiates a new FileOption with the given arguments.
FileOption(Character, String, String, Consumer<FileOption>) - Constructor for class org.refcodes.cli.FileOption
Instantiates a new FileOption with the given arguments.
FileOption(String, String) - Constructor for class org.refcodes.cli.FileOption
Instantiates a new FileOption with the given arguments.
FileOption(String, String, String) - Constructor for class org.refcodes.cli.FileOption
Instantiates a new FileOption with the given arguments.
FileOption(String, String, String, Consumer<FileOption>) - Constructor for class org.refcodes.cli.FileOption
Instantiates a new FileOption with the given arguments.
FileOption(String, String, Consumer<FileOption>) - Constructor for class org.refcodes.cli.FileOption
Instantiates a new FileOption with the given arguments.
FileOption(Relation<String, File>) - Constructor for class org.refcodes.cli.FileOption
Instantiates a new FileOption with the alias being the proerty's key and the value being the property's value.
FileOption(Relation<String, File>, Consumer<FileOption>) - Constructor for class org.refcodes.cli.FileOption
Instantiates a new FileOption with the alias being the proerty's key and the value being the property's value.
fileProperty(Character, String, String) - Static method in class org.refcodes.cli.CliSugar
Instantiates a new FileProperty with the given arguments.
fileProperty(Character, String, String, String) - Static method in class org.refcodes.cli.CliSugar
Instantiates a new FileProperty with the given arguments.
fileProperty(Character, String, String, String, Consumer<FileProperty>) - Static method in class org.refcodes.cli.CliSugar
Instantiates a new FileProperty with the given arguments.
fileProperty(Character, String, String, Consumer<FileProperty>) - Static method in class org.refcodes.cli.CliSugar
Instantiates a new FileProperty with the given arguments.
fileProperty(String, String) - Static method in class org.refcodes.cli.CliSugar
Instantiates a new FileProperty with the given arguments.
fileProperty(String, String, String) - Static method in class org.refcodes.cli.CliSugar
Instantiates a new FileProperty with the given arguments.
fileProperty(String, String, String, Consumer<FileProperty>) - Static method in class org.refcodes.cli.CliSugar
Instantiates a new FileProperty with the given arguments.
fileProperty(String, String, Consumer<FileProperty>) - Static method in class org.refcodes.cli.CliSugar
Instantiates a new FileProperty with the given arguments.
FileProperty - Class in org.refcodes.cli
The FileProperty represents an PropertyOption holding File values.
FileProperty(Character, String, String) - Constructor for class org.refcodes.cli.FileProperty
Instantiates a new FileProperty with the given arguments.
FileProperty(Character, String, String, String) - Constructor for class org.refcodes.cli.FileProperty
Instantiates a new FileProperty with the given arguments.
FileProperty(Character, String, String, String, Consumer<FileProperty>) - Constructor for class org.refcodes.cli.FileProperty
Instantiates a new FileProperty with the given arguments.
FileProperty(Character, String, String, Consumer<FileProperty>) - Constructor for class org.refcodes.cli.FileProperty
Instantiates a new FileProperty with the given arguments.
FileProperty(String, String) - Constructor for class org.refcodes.cli.FileProperty
Instantiates a new FileProperty with the given arguments.
FileProperty(String, String, String) - Constructor for class org.refcodes.cli.FileProperty
Instantiates a new FileProperty with the given arguments.
FileProperty(String, String, String, Consumer<FileProperty>) - Constructor for class org.refcodes.cli.FileProperty
Instantiates a new FileProperty with the given arguments.
FileProperty(String, String, Consumer<FileProperty>) - Constructor for class org.refcodes.cli.FileProperty
Instantiates a new FileProperty with the given arguments.
FileProperty(Relation<String, File>) - Constructor for class org.refcodes.cli.FileProperty
Instantiates a new FileProperty with the alias being the proerty's key and the value being the property's value.
FileProperty(Relation<String, File>, Consumer<FileProperty>) - Constructor for class org.refcodes.cli.FileProperty
Instantiates a new FileProperty with the alias being the proerty's key and the value being the property's value.
flag(Character, String, String) - Static method in class org.refcodes.cli.CliSugar
Instantiates a new Flag with the given arguments.
flag(Character, String, String, String) - Static method in class org.refcodes.cli.CliSugar
Instantiates a new Flag with the given arguments.
flag(Character, String, String, String, Consumer<Flag>) - Static method in class org.refcodes.cli.CliSugar
Instantiates a new Flag with the given arguments.
flag(Character, String, String, Consumer<Flag>) - Static method in class org.refcodes.cli.CliSugar
Instantiates a new Flag with the given arguments.
flag(String, String) - Static method in class org.refcodes.cli.CliSugar
Instantiates a new Flag with the given arguments.
flag(String, String, String) - Static method in class org.refcodes.cli.CliSugar
Instantiates a new Flag with the given arguments.
flag(String, String, String, Consumer<Flag>) - Static method in class org.refcodes.cli.CliSugar
Instantiates a new Flag with the given arguments.
flag(String, String, Consumer<Flag>) - Static method in class org.refcodes.cli.CliSugar
Instantiates a new Flag with the given arguments.
Flag - Class in org.refcodes.cli
The Flag class implements the Option interface for representing either a true or a false state: When a flag is provided to your command line arguments, then it is considered to be true, when it is omitted, then it is considered to be false as of Flag.isEnabled().
Flag(Character, String, String) - Constructor for class org.refcodes.cli.Flag
Instantiates a new Flag with the given arguments.
Flag(Character, String, String, String) - Constructor for class org.refcodes.cli.Flag
Instantiates a new Flag with the given arguments.
Flag(Character, String, String, String, Consumer<Flag>) - Constructor for class org.refcodes.cli.Flag
Instantiates a new Flag with the given arguments.
Flag(Character, String, String, Consumer<Flag>) - Constructor for class org.refcodes.cli.Flag
Instantiates a new Flag with the given arguments.
Flag(String, String) - Constructor for class org.refcodes.cli.Flag
Instantiates a new Flag with the given arguments.
Flag(String, String, String) - Constructor for class org.refcodes.cli.Flag
Instantiates a new Flag with the given arguments.
Flag(String, String, String, Consumer<Flag>) - Constructor for class org.refcodes.cli.Flag
Instantiates a new Flag with the given arguments.
Flag(String, String, Consumer<Flag>) - Constructor for class org.refcodes.cli.Flag
Instantiates a new Flag with the given arguments.
Flag(Relation<String, Boolean>) - Constructor for class org.refcodes.cli.Flag
Instantiates a new Flag with the alias being the proerty's key and the value being the property's value.
Flag(Relation<String, Boolean>, Consumer<Flag>) - Constructor for class org.refcodes.cli.Flag
Instantiates a new Flag with the alias being the proerty's key and the value being the property's value.
floatOption(Character, String, String) - Static method in class org.refcodes.cli.CliSugar
Instantiates a new FloatOption with the given arguments.
floatOption(Character, String, String, String) - Static method in class org.refcodes.cli.CliSugar
Instantiates a new FloatOption with the given arguments.
floatOption(Character, String, String, String, Consumer<FloatOption>) - Static method in class org.refcodes.cli.CliSugar
Instantiates a new FloatOption with the given arguments.
floatOption(Character, String, String, Consumer<FloatOption>) - Static method in class org.refcodes.cli.CliSugar
Instantiates a new FloatOption with the given arguments.
floatOption(String, String) - Static method in class org.refcodes.cli.CliSugar
Instantiates a new FloatOption with the given arguments.
floatOption(String, String, String) - Static method in class org.refcodes.cli.CliSugar
Instantiates a new FloatOption with the given arguments.
floatOption(String, String, String, Consumer<FloatOption>) - Static method in class org.refcodes.cli.CliSugar
Instantiates a new FloatOption with the given arguments.
floatOption(String, String, Consumer<FloatOption>) - Static method in class org.refcodes.cli.CliSugar
Instantiates a new FloatOption with the given arguments.
FloatOption - Class in org.refcodes.cli
The FloatOption represents an Option holding float values.
FloatOption(Character, String, String) - Constructor for class org.refcodes.cli.FloatOption
Instantiates a new FloatOption with the given arguments.
FloatOption(Character, String, String, String) - Constructor for class org.refcodes.cli.FloatOption
Instantiates a new FloatOption with the given arguments.
FloatOption(Character, String, String, String, Consumer<FloatOption>) - Constructor for class org.refcodes.cli.FloatOption
Instantiates a new FloatOption with the given arguments.
FloatOption(Character, String, String, Consumer<FloatOption>) - Constructor for class org.refcodes.cli.FloatOption
Instantiates a new FloatOption with the given arguments.
FloatOption(String, String) - Constructor for class org.refcodes.cli.FloatOption
Instantiates a new FloatOption with the given arguments.
FloatOption(String, String, String) - Constructor for class org.refcodes.cli.FloatOption
Instantiates a new FloatOption with the given arguments.
FloatOption(String, String, String, Consumer<FloatOption>) - Constructor for class org.refcodes.cli.FloatOption
Instantiates a new FloatOption with the given arguments.
FloatOption(String, String, Consumer<FloatOption>) - Constructor for class org.refcodes.cli.FloatOption
Instantiates a new FloatOption with the given arguments.
FloatOption(Relation<String, Float>) - Constructor for class org.refcodes.cli.FloatOption
Instantiates a new FloatOption with the alias being the proerty's key and the value being the property's value.
FloatOption(Relation<String, Float>, Consumer<FloatOption>) - Constructor for class org.refcodes.cli.FloatOption
Instantiates a new FloatOption with the alias being the proerty's key and the value being the property's value.
floatProperty(Character, String, String) - Static method in class org.refcodes.cli.CliSugar
Instantiates a new FloatProperty with the given arguments.
floatProperty(Character, String, String, String) - Static method in class org.refcodes.cli.CliSugar
Instantiates a new FloatProperty with the given arguments.
floatProperty(Character, String, String, String, Consumer<FloatProperty>) - Static method in class org.refcodes.cli.CliSugar
Instantiates a new FloatProperty with the given arguments.
floatProperty(Character, String, String, Consumer<FloatProperty>) - Static method in class org.refcodes.cli.CliSugar
Instantiates a new FloatProperty with the given arguments.
floatProperty(String, String) - Static method in class org.refcodes.cli.CliSugar
Instantiates a new FloatProperty with the given arguments.
floatProperty(String, String, String) - Static method in class org.refcodes.cli.CliSugar
Instantiates a new FloatProperty with the given arguments.
floatProperty(String, String, String, Consumer<FloatProperty>) - Static method in class org.refcodes.cli.CliSugar
Instantiates a new FloatProperty with the given arguments.
floatProperty(String, String, Consumer<FloatProperty>) - Static method in class org.refcodes.cli.CliSugar
Instantiates a new FloatProperty with the given arguments.
FloatProperty - Class in org.refcodes.cli
The FloatProperty represents an PropertyOption holding float values.
FloatProperty(Character, String, String) - Constructor for class org.refcodes.cli.FloatProperty
Instantiates a new FloatProperty with the given arguments.
FloatProperty(Character, String, String, String) - Constructor for class org.refcodes.cli.FloatProperty
Instantiates a new FloatProperty with the given arguments.
FloatProperty(Character, String, String, String, Consumer<FloatProperty>) - Constructor for class org.refcodes.cli.FloatProperty
Instantiates a new FloatProperty with the given arguments.
FloatProperty(Character, String, String, Consumer<FloatProperty>) - Constructor for class org.refcodes.cli.FloatProperty
Instantiates a new FloatProperty with the given arguments.
FloatProperty(String, String) - Constructor for class org.refcodes.cli.FloatProperty
Instantiates a new FloatProperty with the given arguments.
FloatProperty(String, String, String) - Constructor for class org.refcodes.cli.FloatProperty
Instantiates a new FloatProperty with the given arguments.
FloatProperty(String, String, String, Consumer<FloatProperty>) - Constructor for class org.refcodes.cli.FloatProperty
Instantiates a new FloatProperty with the given arguments.
FloatProperty(String, String, Consumer<FloatProperty>) - Constructor for class org.refcodes.cli.FloatProperty
Instantiates a new FloatProperty with the given arguments.
FloatProperty(Relation<String, Float>) - Constructor for class org.refcodes.cli.FloatProperty
Instantiates a new FloatProperty with the alias being the proerty's key and the value being the property's value.
FloatProperty(Relation<String, Float>, Consumer<FloatProperty>) - Constructor for class org.refcodes.cli.FloatProperty
Instantiates a new FloatProperty with the alias being the proerty's key and the value being the property's value.
forceFlag() - Static method in class org.refcodes.cli.CliSugar
Constructs the predefined force Flag.
forceFlag(boolean) - Static method in class org.refcodes.cli.CliSugar
Constructs the predefined force Flag.
forceFlag(String) - Static method in class org.refcodes.cli.CliSugar
Constructs the predefined force Flag.
ForceFlag - Class in org.refcodes.cli
A predefined force Flag: A predefined Flag gives its ForceFlag.SHORT_OPTION, its ForceFlag.LONG_OPTION as well as its ForceFlag.ALIAS an according semantics regarded by other subsystems.
ForceFlag() - Constructor for class org.refcodes.cli.ForceFlag
Constructs the predefined force Flag.
ForceFlag(boolean) - Constructor for class org.refcodes.cli.ForceFlag
Constructs the predefined force Flag.
ForceFlag(String) - Constructor for class org.refcodes.cli.ForceFlag
Constructs the predefined force Flag.
fromFilter(String[]) - Method in enum class org.refcodes.cli.ArgsFilter
Filters the provided args by including the args matching this enumerations criteria.
fromFilter(String[], Pattern) - Static method in enum class org.refcodes.cli.ArgsFilter
Filters the provided args by including the args matching the provided Pattern (opposite of ArgsFilter.toFiltered(String[], Pattern).
fromFilter(List<String>) - Method in enum class org.refcodes.cli.ArgsFilter
Filters the provided args by including the args matching this enumerations criteria.
fromFilter(List<String>, Pattern) - Static method in enum class org.refcodes.cli.ArgsFilter
Filters the provided args by including the args matching the provided Pattern (opposite of ArgsFilter.toFiltered(List, Pattern).

G

getAlias() - Method in class org.refcodes.cli.AbstractOperand
Retrieves the name (alias) of the parameter value which can be the name of the operand (Operand) or the option argument (Option), depending on the sub-type inheriting from this interface.
getAlias() - Method in class org.refcodes.cli.ArrayOperand
Retrieves the name (alias) of the parameter value which can be the name of the operand (Operand) or the option argument (Option), depending on the sub-type inheriting from this interface.
getAlias() - Method in interface org.refcodes.cli.Operand
Retrieves the name (alias) of the parameter value which can be the name of the operand (Operand) or the option argument (Option), depending on the sub-type inheriting from this interface.
getAllSymbol() - Method in interface org.refcodes.cli.SyntaxMetrics
Retrieves the symbol for representing an ALL condition.
getAllSymbol() - Method in class org.refcodes.cli.SyntaxMetricsImpl
Retrieves the symbol for representing an ALL condition.
getAllSymbol() - Method in enum class org.refcodes.cli.SyntaxNotation
Retrieves the symbol for representing an ALL condition.
getAndSymbol() - Method in interface org.refcodes.cli.SyntaxMetrics
Retrieves the symbol for representing an AND condition.
getAndSymbol() - Method in class org.refcodes.cli.SyntaxMetricsImpl
Retrieves the symbol for representing an AND condition.
getAndSymbol() - Method in enum class org.refcodes.cli.SyntaxNotation
Retrieves the symbol for representing an AND condition.
getAnySymbol() - Method in interface org.refcodes.cli.SyntaxMetrics
Retrieves the symbol for representing an OPTIONAL condition.
getAnySymbol() - Method in class org.refcodes.cli.SyntaxMetricsImpl
Retrieves the symbol for representing an OPTIONAL condition.
getAnySymbol() - Method in enum class org.refcodes.cli.SyntaxNotation
Retrieves the symbol for representing an OPTIONAL condition.
getArgs() - Method in interface org.refcodes.cli.ArgsAccessor
Retrieves the command line arguments from the args property.
getArgs() - Method in exception org.refcodes.cli.CliException.CliArgsException
Retrieves the command line arguments from the args property.
getArgsParser() - Method in interface org.refcodes.cli.ArgsParserAccessor
Retrieves the args-parser from the ParseArgs property.
getArgsSyntax() - Method in class org.refcodes.cli.ArgsParser
Retrieves the (root) Term from the (root) Term property.
getArgsSyntax() - Method in interface org.refcodes.cli.ArgsSyntaxAccessor
Retrieves the (root) Term from the (root) Term property.
getArgsSyntax() - Method in interface org.refcodes.cli.ParseArgs
Retrieves the (root) Term from the (root) Term property.
getArgumentEscapeCode() - Method in class org.refcodes.cli.ArgsParser
Retrieves the argument Escape-Code from the argument Escape-Code property.
getArgumentEscapeCode() - Method in interface org.refcodes.cli.ArgumentEscapeCodeAccessor
Retrieves the argument Escape-Code from the argument Escape-Code property.
getArgumentEscapeCode() - Method in class org.refcodes.cli.CliContext
Retrieves the argument Escape-Code from the argument Escape-Code property.
getArgumentEscapeCode() - Method in interface org.refcodes.cli.ParseArgs
Retrieves the argument Escape-Code from the argument Escape-Code property.
getArgumentPrefix() - Method in interface org.refcodes.cli.ArgumentPrefixAccessor
Retrieves the argument prefix from the argument prefix property.
getArgumentPrefix() - Method in class org.refcodes.cli.SyntaxMetricsImpl
Retrieves the argument prefix from the argument prefix property.
getArgumentPrefix() - Method in enum class org.refcodes.cli.SyntaxNotation
Retrieves the argument prefix from the argument prefix property.
getArgumentSuffix() - Method in interface org.refcodes.cli.ArgumentSuffixAccessor
Retrieves the argument suffix from the argument suffix property.
getArgumentSuffix() - Method in class org.refcodes.cli.SyntaxMetricsImpl
Retrieves the argument suffix from the argument suffix property.
getArgumentSuffix() - Method in enum class org.refcodes.cli.SyntaxNotation
Retrieves the argument suffix from the argument suffix property.
getBannerBorderEscapeCode() - Method in class org.refcodes.cli.ArgsParser
Retrieves the banner border Escape-Code from the banner border Escape-Code property.
getBannerBorderEscapeCode() - Method in interface org.refcodes.cli.BannerBorderEscapeCodeAccessor
Retrieves the banner border Escape-Code from the banner border Escape-Code property.
getBannerBorderEscapeCode() - Method in interface org.refcodes.cli.ParseArgs
Retrieves the banner border Escape-Code from the banner border Escape-Code property.
getBannerEscapeCode() - Method in class org.refcodes.cli.ArgsParser
Retrieves the banner Escape-Code from the banner Escape-Code property.
getBannerEscapeCode() - Method in interface org.refcodes.cli.BannerEscapeCodeAccessor
Retrieves the banner Escape-Code from the banner Escape-Code property.
getBannerEscapeCode() - Method in interface org.refcodes.cli.ParseArgs
Retrieves the banner Escape-Code from the banner Escape-Code property.
getBannerFont() - Method in class org.refcodes.cli.ArgsParser
Retrieves the banner Font from the banner Font property.
getBannerFont() - Method in interface org.refcodes.cli.BannerFontAccessor
Retrieves the banner Font from the banner Font property.
getBannerFontPalette() - Method in class org.refcodes.cli.ArgsParser
Retrieves the banner font palette from the banner font palette property.
getBannerFontPalette() - Method in interface org.refcodes.cli.BannerFontPaletteAccessor
Retrieves the banner font palette from the banner font palette property.
getBeginArraySymbol() - Method in interface org.refcodes.cli.SyntaxMetrics
Retrieves the symbol representing the beginning of an array, e.g. an opening square brace.
getBeginArraySymbol() - Method in class org.refcodes.cli.SyntaxMetricsImpl
Retrieves the symbol representing the beginning of an array, e.g. an opening square brace.
getBeginArraySymbol() - Method in enum class org.refcodes.cli.SyntaxNotation
Retrieves the symbol representing the beginning of an array, e.g. an opening square brace.
getBeginListSymbol() - Method in interface org.refcodes.cli.SyntaxMetrics
Retrieves the symbol representing the beginning of a list, e.g. an opening brace.
getBeginListSymbol() - Method in class org.refcodes.cli.SyntaxMetricsImpl
Retrieves the symbol representing the beginning of a list, e.g. an opening brace.
getBeginListSymbol() - Method in enum class org.refcodes.cli.SyntaxNotation
Retrieves the symbol representing the beginning of a list, e.g. an opening brace.
getBeginOptionalSymbol() - Method in interface org.refcodes.cli.SyntaxMetrics
Retrieves the symbol representing the beginning of optional elements, e.g. an opening square brace.
getBeginOptionalSymbol() - Method in class org.refcodes.cli.SyntaxMetricsImpl
Retrieves the symbol representing the beginning of optional elements, e.g. an opening square brace.
getBeginOptionalSymbol() - Method in enum class org.refcodes.cli.SyntaxNotation
Retrieves the symbol representing the beginning of optional elements, e.g. an opening square brace.
getBeginRangeSymbol() - Method in interface org.refcodes.cli.SyntaxMetrics
Retrieves the symbol representing the beginning of a range, e.g. an opening curly brace.
getBeginRangeSymbol() - Method in class org.refcodes.cli.SyntaxMetricsImpl
Retrieves the symbol representing the beginning of a range, e.g. an opening curly brace.
getBeginRangeSymbol() - Method in enum class org.refcodes.cli.SyntaxNotation
Retrieves the symbol representing the beginning of a range, e.g. an opening curly brace.
getChild() - Method in class org.refcodes.cli.AllCondition
Returns the one and only child of this Term.
getChildren() - Method in class org.refcodes.cli.AbstractCondition
getCliContext() - Method in interface org.refcodes.cli.CliContextAccessor
Retrieves the CliContext from the CliContext property.
getCommandEscapeCode() - Method in class org.refcodes.cli.ArgsParser
Retrieves the command Escape-Code from the command Escape-Code property.
getCommandEscapeCode() - Method in interface org.refcodes.cli.CommandEscapeCodeAccessor
Retrieves the command Escape-Code from the command Escape-Code property.
getCommandEscapeCode() - Method in interface org.refcodes.cli.ParseArgs
Retrieves the command Escape-Code from the command Escape-Code property.
getConsoleWidth() - Method in class org.refcodes.cli.ArgsParser
getCopyright() - Method in class org.refcodes.cli.ArgsParser
Retrieves the copyright from the copyright property.
getCopyright() - Method in interface org.refcodes.cli.CopyrightAccessor
Retrieves the copyright from the copyright property.
getCopyright() - Method in interface org.refcodes.cli.ParseArgs
Retrieves the copyright from the copyright property.
getDelimiter() - Method in class org.refcodes.cli.ArgsParser
The delimiter to be used for colliding command line args when creating non colliding arg's aliases (keys for key/value-pairs).
getDescription() - Method in class org.refcodes.cli.AbstractCondition
getDescription() - Method in class org.refcodes.cli.ArgsParser
getDescription() - Method in class org.refcodes.cli.ArrayOperand
getDescription() - Method in class org.refcodes.cli.Example
getDescription() - Method in interface org.refcodes.cli.ParseArgs
getDescriptionEscapeCode() - Method in class org.refcodes.cli.ArgsParser
Retrieves the description Escape-Code from the description Escape-Code property.
getDescriptionEscapeCode() - Method in interface org.refcodes.cli.DescriptionEscapeCodeAccessor
Retrieves the description Escape-Code from the description Escape-Code property.
getDescriptionEscapeCode() - Method in interface org.refcodes.cli.ParseArgs
Retrieves the description Escape-Code from the description Escape-Code property.
getEmptySymbol() - Method in interface org.refcodes.cli.SyntaxMetrics
Retrieves the symbol for representing an EMPTY condition (no args).
getEmptySymbol() - Method in class org.refcodes.cli.SyntaxMetricsImpl
Retrieves the symbol for representing an EMPTY condition (no args).
getEmptySymbol() - Method in enum class org.refcodes.cli.SyntaxNotation
Retrieves the symbol for representing an EMPTY condition (no args).
getEndArraySymbol() - Method in interface org.refcodes.cli.SyntaxMetrics
Retrieves the symbol representing the end of an array, e.g. a closing square brace.
getEndArraySymbol() - Method in class org.refcodes.cli.SyntaxMetricsImpl
Retrieves the symbol representing the end of an array, e.g. a closing square brace.
getEndArraySymbol() - Method in enum class org.refcodes.cli.SyntaxNotation
Retrieves the symbol representing the end of an array, e.g. a closing square brace.
getEndListSymbol() - Method in interface org.refcodes.cli.SyntaxMetrics
Retrieves the symbol representing the end of a list, e.g. a closing brace.
getEndListSymbol() - Method in class org.refcodes.cli.SyntaxMetricsImpl
Retrieves the symbol representing the end of a list, e.g. a closing brace.
getEndListSymbol() - Method in enum class org.refcodes.cli.SyntaxNotation
Retrieves the symbol representing the end of a list, e.g. a closing brace.
getEndOptionalSymbol() - Method in interface org.refcodes.cli.SyntaxMetrics
Retrieves the symbol representing the end of optional elements, e.g. a closing square brace.
getEndOptionalSymbol() - Method in class org.refcodes.cli.SyntaxMetricsImpl
Retrieves the symbol representing the end of optional elements, e.g. a closing square brace.
getEndOptionalSymbol() - Method in enum class org.refcodes.cli.SyntaxNotation
Retrieves the symbol representing the end of optional elements, e.g. a closing square brace.
getEndRangeSymbol() - Method in interface org.refcodes.cli.SyntaxMetrics
Retrieves the symbol representing the end of a range, e.g. a closing curly brace.
getEndRangeSymbol() - Method in class org.refcodes.cli.SyntaxMetricsImpl
Retrieves the symbol representing the end of a range, e.g. a closing curly brace.
getEndRangeSymbol() - Method in enum class org.refcodes.cli.SyntaxNotation
Retrieves the symbol representing the end of a range, e.g. a closing curly brace.
getExamples() - Method in class org.refcodes.cli.ArgsParser
Retrieves the Example instances from the Example instances property.
getExamples() - Method in interface org.refcodes.cli.ExamplesAccessor
Retrieves the Example instances from the Example instances property.
getExamples() - Method in interface org.refcodes.cli.ParseArgs
Retrieves the Example instances from the Example instances property.
getException() - Method in class org.refcodes.cli.AbstractCondition
Retrieves the ArgsSyntaxException exception in case invoking Term.parseArgs(String[], CliContext) failed.
getException() - Method in class org.refcodes.cli.AnyCondition
Retrieves the ArgsSyntaxException exception caught while invoking the Term.parseArgs(String[], CliContext) method.
getException() - Method in interface org.refcodes.cli.Term
Retrieves the ArgsSyntaxException exception in case invoking Term.parseArgs(String[], CliContext) failed.
getFilter() - Method in enum class org.refcodes.cli.ArgsFilter
Returns the args Pattern used to filter (exclude) the according args.
getIntervalSymbol() - Method in interface org.refcodes.cli.SyntaxMetrics
Retrieves the symbol representing an interval, e.g. "..." or "-".
getIntervalSymbol() - Method in class org.refcodes.cli.SyntaxMetricsImpl
Retrieves the symbol representing an interval, e.g. "..." or "-".
getIntervalSymbol() - Method in enum class org.refcodes.cli.SyntaxNotation
Retrieves the symbol representing an interval, e.g. "..." or "-".
getLicense() - Method in class org.refcodes.cli.ArgsParser
Retrieves the license from the license property.
getLicense() - Method in interface org.refcodes.cli.LicenseAccessor
Retrieves the license from the license property.
getLicense() - Method in interface org.refcodes.cli.ParseArgs
Retrieves the license from the license property.
getLineBreak() - Method in class org.refcodes.cli.ArgsParser
getLineSeparatorEscapeCode() - Method in class org.refcodes.cli.ArgsParser
Retrieves the line separator Escape-Code from the line separator Escape-Code property.
getLineSeparatorEscapeCode() - Method in interface org.refcodes.cli.LineSeparatorEscapeCodeAccessor
Retrieves the line separator Escape-Code from the line separator Escape-Code property.
getLineSeparatorEscapeCode() - Method in interface org.refcodes.cli.ParseArgs
Retrieves the line separator Escape-Code from the line separator Escape-Code property.
getLongOption() - Method in class org.refcodes.cli.AbstractOption
Returns the long-option representing an Option instance.
getLongOption() - Method in class org.refcodes.cli.ArrayOption
Returns the long-option representing an Option instance.
getLongOption() - Method in interface org.refcodes.cli.LongOptionAccessor
Retrieves the long option from the long option property.
getLongOption() - Method in interface org.refcodes.cli.Option
Returns the long-option representing an Option instance.
getLongOption() - Method in exception org.refcodes.cli.ParseOptionArgsException
Retrieves the long option from the long option property.
getLongOption() - Method in exception org.refcodes.cli.UnknownOptionArgsException
Retrieves the long option from the long option property.
getLongOptionPrefix() - Method in class org.refcodes.cli.ArgsParser
Retrieves the long option prefix from the long option prefix property.
getLongOptionPrefix() - Method in interface org.refcodes.cli.LongOptionPrefixAccessor
Retrieves the long option prefix from the long option prefix property.
getLongOptionPrefix() - Method in class org.refcodes.cli.SyntaxMetricsImpl
Retrieves the long option prefix from the long option prefix property.
getLongOptionPrefix() - Method in enum class org.refcodes.cli.SyntaxNotation
Retrieves the long option prefix from the long option prefix property.
getLongPropertyPrefix() - Method in interface org.refcodes.cli.LongPropertyPrefixAccessor
Retrieves the long option prefix from the long option prefix property.
getMatchCount() - Method in class org.refcodes.cli.AbstractCondition
Determines the number of args being matched by the Term.parseArgs(String[], CliContext) (and similar) method(s) of the according syntax.
getMatchCount() - Method in class org.refcodes.cli.AbstractOperand
Determines the number of args being matched by the Term.parseArgs(String[], CliContext) (and similar) method(s) of the according syntax.
getMatchCount() - Method in exception org.refcodes.cli.ArgsSyntaxException
Determines the number of args being matched upon encountering this exception.
getMatchCount() - Method in class org.refcodes.cli.ArrayOperand
Determines the number of args being matched by the Term.parseArgs(String[], CliContext) (and similar) method(s) of the according syntax.
getMatchCount() - Method in interface org.refcodes.cli.MatchCountAccessor
Retrieves the match-count from the match-count property.
getMatchCount() - Method in interface org.refcodes.cli.Term
Determines the number of args being matched by the Term.parseArgs(String[], CliContext) (and similar) method(s) of the according syntax.
getMaxConsoleWidth() - Method in class org.refcodes.cli.ArgsParser
getMaxLength() - Method in class org.refcodes.cli.ArrayOperand
Retrieves the maximum number of array elements to be present, e.g.
getMinLength() - Method in class org.refcodes.cli.ArrayOperand
Retrieves the minimum number of array elements to be present, e.g.
getName() - Method in class org.refcodes.cli.ArgsParser
getOperand() - Method in class org.refcodes.cli.ArrayOperand
Hook for accessing the encapsulated Operand.
getOperands() - Method in class org.refcodes.cli.Example
Retrieves the command line arguments required by the example.
getOperation() - Method in class org.refcodes.cli.Operation
Returns the operation's name.
getOptionEscapeCode() - Method in class org.refcodes.cli.ArgsParser
Retrieves the option Escape-Code from the option Escape-Code property.
getOptionEscapeCode() - Method in class org.refcodes.cli.CliContext
Retrieves the option Escape-Code from the option Escape-Code property.
getOptionEscapeCode() - Method in interface org.refcodes.cli.OptionEscapeCodeAccessor
Retrieves the option Escape-Code from the option Escape-Code property.
getOptionEscapeCode() - Method in interface org.refcodes.cli.ParseArgs
Retrieves the option Escape-Code from the option Escape-Code property.
getOrSymbol() - Method in interface org.refcodes.cli.SyntaxMetrics
Retrieves the symbol for representing an OR condition.
getOrSymbol() - Method in class org.refcodes.cli.SyntaxMetricsImpl
Retrieves the symbol for representing an OR condition.
getOrSymbol() - Method in enum class org.refcodes.cli.SyntaxNotation
Retrieves the symbol for representing an OR condition.
getParsedArgs() - Method in class org.refcodes.cli.AbstractOperand
Retrieves the (command line) args which represent this Operand after being "parsed" (provided with command line args).
getParsedArgs() - Method in class org.refcodes.cli.ArrayOperand
Retrieves the (command line) args which represent this Operand after being "parsed" (provided with command line args).
getParsedArgs() - Method in interface org.refcodes.cli.Operand
Retrieves the (command line) args which represent this Operand after being "parsed" (provided with command line args).
getParsedArgs() - Method in interface org.refcodes.cli.ParsedArgsAccessor
Retrieves the command line arguments from the parsed args property.
getPatternArguments() - Method in exception org.refcodes.cli.ArgsSyntaxException
getPatternArguments() - Method in exception org.refcodes.cli.CliException.CliArgsException
getPatternArguments() - Method in exception org.refcodes.cli.ParseOptionArgsException
getPatternArguments() - Method in exception org.refcodes.cli.UnknownOptionArgsException
getPropertyEscapeCode() - Method in interface org.refcodes.cli.PropertyEscapeCodeAccessor
Retrieves the option Escape-Code from the option Escape-Code property.
getResetEscapeCode() - Method in class org.refcodes.cli.ArgsParser
getResetEscapeCode() - Method in class org.refcodes.cli.CliContext
getSeparatorLnChar() - Method in class org.refcodes.cli.ArgsParser
Gets the character to be used when printing a separator line with the ParseArgs.printSeparatorLn() method.
getSeparatorLnChar() - Method in interface org.refcodes.cli.ParseArgs
Gets the character to be used when printing a separator line with the ParseArgs.printSeparatorLn() method.
getShortOption() - Method in class org.refcodes.cli.AbstractOption
Returns the short-option representing an Option instance.
getShortOption() - Method in class org.refcodes.cli.ArrayOption
Returns the short-option representing an Option instance.
getShortOption() - Method in interface org.refcodes.cli.Option
Returns the short-option representing an Option instance.
getShortOption() - Method in exception org.refcodes.cli.ParseOptionArgsException
Retrieves the short option from the short option property.
getShortOption() - Method in interface org.refcodes.cli.ShortOptionAccessor
Retrieves the short option from the short option property.
getShortOption() - Method in exception org.refcodes.cli.UnknownOptionArgsException
Retrieves the short option from the short option property.
getShortOptionPrefix() - Method in class org.refcodes.cli.ArgsParser
Retrieves the short option prefix from the short option prefix property.
getShortOptionPrefix() - Method in interface org.refcodes.cli.ShortOptionPrefixAccessor
Retrieves the short option prefix from the short option prefix property.
getShortOptionPrefix() - Method in class org.refcodes.cli.SyntaxMetricsImpl
Retrieves the short option prefix from the short option prefix property.
getShortOptionPrefix() - Method in enum class org.refcodes.cli.SyntaxNotation
Retrieves the short option prefix from the short option prefix property.
getShortPropertyPrefix() - Method in interface org.refcodes.cli.ShortPropertyPrefixAccessor
Retrieves the short option prefix from the short option prefix property.
getSource() - Method in exception org.refcodes.cli.ArgsSyntaxException
Returns the Term responsible for this exception.
getSyntaxMetrics() - Method in class org.refcodes.cli.ArgsParser
Retrieves the SyntaxMetrics from the SyntaxMetrics property.
getSyntaxMetrics() - Method in class org.refcodes.cli.CliContext
Retrieves the SyntaxMetrics from the SyntaxMetrics property.
getSyntaxMetrics() - Method in interface org.refcodes.cli.SyntaxMetricsAccessor
Retrieves the SyntaxMetrics from the SyntaxMetrics property.
getTextBoxGrid() - Method in class org.refcodes.cli.ArgsParser
getTitle() - Method in class org.refcodes.cli.ArgsParser
getType() - Method in class org.refcodes.cli.AbstractOperand
getType() - Method in class org.refcodes.cli.ArrayOperand
getValue() - Method in class org.refcodes.cli.AbstractOperand
getValue() - Method in class org.refcodes.cli.ArrayOperand
getValue() - Method in class org.refcodes.cli.BooleanOption
getValue() - Method in class org.refcodes.cli.BooleanProperty
getValue() - Method in class org.refcodes.cli.CliSchema
getValue() - Method in interface org.refcodes.cli.Operand
getXorSymbol() - Method in interface org.refcodes.cli.SyntaxMetrics
Retrieves the symbol for representing an XOR condition.
getXorSymbol() - Method in class org.refcodes.cli.SyntaxMetricsImpl
Retrieves the symbol for representing an XOR condition.
getXorSymbol() - Method in enum class org.refcodes.cli.SyntaxNotation
Retrieves the symbol for representing an XOR condition.
GNU_POSIX - Enum constant in enum class org.refcodes.cli.SyntaxNotation
A syntax notation derived from GNU and POSIX utility conventions and utility argument syntax.

H

HAS_VALUE_KEY - Static variable in class org.refcodes.cli.CliSchema
 
hasChild(Term) - Method in interface org.refcodes.cli.Condition
Determines whether the provided Term is a child (or a child's child) of this Condition.
hasValue() - Method in interface org.refcodes.cli.Operand
When being parsed via the Term.parseArgs(String[], String[], CliContext) method, use this method to determine whether the Operand.getValue() method contains parsed value.
helpFlag() - Static method in class org.refcodes.cli.CliSugar
Constructs the predefined help Flag.
helpFlag(boolean) - Static method in class org.refcodes.cli.CliSugar
Constructs the predefined help Flag.
helpFlag(String) - Static method in class org.refcodes.cli.CliSugar
Constructs the predefined help Flag.
HelpFlag - Class in org.refcodes.cli
A predefined help Flag: A predefined Flag gives its HelpFlag.SHORT_OPTION, its HelpFlag.LONG_OPTION as well as its HelpFlag.ALIAS an according semantics regarded by other subsystems.
HelpFlag() - Constructor for class org.refcodes.cli.HelpFlag
Constructs the predefined help Flag.
HelpFlag(boolean) - Constructor for class org.refcodes.cli.HelpFlag
Constructs the predefined help Flag.
HelpFlag(String) - Constructor for class org.refcodes.cli.HelpFlag
Constructs the predefined help Flag.
HelpFlag(String, boolean) - Constructor for class org.refcodes.cli.HelpFlag
Constructs the predefined help Flag.

I

initFlag() - Static method in class org.refcodes.cli.CliSugar
Constructs the predefined init Flag.
initFlag(boolean) - Static method in class org.refcodes.cli.CliSugar
Constructs the predefined init Flag.
initFlag(String) - Static method in class org.refcodes.cli.CliSugar
Constructs the predefined init Flag.
InitFlag - Class in org.refcodes.cli
A predefined init Flag: A predefined Flag gives its InitFlag.SHORT_OPTION, its InitFlag.LONG_OPTION as well as its InitFlag.ALIAS an according semantics regarded by other subsystems.
InitFlag() - Constructor for class org.refcodes.cli.InitFlag
Constructs the predefined init Flag.
InitFlag(boolean) - Constructor for class org.refcodes.cli.InitFlag
Constructs the predefined init Flag.
InitFlag(String) - Constructor for class org.refcodes.cli.InitFlag
Constructs the predefined init Flag.
InitFlag(String, boolean) - Constructor for class org.refcodes.cli.InitFlag
Constructs the predefined init Flag.
intOption(Character, String, String) - Static method in class org.refcodes.cli.CliSugar
Instantiates a new IntOption with the given arguments.
intOption(Character, String, String, String) - Static method in class org.refcodes.cli.CliSugar
Instantiates a new IntOption with the given arguments.
intOption(Character, String, String, String, Consumer<IntOption>) - Static method in class org.refcodes.cli.CliSugar
Instantiates a new IntOption with the given arguments.
intOption(Character, String, String, Consumer<IntOption>) - Static method in class org.refcodes.cli.CliSugar
Instantiates a new IntOption with the given arguments.
intOption(String, String) - Static method in class org.refcodes.cli.CliSugar
Instantiates a new IntOption with the given arguments.
intOption(String, String, String) - Static method in class org.refcodes.cli.CliSugar
Instantiates a new IntOption with the given arguments.
intOption(String, String, String, Consumer<IntOption>) - Static method in class org.refcodes.cli.CliSugar
Instantiates a new IntOption with the given arguments.
intOption(String, String, Consumer<IntOption>) - Static method in class org.refcodes.cli.CliSugar
Instantiates a new IntOption with the given arguments.
IntOption - Class in org.refcodes.cli
The IntOption represents an Option holding int values.
IntOption(Character, String, String) - Constructor for class org.refcodes.cli.IntOption
Instantiates a new IntOption with the given arguments.
IntOption(Character, String, String, String) - Constructor for class org.refcodes.cli.IntOption
Instantiates a new IntOption with the given arguments.
IntOption(Character, String, String, String, Consumer<IntOption>) - Constructor for class org.refcodes.cli.IntOption
Instantiates a new IntOption with the given arguments.
IntOption(Character, String, String, Consumer<IntOption>) - Constructor for class org.refcodes.cli.IntOption
Instantiates a new IntOption with the given arguments.
IntOption(String, String) - Constructor for class org.refcodes.cli.IntOption
Instantiates a new IntOption with the given arguments.
IntOption(String, String, String) - Constructor for class org.refcodes.cli.IntOption
Instantiates a new IntOption with the given arguments.
IntOption(String, String, String, Consumer<IntOption>) - Constructor for class org.refcodes.cli.IntOption
Instantiates a new IntOption with the given arguments.
IntOption(String, String, Consumer<IntOption>) - Constructor for class org.refcodes.cli.IntOption
Instantiates a new IntOption with the given arguments.
IntOption(Relation<String, Integer>) - Constructor for class org.refcodes.cli.IntOption
Instantiates a new IntOption with the alias being the proerty's key and the value being the property's value.
IntOption(Relation<String, Integer>, Consumer<IntOption>) - Constructor for class org.refcodes.cli.IntOption
Instantiates a new IntOption with the alias being the proerty's key and the value being the property's value.
intProperty(Character, String, String) - Static method in class org.refcodes.cli.CliSugar
Instantiates a new IntProperty with the given arguments.
intProperty(Character, String, String, String) - Static method in class org.refcodes.cli.CliSugar
Instantiates a new IntProperty with the given arguments.
intProperty(Character, String, String, String, Consumer<IntProperty>) - Static method in class org.refcodes.cli.CliSugar
Instantiates a new IntProperty with the given arguments.
intProperty(Character, String, String, Consumer<IntProperty>) - Static method in class org.refcodes.cli.CliSugar
Instantiates a new IntProperty with the given arguments.
intProperty(String, String) - Static method in class org.refcodes.cli.CliSugar
Instantiates a new IntProperty with the given arguments.
intProperty(String, String, String) - Static method in class org.refcodes.cli.CliSugar
Instantiates a new IntProperty with the given arguments.
intProperty(String, String, String, Consumer<IntProperty>) - Static method in class org.refcodes.cli.CliSugar
Instantiates a new IntProperty with the given arguments.
intProperty(String, String, Consumer<IntProperty>) - Static method in class org.refcodes.cli.CliSugar
Instantiates a new IntProperty with the given arguments.
IntProperty - Class in org.refcodes.cli
The IntProperty represents an PropertyOption holding int values.
IntProperty(Character, String, String) - Constructor for class org.refcodes.cli.IntProperty
Instantiates a new IntProperty with the given arguments.
IntProperty(Character, String, String, String) - Constructor for class org.refcodes.cli.IntProperty
Instantiates a new IntProperty with the given arguments.
IntProperty(Character, String, String, String, Consumer<IntProperty>) - Constructor for class org.refcodes.cli.IntProperty
Instantiates a new IntProperty with the given arguments.
IntProperty(Character, String, String, Consumer<IntProperty>) - Constructor for class org.refcodes.cli.IntProperty
Instantiates a new IntProperty with the given arguments.
IntProperty(String, String) - Constructor for class org.refcodes.cli.IntProperty
Instantiates a new IntProperty with the given arguments.
IntProperty(String, String, String) - Constructor for class org.refcodes.cli.IntProperty
Instantiates a new IntProperty with the given arguments.
IntProperty(String, String, String, Consumer<IntProperty>) - Constructor for class org.refcodes.cli.IntProperty
Instantiates a new IntProperty with the given arguments.
IntProperty(String, String, Consumer<IntProperty>) - Constructor for class org.refcodes.cli.IntProperty
Instantiates a new IntProperty with the given arguments.
IntProperty(Relation<String, Integer>) - Constructor for class org.refcodes.cli.IntProperty
Instantiates a new IntProperty with the alias being the proerty's key and the value being the property's value.
IntProperty(Relation<String, Integer>, Consumer<IntProperty>) - Constructor for class org.refcodes.cli.IntProperty
Instantiates a new IntProperty with the alias being the proerty's key and the value being the property's value.
isChild(Term) - Method in interface org.refcodes.cli.Condition
Determines whether the provided Term is a direct child of this Condition.
isEnabled() - Method in class org.refcodes.cli.Flag
Returns true if the switch has been set (enabled).
isEnabled() - Method in class org.refcodes.cli.NoneOperand
Determines whether none arguments have been passed.
isEnabled() - Method in class org.refcodes.cli.Operation
Returns true if the switch has been set (enabled).
isEscapeCodesEnabled() - Method in class org.refcodes.cli.ArgsParser
isEscapeCodesEnabled() - Method in class org.refcodes.cli.CliContext
isOption(String) - Method in class org.refcodes.cli.CliContext
Determines whether the given argument is an option in terms of this context, e.g. whether it starts either with a short option prefix (as of ShortOptionPrefixAccessor.getShortOptionPrefix() or a long option prefix (as of LongOptionPrefixAccessor.getLongOptionPrefix()).

L

letArgs(String[]) - Method in interface org.refcodes.cli.ArgsAccessor.ArgsProperty
This method stores and passes through the given arguments, which is very useful for builder APIs: Sets the given String array (setter) as of ArgsAccessor.ArgsMutator.setArgs(String[]) and returns the very same value (getter).
letArgsParser(ParseArgs) - Method in interface org.refcodes.cli.ArgsParserAccessor.ArgsParserProperty
This method stores and passes through the given argument, which is very useful for builder APIs: Sets the given ParseArgs (setter) as of ArgsParserAccessor.ArgsParserMutator.setArgsParser(ParseArgs) and returns the very same value (getter).
letArgsSyntax(Term) - Method in interface org.refcodes.cli.ArgsSyntaxAccessor.ArgsSyntaxProperty
This method stores and passes through the given argument, which is very useful for builder APIs: Sets the given Condition (setter) as of ArgsSyntaxAccessor.ArgsSyntaxMutator.setArgsSyntax(Term) and returns the very same value (getter).
letArgumentEscapeCode(String) - Method in interface org.refcodes.cli.ArgumentEscapeCodeAccessor.ArgumentEscapeCodeProperty
This method stores and passes through the given argument, which is very useful for builder APIs: Sets the given String (setter) as of ArgumentEscapeCodeAccessor.ArgumentEscapeCodeMutator.setArgumentEscapeCode(String) and returns the very same value (getter).
letArgumentPrefix(String) - Method in interface org.refcodes.cli.ArgumentPrefixAccessor.ArgumentPrefixProperty
This method stores and passes through the given argument, which is very useful for builder APIs: Sets the given String (setter) as of ArgumentPrefixAccessor.ArgumentPrefixMutator.setArgumentPrefix(String) and returns the very same value (getter).
letArgumentSuffix(String) - Method in interface org.refcodes.cli.ArgumentSuffixAccessor.ArgumentSuffixProperty
This method stores and passes through the given argument, which is very useful for builder APIs: Sets the given String (setter) as of ArgumentSuffixAccessor.ArgumentSuffixMutator.setArgumentSuffix(String) and returns the very same value (getter).
letBannerBorderEscapeCode(String) - Method in interface org.refcodes.cli.BannerBorderEscapeCodeAccessor.BannerBorderEscapeCodeProperty
This method stores and passes through the given argument, which is very useful for builder APIs: Sets the given String (setter) as of BannerBorderEscapeCodeAccessor.BannerBorderEscapeCodeMutator.setBannerBorderEscapeCode(String) and returns the very same value (getter).
letBannerEscapeCode(String) - Method in interface org.refcodes.cli.BannerEscapeCodeAccessor.BannerEscapeCodeProperty
This method stores and passes through the given argument, which is very useful for builder APIs: Sets the given String (setter) as of BannerEscapeCodeAccessor.BannerEscapeCodeMutator.setBannerEscapeCode(String) and returns the very same value (getter).
letBannerFont(Font) - Method in interface org.refcodes.cli.BannerFontAccessor.BannerFontProperty
This method stores and passes through the given argument, which is very useful for builder APIs: Sets the given Font (setter) as of BannerFontAccessor.BannerFontMutator.setBannerFont(Font) and returns the very same value (getter).
letBannerFontPalette(char[]) - Method in interface org.refcodes.cli.BannerFontPaletteAccessor.BannerFontPaletteProperty
This method stores and passes through the given argument, which is very useful for builder APIs: Sets the given palette (setter) as of BannerFontPaletteAccessor.BannerFontPaletteMutator.setBannerFontPalette(char[]) and returns the very same value (getter).
letCliContext(CliContext) - Method in interface org.refcodes.cli.CliContextAccessor.CliContextProperty
This method stores and passes through the given argument, which is very useful for builder APIs: Sets the given CliContext (setter) as of CliContextAccessor.CliContextMutator.setCliContext(CliContext) and returns the very same value (getter).
letCommandEscapeCode(String) - Method in interface org.refcodes.cli.CommandEscapeCodeAccessor.CommandEscapeCodeProperty
This method stores and passes through the given argument, which is very useful for builder APIs: Sets the given String (setter) as of CommandEscapeCodeAccessor.CommandEscapeCodeMutator.setCommandEscapeCode(String) and returns the very same value (getter).
letCopyright(String) - Method in interface org.refcodes.cli.CopyrightAccessor.CopyrightProperty
This method stores and passes through the given argument, which is very useful for builder APIs: Sets the given width (setter) as of CopyrightAccessor.CopyrightMutator.setCopyright(String) and returns the very same value (getter).
letDescriptionEscapeCode(String) - Method in interface org.refcodes.cli.DescriptionEscapeCodeAccessor.DescriptionEscapeCodeProperty
This method stores and passes through the given argument, which is very useful for builder APIs: Sets the given String (setter) as of DescriptionEscapeCodeAccessor.DescriptionEscapeCodeMutator.setDescriptionEscapeCode(String) and returns the very same value (getter).
letExamples(Example[]) - Method in interface org.refcodes.cli.ExamplesAccessor.ExamplesProperty
This method stores and passes through the given argument, which is very useful for builder APIs: Sets the given Condition (setter) as of ExamplesAccessor.ExamplesMutator.setExamples(Example[]) and returns the very same value (getter).
letLicense(String) - Method in interface org.refcodes.cli.LicenseAccessor.LicenseProperty
This method stores and passes through the given argument, which is very useful for builder APIs: Sets the given width (setter) as of LicenseAccessor.LicenseMutator.setLicense(String) and returns the very same value (getter).
letLineSeparatorEscapeCode(String) - Method in interface org.refcodes.cli.LineSeparatorEscapeCodeAccessor.LineSeparatorEscapeCodeProperty
This method stores and passes through the given argument, which is very useful for builder APIs: Sets the given String (setter) as of LineSeparatorEscapeCodeAccessor.LineSeparatorEscapeCodeMutator.setLineSeparatorEscapeCode(String) and returns the very same value (getter).
letLongOption(String) - Method in interface org.refcodes.cli.LongOptionAccessor.LongOptionProperty
This method stores and passes through the given argument, which is very useful for builder APIs: Sets the given String (setter) as of LongOptionAccessor.LongOptionMutator.setLongOption(String) and returns the very same value (getter).
letLongOptionPrefix(String) - Method in interface org.refcodes.cli.LongOptionPrefixAccessor.LongOptionPrefixProperty
This method stores and passes through the given argument, which is very useful for builder APIs: Sets the given String (setter) as of LongOptionPrefixAccessor.LongOptionPrefixMutator.setLongOptionPrefix(String) and returns the very same value (getter).
letLongPropertyPrefix(String) - Method in interface org.refcodes.cli.LongPropertyPrefixAccessor.LongPropertyPrefixProperty
This method stores and passes through the given argument, which is very useful for builder APIs: Sets the given String (setter) as of LongPropertyPrefixAccessor.LongPropertyPrefixMutator.setLongPropertyPrefix(String) and returns the very same value (getter).
letMatchCount(int) - Method in interface org.refcodes.cli.MatchCountAccessor.MatchCountProperty
This method stores and passes through the given argument, which is very useful for builder APIs: Sets the given value (setter) as of MatchCountAccessor.MatchCountMutator.setMatchCount(int) and returns the very same value (getter).
letOptionEscapeCode(String) - Method in interface org.refcodes.cli.OptionEscapeCodeAccessor.OptionEscapeCodeProperty
This method stores and passes through the given argument, which is very useful for builder APIs: Sets the given String (setter) as of OptionEscapeCodeAccessor.OptionEscapeCodeMutator.setOptionEscapeCode(String) and returns the very same value (getter).
letParsedArgs(String[]) - Method in interface org.refcodes.cli.ParsedArgsAccessor.ParsedArgsProperty
This method stores and passes through the given arguments, which is very useful for builder APIs: Sets the given String array (setter) as of ParsedArgsAccessor.ParsedArgsMutator.setParsedArgs(String[]) and returns the very same value (getter).
letPropertyEscapeCode(String) - Method in interface org.refcodes.cli.PropertyEscapeCodeAccessor.PropertyEscapeCodeProperty
This method stores and passes through the given argument, which is very useful for builder APIs: Sets the given String (setter) as of PropertyEscapeCodeAccessor.PropertyEscapeCodeMutator.setPropertyEscapeCode(String) and returns the very same value (getter).
letShortOption(String) - Method in interface org.refcodes.cli.ShortOptionAccessor.ShortOptionProperty
This method stores and passes through the given argument, which is very useful for builder APIs: Sets the given String (setter) as of setShortOption(String) and returns the very same value (getter).
letShortOptionPrefix(Character) - Method in interface org.refcodes.cli.ShortOptionPrefixAccessor.ShortOptionPrefixProperty
This method stores and passes through the given argument, which is very useful for builder APIs: Sets the given Character (setter) as of ShortOptionPrefixAccessor.ShortOptionPrefixMutator.setShortOptionPrefix(Character) and returns the very same value (getter).
letShortPropertyPrefix(Character) - Method in interface org.refcodes.cli.ShortPropertyPrefixAccessor.ShortPropertyPrefixProperty
This method stores and passes through the given argument, which is very useful for builder APIs: Sets the given Character (setter) as of ShortPropertyPrefixAccessor.ShortPropertyPrefixMutator.setShortPropertyPrefix(Character) and returns the very same value (getter).
letSyntaxMetrics(SyntaxMetrics) - Method in interface org.refcodes.cli.SyntaxMetricsAccessor.SyntaxMetricsProperty
This method stores and passes through the given argument, which is very useful for builder APIs: Sets the given SyntaxMetrics (setter) as of SyntaxMetricsAccessor.SyntaxMetricsMutator.setSyntaxMetrics(SyntaxMetrics) and returns the very same value (getter).
letSyntaxMetrics(SyntaxNotation) - Method in interface org.refcodes.cli.SyntaxMetricsAccessor.SyntaxMetricsProperty
This method stores and passes through the given argument, which is very useful for builder APIs: Sets the given SyntaxNotation (setter) as of SyntaxMetricsAccessor.SyntaxMetricsMutator.setSyntaxMetrics(SyntaxNotation) and returns the very same value (getter).
LicenseAccessor - Interface in org.refcodes.cli
Provides an accessor for a license property.
LicenseAccessor.LicenseBuilder<B extends LicenseAccessor.LicenseBuilder<B>> - Interface in org.refcodes.cli
Provides a builder method for a license property returning the builder for applying multiple build operations.
LicenseAccessor.LicenseMutator - Interface in org.refcodes.cli
Provides a mutator for a license property.
LicenseAccessor.LicenseProperty - Interface in org.refcodes.cli
Provides a license property.
LineSeparatorEscapeCodeAccessor - Interface in org.refcodes.cli
Provides an accessor for a line separator Escape-Code property.
LineSeparatorEscapeCodeAccessor.LineSeparatorEscapeCodeBuilder<B extends LineSeparatorEscapeCodeAccessor.LineSeparatorEscapeCodeBuilder<B>> - Interface in org.refcodes.cli
Provides a builder method for a line separator Escape-Code property returning the builder for applying multiple build operations.
LineSeparatorEscapeCodeAccessor.LineSeparatorEscapeCodeMutator - Interface in org.refcodes.cli
Provides a mutator for a line separator Escape-Code property.
LineSeparatorEscapeCodeAccessor.LineSeparatorEscapeCodeProperty - Interface in org.refcodes.cli
Provides a line separator Escape-Code property.
LOGICAL - Enum constant in enum class org.refcodes.cli.SyntaxNotation
A notation which the author of this code believes to unambiguously describe a command line utility's argument syntax; as defined by the means of this refcodes-cli artifact.
LONG_OPTION - Static variable in class org.refcodes.cli.CleanFlag
 
LONG_OPTION - Static variable in class org.refcodes.cli.ConfigOption
 
LONG_OPTION - Static variable in class org.refcodes.cli.ConfigProperty
 
LONG_OPTION - Static variable in class org.refcodes.cli.DaemonFlag
 
LONG_OPTION - Static variable in class org.refcodes.cli.DebugFlag
 
LONG_OPTION - Static variable in class org.refcodes.cli.ForceFlag
 
LONG_OPTION - Static variable in class org.refcodes.cli.HelpFlag
 
LONG_OPTION - Static variable in class org.refcodes.cli.InitFlag
 
LONG_OPTION - Static variable in class org.refcodes.cli.QuietFlag
 
LONG_OPTION - Static variable in class org.refcodes.cli.SysInfoFlag
 
LONG_OPTION - Static variable in class org.refcodes.cli.VerboseFlag
 
longOption(Character, String, String) - Static method in class org.refcodes.cli.CliSugar
Instantiates a new LongOption with the given arguments.
longOption(Character, String, String, String) - Static method in class org.refcodes.cli.CliSugar
Instantiates a new LongOption with the given arguments.
longOption(Character, String, String, String, Consumer<LongOption>) - Static method in class org.refcodes.cli.CliSugar
Instantiates a new LongOption with the given arguments.
longOption(Character, String, String, Consumer<LongOption>) - Static method in class org.refcodes.cli.CliSugar
Instantiates a new LongOption with the given arguments.
longOption(String, String) - Static method in class org.refcodes.cli.CliSugar
Instantiates a new LongOption with the given arguments.
longOption(String, String, String) - Static method in class org.refcodes.cli.CliSugar
Instantiates a new LongOption with the given arguments.
longOption(String, String, String, Consumer<LongOption>) - Static method in class org.refcodes.cli.CliSugar
Instantiates a new LongOption with the given arguments.
longOption(String, String, Consumer<LongOption>) - Static method in class org.refcodes.cli.CliSugar
Instantiates a new LongOption with the given arguments.
LongOption - Class in org.refcodes.cli
The LongOption represents an Option holding long values.
LongOption(Character, String, String) - Constructor for class org.refcodes.cli.LongOption
Instantiates a new LongOption with the given arguments.
LongOption(Character, String, String, String) - Constructor for class org.refcodes.cli.LongOption
Instantiates a new LongOption with the given arguments.
LongOption(Character, String, String, String, Consumer<LongOption>) - Constructor for class org.refcodes.cli.LongOption
Instantiates a new LongOption with the given arguments.
LongOption(Character, String, String, Consumer<LongOption>) - Constructor for class org.refcodes.cli.LongOption
Instantiates a new LongOption with the given arguments.
LongOption(String, String) - Constructor for class org.refcodes.cli.LongOption
Instantiates a new LongOption with the given arguments.
LongOption(String, String, String) - Constructor for class org.refcodes.cli.LongOption
Instantiates a new LongOption with the given arguments.
LongOption(String, String, String, Consumer<LongOption>) - Constructor for class org.refcodes.cli.LongOption
Instantiates a new LongOption with the given arguments.
LongOption(String, String, Consumer<LongOption>) - Constructor for class org.refcodes.cli.LongOption
Instantiates a new LongOption with the given arguments.
LongOption(Relation<String, Long>) - Constructor for class org.refcodes.cli.LongOption
Instantiates a new LongOption with the alias being the proerty's key and the value being the property's value.
LongOption(Relation<String, Long>, Consumer<LongOption>) - Constructor for class org.refcodes.cli.LongOption
Instantiates a new LongOption with the alias being the proerty's key and the value being the property's value.
LongOptionAccessor - Interface in org.refcodes.cli
Provides an accessor for a long option property.
LongOptionAccessor.LongOptionBuilder<B extends LongOptionAccessor.LongOptionBuilder<B>> - Interface in org.refcodes.cli
Provides a builder method for a long option property returning the builder for applying multiple build operations.
LongOptionAccessor.LongOptionMutator - Interface in org.refcodes.cli
Provides a mutator for a long option property.
LongOptionAccessor.LongOptionProperty - Interface in org.refcodes.cli
Provides a long option property.
LongOptionPrefixAccessor - Interface in org.refcodes.cli
Provides an accessor for a long option prefix property.
LongOptionPrefixAccessor.LongOptionPrefixBuilder<B extends LongOptionPrefixAccessor.LongOptionPrefixBuilder<B>> - Interface in org.refcodes.cli
Provides a builder method for a long option prefix property returning the builder for applying multiple build operations.
LongOptionPrefixAccessor.LongOptionPrefixMutator - Interface in org.refcodes.cli
Provides a mutator for a long option prefix property.
LongOptionPrefixAccessor.LongOptionPrefixProperty - Interface in org.refcodes.cli
Provides a long option prefix property.
longProperty(Character, String, String) - Static method in class org.refcodes.cli.CliSugar
Instantiates a new LongProperty with the given arguments.
longProperty(Character, String, String, String) - Static method in class org.refcodes.cli.CliSugar
Instantiates a new LongProperty with the given arguments.
longProperty(Character, String, String, String, Consumer<LongProperty>) - Static method in class org.refcodes.cli.CliSugar
Instantiates a new LongProperty with the given arguments.
longProperty(Character, String, String, Consumer<LongProperty>) - Static method in class org.refcodes.cli.CliSugar
Instantiates a new LongProperty with the given arguments.
longProperty(String, String) - Static method in class org.refcodes.cli.CliSugar
Instantiates a new LongProperty with the given arguments.
longProperty(String, String, String) - Static method in class org.refcodes.cli.CliSugar
Instantiates a new LongProperty with the given arguments.
longProperty(String, String, String, Consumer<LongProperty>) - Static method in class org.refcodes.cli.CliSugar
Instantiates a new LongProperty with the given arguments.
longProperty(String, String, Consumer<LongProperty>) - Static method in class org.refcodes.cli.CliSugar
Instantiates a new LongProperty with the given arguments.
LongProperty - Class in org.refcodes.cli
The LongProperty represents an PropertyOption holding long values.
LongProperty(Character, String, String) - Constructor for class org.refcodes.cli.LongProperty
Instantiates a new LongProperty with the given arguments.
LongProperty(Character, String, String, String) - Constructor for class org.refcodes.cli.LongProperty
Instantiates a new LongProperty with the given arguments.
LongProperty(Character, String, String, String, Consumer<LongProperty>) - Constructor for class org.refcodes.cli.LongProperty
Instantiates a new LongProperty with the given arguments.
LongProperty(Character, String, String, Consumer<LongProperty>) - Constructor for class org.refcodes.cli.LongProperty
Instantiates a new LongProperty with the given arguments.
LongProperty(String, String) - Constructor for class org.refcodes.cli.LongProperty
Instantiates a new LongProperty with the given arguments.
LongProperty(String, String, String) - Constructor for class org.refcodes.cli.LongProperty
Instantiates a new LongProperty with the given arguments.
LongProperty(String, String, String, Consumer<LongProperty>) - Constructor for class org.refcodes.cli.LongProperty
Instantiates a new LongProperty with the given arguments.
LongProperty(String, String, Consumer<LongProperty>) - Constructor for class org.refcodes.cli.LongProperty
Instantiates a new LongProperty with the given arguments.
LongProperty(Relation<String, Long>) - Constructor for class org.refcodes.cli.LongProperty
Instantiates a new LongProperty with the alias being the proerty's key and the value being the property's value.
LongProperty(Relation<String, Long>, Consumer<LongProperty>) - Constructor for class org.refcodes.cli.LongProperty
Instantiates a new LongProperty with the alias being the proerty's key and the value being the property's value.
LongPropertyPrefixAccessor - Interface in org.refcodes.cli
Provides an accessor for a long option prefix property.
LongPropertyPrefixAccessor.LongPropertyPrefixBuilder<B extends LongPropertyPrefixAccessor.LongPropertyPrefixBuilder<B>> - Interface in org.refcodes.cli
Provides a builder method for a long option prefix property returning the builder for applying multiple build operations.
LongPropertyPrefixAccessor.LongPropertyPrefixMutator - Interface in org.refcodes.cli
Provides a mutator for a long option prefix property.
LongPropertyPrefixAccessor.LongPropertyPrefixProperty - Interface in org.refcodes.cli
Provides a long option prefix property.

M

MATCH_COUNT - Static variable in class org.refcodes.cli.CliSchema
 
MatchCountAccessor - Interface in org.refcodes.cli
Provides an accessor for a match-count property.
MatchCountAccessor.MatchCountBuilder<B extends MatchCountAccessor.MatchCountBuilder<B>> - Interface in org.refcodes.cli
Provides a builder method for a match-count property returning the builder for applying multiple build operations.
MatchCountAccessor.MatchCountMutator - Interface in org.refcodes.cli
Provides a mutator for a match-count property.
MatchCountAccessor.MatchCountProperty - Interface in org.refcodes.cli
Provides a match-count property.

N

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

O

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

P

parseArgs(String[], String[], CliContext) - Method in class org.refcodes.cli.AbstractOperand
Parses the provided command line arguments and determines the according values by evaluating this Term instance or, in case of being a node in the syntax tree (such as a Condition, traversing the child Term instances' Term.parseArgs(String[], String[], CliContext) methods.
parseArgs(String[], String[], CliContext) - Method in class org.refcodes.cli.AbstractOption
Parses the provided command line arguments and determines the according values by evaluating this Term instance or, in case of being a node in the syntax tree (such as a Condition, traversing the child Term instances' Term.parseArgs(String[], String[], CliContext) methods.
parseArgs(String[], String[], CliContext) - Method in class org.refcodes.cli.AbstractPropertyOption
Parses the provided command line arguments and determines the according values by evaluating this Term instance or, in case of being a node in the syntax tree (such as a Condition, traversing the child Term instances' Term.parseArgs(String[], String[], CliContext) methods.
parseArgs(String[], String[], CliContext) - Method in class org.refcodes.cli.AllCondition
Parses the provided command line arguments and determines the according values by evaluating this Term instance or, in case of being a node in the syntax tree (such as a Condition, traversing the child Term instances' Term.parseArgs(String[], String[], CliContext) methods.
parseArgs(String[], String[], CliContext) - Method in class org.refcodes.cli.AndCondition
Parses the provided command line arguments and determines the according values by evaluating this Term instance or, in case of being a node in the syntax tree (such as a Condition, traversing the child Term instances' Term.parseArgs(String[], String[], CliContext) methods.
parseArgs(String[], String[], CliContext) - Method in class org.refcodes.cli.AnyCondition
Parses the provided command line arguments and determines the according values by evaluating this Term instance or, in case of being a node in the syntax tree (such as a Condition, traversing the child Term instances' Term.parseArgs(String[], String[], CliContext) methods.
parseArgs(String[], String[], CliContext) - Method in class org.refcodes.cli.ArrayOperand
Parses the provided command line arguments and determines the according values by evaluating this Term instance or, in case of being a node in the syntax tree (such as a Condition, traversing the child Term instances' Term.parseArgs(String[], String[], CliContext) methods.
parseArgs(String[], String[], CliContext) - Method in class org.refcodes.cli.Flag
Parses the provided command line arguments and determines the according values by evaluating this Term instance or, in case of being a node in the syntax tree (such as a Condition, traversing the child Term instances' Term.parseArgs(String[], String[], CliContext) methods.
parseArgs(String[], String[], CliContext) - Method in class org.refcodes.cli.NoneOperand
Parses the provided command line arguments and determines the according values by evaluating this Term instance or, in case of being a node in the syntax tree (such as a Condition, traversing the child Term instances' Term.parseArgs(String[], String[], CliContext) methods.
parseArgs(String[], String[], CliContext) - Method in class org.refcodes.cli.Operation
Parses the provided command line arguments and determines the according values by evaluating this Term instance or, in case of being a node in the syntax tree (such as a Condition, traversing the child Term instances' Term.parseArgs(String[], String[], CliContext) methods.
parseArgs(String[], String[], CliContext) - Method in class org.refcodes.cli.OrCondition
Parses the provided command line arguments and determines the according values by evaluating this Term instance or, in case of being a node in the syntax tree (such as a Condition, traversing the child Term instances' Term.parseArgs(String[], String[], CliContext) methods.
parseArgs(String[], String[], CliContext) - Method in interface org.refcodes.cli.Term
Parses the provided command line arguments and determines the according values by evaluating this Term instance or, in case of being a node in the syntax tree (such as a Condition, traversing the child Term instances' Term.parseArgs(String[], String[], CliContext) methods.
parseArgs(String[], String[], CliContext) - Method in class org.refcodes.cli.XorCondition
Parses the provided command line arguments and determines the according values by evaluating this Term instance or, in case of being a node in the syntax tree (such as a Condition, traversing the child Term instances' Term.parseArgs(String[], String[], CliContext) methods.
parseArgs(String[], CliContext) - Method in interface org.refcodes.cli.Term
Parses the provided command line arguments and determines the according values by evaluating this Term instance or, in case of being a node in the syntax tree (such as a Condition, traversing the child Term instances' Term.parseArgs(String[], String[], CliContext) methods.
ParseArgs - Interface in org.refcodes.cli
The ParseArgs provides means for parsing command line arguments and constructing a command line utility's help output.
ParseArgsException - Exception in org.refcodes.cli
Thrown in case the provided command line arguments do not respect the required semantics or cannot be converted to the required type.
ParseArgsException(String[], Throwable) - Constructor for exception org.refcodes.cli.ParseArgsException
ParseArgsException(String[], Throwable, String) - Constructor for exception org.refcodes.cli.ParseArgsException
ParseArgsException(String[], Term, Throwable) - Constructor for exception org.refcodes.cli.ParseArgsException
ParseArgsException(String[], Term, Throwable, String) - Constructor for exception org.refcodes.cli.ParseArgsException
ParseArgsException(String, String[]) - Constructor for exception org.refcodes.cli.ParseArgsException
ParseArgsException(String, String[], String) - Constructor for exception org.refcodes.cli.ParseArgsException
ParseArgsException(String, String[], Throwable) - Constructor for exception org.refcodes.cli.ParseArgsException
ParseArgsException(String, String[], Throwable, String) - Constructor for exception org.refcodes.cli.ParseArgsException
ParseArgsException(String, String[], Term) - Constructor for exception org.refcodes.cli.ParseArgsException
ParseArgsException(String, String[], Term, String) - Constructor for exception org.refcodes.cli.ParseArgsException
ParseArgsException(String, String[], Term, Throwable) - Constructor for exception org.refcodes.cli.ParseArgsException
ParseArgsException(String, String[], Term, Throwable, String) - Constructor for exception org.refcodes.cli.ParseArgsException
ParsedArgsAccessor - Interface in org.refcodes.cli
Provides an accessor for a command line arguments (short "args") array.
ParsedArgsAccessor.ParsedArgsMutator - Interface in org.refcodes.cli
Provides a mutator for a parsed args property.
ParsedArgsAccessor.ParsedArgsProperty - Interface in org.refcodes.cli
Provides a parsed args property.
ParseOptionArgsException - Exception in org.refcodes.cli
Thrown in case the provided command line arguments do not respect the required semantics or cannot be converted to the required type by an Option (having a short- and/or a long-option), e.g. the arguments were rejected as them did not work for the according syntax.
ParseOptionArgsException(String[], String, String, Throwable) - Constructor for exception org.refcodes.cli.ParseOptionArgsException
ParseOptionArgsException(String[], String, String, Throwable, String) - Constructor for exception org.refcodes.cli.ParseOptionArgsException
ParseOptionArgsException(String[], String, String, Throwable, Term) - Constructor for exception org.refcodes.cli.ParseOptionArgsException
ParseOptionArgsException(String[], String, String, Throwable, Term, String) - Constructor for exception org.refcodes.cli.ParseOptionArgsException
ParseOptionArgsException(String, String[], String, String) - Constructor for exception org.refcodes.cli.ParseOptionArgsException
ParseOptionArgsException(String, String[], String, String, String) - Constructor for exception org.refcodes.cli.ParseOptionArgsException
ParseOptionArgsException(String, String[], String, String, Throwable) - Constructor for exception org.refcodes.cli.ParseOptionArgsException
ParseOptionArgsException(String, String[], String, String, Throwable, String) - Constructor for exception org.refcodes.cli.ParseOptionArgsException
ParseOptionArgsException(String, String[], String, String, Throwable, Term) - Constructor for exception org.refcodes.cli.ParseOptionArgsException
ParseOptionArgsException(String, String[], String, String, Throwable, Term, String) - Constructor for exception org.refcodes.cli.ParseOptionArgsException
ParseOptionArgsException(String, String[], String, String, Term) - Constructor for exception org.refcodes.cli.ParseOptionArgsException
ParseOptionArgsException(String, String[], String, String, Term, String) - Constructor for exception org.refcodes.cli.ParseOptionArgsException
printBanner() - Method in class org.refcodes.cli.ArgsParser
Prints the banner; the banner most probably is an ASCII_HEADER_ASCII_BODY art text block which's look depends strongly on the taste of the author implementing this interface.
printBanner() - Method in interface org.refcodes.cli.ParseArgs
Prints the banner; the banner most probably is an ASCII_HEADER_ASCII_BODY art text block which's look depends strongly on the taste of the author implementing this interface.
printBody() - Method in interface org.refcodes.cli.ParseArgs
Prints the help as of ParseArgs.printHelp() without the banner.
printCopyright() - Method in class org.refcodes.cli.ArgsParser
Prints the copyright note as specified by the ParseArgs.withCopyright(String) method; with regards to the console width as specified by the ParseArgs.withConsoleWidth(int) method.
printCopyright() - Method in interface org.refcodes.cli.ParseArgs
Prints the copyright note as specified by the ParseArgs.withCopyright(String) method; with regards to the console width as specified by the ParseArgs.withConsoleWidth(int) method.
printDescription() - Method in class org.refcodes.cli.ArgsParser
Prints the description as set by the ParseArgs.withDescription(String) method with regards to the console width as specified by the ParseArgs.withConsoleWidth(int) method.
printDescription() - Method in interface org.refcodes.cli.ParseArgs
Prints the description as set by the ParseArgs.withDescription(String) method with regards to the console width as specified by the ParseArgs.withConsoleWidth(int) method.
printExamples() - Method in class org.refcodes.cli.ArgsParser
Prints example usages as as added by the ParseArgs.addExample(String, Operand...) method with regards to the console width as specified by the ParseArgs.withConsoleWidth(int) method.
printExamples() - Method in interface org.refcodes.cli.ParseArgs
Prints example usages as as added by the ParseArgs.addExample(String, Operand...) method with regards to the console width as specified by the ParseArgs.withConsoleWidth(int) method.
printHeader() - Method in class org.refcodes.cli.ArgsParser
Prints the header, which might be a simplified banner: Can be used when overriding methods such as ParseArgs.printHelp() or ParseArgs.printBanner().
printHeader() - Method in interface org.refcodes.cli.ParseArgs
Prints the header, which might be a simplified banner: Can be used when overriding methods such as ParseArgs.printHelp() or ParseArgs.printBanner().
printHelp() - Method in interface org.refcodes.cli.ParseArgs
Prints the help to the standard output specified by the ParseArgs.withStandardOut(PrintStream) method.
printLicense() - Method in class org.refcodes.cli.ArgsParser
Prints the license note as specified by the ParseArgs.withLicense(String) method; with regards to the console width as specified by the ParseArgs.withConsoleWidth(int) method.
printLicense() - Method in interface org.refcodes.cli.ParseArgs
Prints the license note as specified by the ParseArgs.withLicense(String) method; with regards to the console width as specified by the ParseArgs.withConsoleWidth(int) method.
printLn() - Method in class org.refcodes.cli.ArgsParser
Prints an empty line / a line break.
printLn() - Method in interface org.refcodes.cli.ParseArgs
Prints an empty line / a line break.
printLn(String) - Method in class org.refcodes.cli.ArgsParser
Prints the given line to standard out with regards to the console width as specified by the ParseArgs.withConsoleWidth(int) method.
printLn(String) - Method in interface org.refcodes.cli.ParseArgs
Prints the given line to standard out with regards to the console width as specified by the ParseArgs.withConsoleWidth(int) method.
printOptions() - Method in class org.refcodes.cli.ArgsParser
Prints the Options (short- and the long-options), the Flages and the Operand and their description with regards to the console width as specified by the ParseArgs.withConsoleWidth(int) method.
printOptions() - Method in interface org.refcodes.cli.ParseArgs
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 ParseArgs.withConsoleWidth(int) method.
printSeparatorLn() - Method in class org.refcodes.cli.ArgsParser
Prints a separator line using the separator character as specified by the ParseArgs.withSeparatorLnChar(char) method; with regards to the console width as specified by the ParseArgs.withConsoleWidth(int) method.
printSeparatorLn() - Method in interface org.refcodes.cli.ParseArgs
Prints a separator line using the separator character as specified by the ParseArgs.withSeparatorLnChar(char) method; with regards to the console width as specified by the ParseArgs.withConsoleWidth(int) method.
printSynopsis() - Method in class org.refcodes.cli.ArgsParser
Prints the syntax as retrieved by the root Condition element as of Synopsisable.toSynopsis(SyntaxNotation) with regards to the SyntaxNotation set by the ParseArgs.withSyntaxMetrics(SyntaxMetrics) method.
printSynopsis() - Method in interface org.refcodes.cli.ParseArgs
Prints the syntax as retrieved by the root Condition element as of Synopsisable.toSynopsis(SyntaxNotation) with regards to the SyntaxNotation set by the ParseArgs.withSyntaxMetrics(SyntaxMetrics) method.
PropertyEscapeCodeAccessor - Interface in org.refcodes.cli
Provides an accessor for a option Escape-Code property.
PropertyEscapeCodeAccessor.PropertyEscapeCodeBuilder<B extends PropertyEscapeCodeAccessor.PropertyEscapeCodeBuilder<B>> - Interface in org.refcodes.cli
Provides a builder method for a option Escape-Code property returning the builder for applying multiple build operations.
PropertyEscapeCodeAccessor.PropertyEscapeCodeMutator - Interface in org.refcodes.cli
Provides a mutator for a option Escape-Code property.
PropertyEscapeCodeAccessor.PropertyEscapeCodeProperty - Interface in org.refcodes.cli
Provides a option Escape-Code property.
PropertyOption<T> - Interface in org.refcodes.cli
An PropertyOption represents a command line property with the according porperty's key and value.

Q

quietFlag() - Static method in class org.refcodes.cli.CliSugar
Constructs the predefined quiet Flag.
quietFlag(boolean) - Static method in class org.refcodes.cli.CliSugar
Constructs the predefined quiet Flag.
quietFlag(String) - Static method in class org.refcodes.cli.CliSugar
Constructs the predefined quiet Flag.
QuietFlag - Class in org.refcodes.cli
A predefined "be quiet" Flag: A predefined Flag gives its QuietFlag.SHORT_OPTION, its QuietFlag.LONG_OPTION as well as its QuietFlag.ALIAS an according semantics regarded by other subsystems.
QuietFlag() - Constructor for class org.refcodes.cli.QuietFlag
Constructs the predefined quiet Flag.
QuietFlag(boolean) - Constructor for class org.refcodes.cli.QuietFlag
Constructs the predefined quiet Flag.
QuietFlag(String) - Constructor for class org.refcodes.cli.QuietFlag
Constructs the predefined quiet Flag.
QuietFlag(String, boolean) - Constructor for class org.refcodes.cli.QuietFlag
Constructs the predefined quiet Flag.

R

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

S

setArgs(String[]) - Method in interface org.refcodes.cli.ArgsAccessor.ArgsMutator
Sets the command line arguments for the args property.
setArgsParser(ParseArgs) - Method in interface org.refcodes.cli.ArgsParserAccessor.ArgsParserMutator
Sets the args-parser for the ParseArgs property.
setArgsSyntax(Term) - Method in class org.refcodes.cli.ArgsParser
Sets the (root) Term for the (root) Term property.
setArgsSyntax(Term) - Method in interface org.refcodes.cli.ArgsSyntaxAccessor.ArgsSyntaxMutator
Sets the (root) Term for the (root) Term property.
setArgumentEscapeCode(String) - Method in class org.refcodes.cli.ArgsParser
Sets the argument Escape-Code for the argument Escape-Code property.
setArgumentEscapeCode(String) - Method in interface org.refcodes.cli.ArgumentEscapeCodeAccessor.ArgumentEscapeCodeMutator
Sets the argument Escape-Code for the argument Escape-Code property.
setArgumentPrefix(String) - Method in interface org.refcodes.cli.ArgumentPrefixAccessor.ArgumentPrefixMutator
Sets the argument prefix for the argument prefix property.
setArgumentSuffix(String) - Method in interface org.refcodes.cli.ArgumentSuffixAccessor.ArgumentSuffixMutator
Sets the argument suffix for the argument suffix property.
setBannerBorderEscapeCode(String) - Method in class org.refcodes.cli.ArgsParser
Sets the banner border Escape-Code for the banner border Escape-Code property.
setBannerBorderEscapeCode(String) - Method in interface org.refcodes.cli.BannerBorderEscapeCodeAccessor.BannerBorderEscapeCodeMutator
Sets the banner border Escape-Code for the banner border Escape-Code property.
setBannerEscapeCode(String) - Method in class org.refcodes.cli.ArgsParser
Sets the banner Escape-Code for the banner Escape-Code property.
setBannerEscapeCode(String) - Method in interface org.refcodes.cli.BannerEscapeCodeAccessor.BannerEscapeCodeMutator
Sets the banner Escape-Code for the banner Escape-Code property.
setBannerFont(Font) - Method in class org.refcodes.cli.ArgsParser
Sets the banner Font for the banner Font property.
setBannerFont(Font) - Method in interface org.refcodes.cli.BannerFontAccessor.BannerFontMutator
Sets the banner Font for the banner Font property.
setBannerFontPalette(char[]) - Method in class org.refcodes.cli.ArgsParser
Sets the banner font palette for the banner font palette property.
setBannerFontPalette(char[]) - Method in interface org.refcodes.cli.BannerFontPaletteAccessor.BannerFontPaletteMutator
Sets the banner font palette for the banner font palette property.
setBannerFontPalette(AsciiColorPalette) - Method in class org.refcodes.cli.ArgsParser
Sets the banner font palette for the banner font palette property.
setBannerFontPalette(AsciiColorPalette) - Method in interface org.refcodes.cli.BannerFontPaletteAccessor.BannerFontPaletteMutator
Sets the banner font palette for the banner font palette property.
setCliContext(CliContext) - Method in interface org.refcodes.cli.CliContextAccessor.CliContextMutator
Sets the CliContext for the CliContext property.
setCommandEscapeCode(String) - Method in class org.refcodes.cli.ArgsParser
Sets the command Escape-Code for the command Escape-Code property.
setCommandEscapeCode(String) - Method in interface org.refcodes.cli.CommandEscapeCodeAccessor.CommandEscapeCodeMutator
Sets the command Escape-Code for the command Escape-Code property.
setConsoleWidth(int) - Method in class org.refcodes.cli.ArgsParser
setCopyright(String) - Method in class org.refcodes.cli.ArgsParser
Sets the copyright for the copyright property.
setCopyright(String) - Method in interface org.refcodes.cli.CopyrightAccessor.CopyrightMutator
Sets the copyright for the copyright property.
setDescription(String) - Method in class org.refcodes.cli.ArgsParser
setDescriptionEscapeCode(String) - Method in class org.refcodes.cli.ArgsParser
Sets the description Escape-Code for the description Escape-Code property.
setDescriptionEscapeCode(String) - Method in interface org.refcodes.cli.DescriptionEscapeCodeAccessor.DescriptionEscapeCodeMutator
Sets the description Escape-Code for the description Escape-Code property.
setErrorOut(PrintStream) - Method in class org.refcodes.cli.ArgsParser
Set the error out PrintStream and make other adjustments with the result (with regards to the Builder-Pattern).
setErrorOut(PrintStream) - Method in interface org.refcodes.cli.ParseArgs
Set the error out PrintStream and make other adjustments with the result (with regards to the Builder-Pattern).
setEscapeCodesEnabled(boolean) - Method in class org.refcodes.cli.ArgsParser
setExamples(Collection<Example>) - Method in interface org.refcodes.cli.ExamplesAccessor.ExamplesMutator
Sets the Example instances for the Example instances property.
setExamples(Example[]) - Method in class org.refcodes.cli.ArgsParser
Sets the Example instances for the Example instances property.
setExamples(Example[]) - Method in interface org.refcodes.cli.ExamplesAccessor.ExamplesMutator
Sets the Example instances for the Example instances property.
setLicense(String) - Method in class org.refcodes.cli.ArgsParser
Sets the license for the license property.
setLicense(String) - Method in interface org.refcodes.cli.LicenseAccessor.LicenseMutator
Sets the license for the license property.
setLineBreak(String) - Method in class org.refcodes.cli.ArgsParser
setLineSeparatorEscapeCode(String) - Method in class org.refcodes.cli.ArgsParser
Sets the line separator Escape-Code for the line separator Escape-Code property.
setLineSeparatorEscapeCode(String) - Method in interface org.refcodes.cli.LineSeparatorEscapeCodeAccessor.LineSeparatorEscapeCodeMutator
Sets the line separator Escape-Code for the line separator Escape-Code property.
setLineSeparatorEscapeCode(String) - Method in interface org.refcodes.cli.ParseArgs
Sets the line separator Escape-Code for the line separator Escape-Code property.
setLongOption(String) - Method in interface org.refcodes.cli.LongOptionAccessor.LongOptionMutator
Sets the long option for the long option property.
setLongOptionPrefix(String) - Method in class org.refcodes.cli.ArgsParser
Sets the long option prefix for the long option prefix property.
setLongOptionPrefix(String) - Method in interface org.refcodes.cli.LongOptionPrefixAccessor.LongOptionPrefixMutator
Sets the long option prefix for the long option prefix property.
setLongPropertyPrefix(String) - Method in interface org.refcodes.cli.LongPropertyPrefixAccessor.LongPropertyPrefixMutator
Sets the long option prefix for the long option prefix property.
setMatchCount(int) - Method in interface org.refcodes.cli.MatchCountAccessor.MatchCountMutator
Sets the match-count for the match-count property.
setMaxConsoleWidth(int) - Method in class org.refcodes.cli.ArgsParser
setName(String) - Method in class org.refcodes.cli.ArgsParser
setOptionEscapeCode(String) - Method in class org.refcodes.cli.ArgsParser
Sets the option Escape-Code for the option Escape-Code property.
setOptionEscapeCode(String) - Method in interface org.refcodes.cli.OptionEscapeCodeAccessor.OptionEscapeCodeMutator
Sets the option Escape-Code for the option Escape-Code property.
setParsedArgs(String[]) - Method in class org.refcodes.cli.AbstractOperand
Sets the command line argument(s) representing the Operand and its value as parsed by the AbstractOperand.parseArgs(String[], String[], CliContext) method.
setParsedArgs(String[]) - Method in class org.refcodes.cli.AbstractOption
Sets the command line argument(s) representing the Operand and its value as parsed by the AbstractOperand.parseArgs(String[], String[], CliContext) method.
setParsedArgs(String[]) - Method in interface org.refcodes.cli.ParsedArgsAccessor.ParsedArgsMutator
Sets the command line arguments for the parsed args property.
setPropertyEscapeCode(String) - Method in interface org.refcodes.cli.PropertyEscapeCodeAccessor.PropertyEscapeCodeMutator
Sets the option Escape-Code for the option Escape-Code property.
setResetEscapeCode(String) - Method in class org.refcodes.cli.ArgsParser
setSeparatorLnChar(char) - Method in class org.refcodes.cli.ArgsParser
Set the character to be used when printing a separator line with the ParseArgs.printSeparatorLn() method.
setSeparatorLnChar(char) - Method in interface org.refcodes.cli.ParseArgs
Set the character to be used when printing a separator line with the ParseArgs.printSeparatorLn() method.
setShortOption(String) - Method in interface org.refcodes.cli.ShortOptionAccessor.ShortOptionMutator
Sets the short option for the short option property.
setShortOptionPrefix(Character) - Method in class org.refcodes.cli.ArgsParser
Sets the short option prefix for the short option prefix property.
setShortOptionPrefix(Character) - Method in interface org.refcodes.cli.ShortOptionPrefixAccessor.ShortOptionPrefixMutator
Sets the short option prefix for the short option prefix property.
setShortPropertyPrefix(Character) - Method in interface org.refcodes.cli.ShortPropertyPrefixAccessor.ShortPropertyPrefixMutator
Sets the short option prefix for the short option prefix property.
setStandardOut(PrintStream) - Method in class org.refcodes.cli.ArgsParser
Set the standard out PrintStream and make other adjustments with the result (with regards to the Builder-Pattern).
setStandardOut(PrintStream) - Method in interface org.refcodes.cli.ParseArgs
Set the standard out PrintStream and make other adjustments with the result (with regards to the Builder-Pattern).
setSyntaxMetrics(SyntaxMetrics) - Method in class org.refcodes.cli.ArgsParser
Sets the SyntaxMetrics for the SyntaxMetrics property.
setSyntaxMetrics(SyntaxMetrics) - Method in interface org.refcodes.cli.ParseArgs
Sets the SyntaxMetrics for the SyntaxMetrics property.
setSyntaxMetrics(SyntaxMetrics) - Method in interface org.refcodes.cli.SyntaxMetricsAccessor.SyntaxMetricsMutator
Sets the SyntaxMetrics for the SyntaxMetrics property.
setSyntaxMetrics(SyntaxNotation) - Method in interface org.refcodes.cli.SyntaxMetricsAccessor.SyntaxMetricsMutator
Sets the SyntaxNotation for the SyntaxNotation property.
setTextBoxGrid(TextBoxGrid) - Method in class org.refcodes.cli.ArgsParser
setTitle(String) - Method in class org.refcodes.cli.ArgsParser
setValue(T) - Method in class org.refcodes.cli.AbstractOperand
Sets the value for the Operand as parsed by the AbstractOperand.parseArgs(String[], String[], CliContext) method.
setValue(T) - Method in class org.refcodes.cli.AbstractOption
Sets the value for the Operand as parsed by the AbstractOperand.parseArgs(String[], String[], CliContext) method.
SHORT_OPTION - Static variable in class org.refcodes.cli.CleanFlag
 
SHORT_OPTION - Static variable in class org.refcodes.cli.ConfigOption
 
SHORT_OPTION - Static variable in class org.refcodes.cli.ConfigProperty
 
SHORT_OPTION - Static variable in class org.refcodes.cli.DaemonFlag
 
SHORT_OPTION - Static variable in class org.refcodes.cli.DebugFlag
 
SHORT_OPTION - Static variable in class org.refcodes.cli.ForceFlag
 
SHORT_OPTION - Static variable in class org.refcodes.cli.HelpFlag
 
SHORT_OPTION - Static variable in class org.refcodes.cli.InitFlag
 
SHORT_OPTION - Static variable in class org.refcodes.cli.QuietFlag
 
SHORT_OPTION - Static variable in class org.refcodes.cli.SysInfoFlag
 
SHORT_OPTION - Static variable in class org.refcodes.cli.VerboseFlag
 
ShortOptionAccessor - Interface in org.refcodes.cli
Provides an accessor for a short option property.
ShortOptionAccessor.ShortOptionBuilder<B extends ShortOptionAccessor.ShortOptionBuilder<B>> - Interface in org.refcodes.cli
Provides a builder method for a short option property returning the builder for applying multiple build operations.
ShortOptionAccessor.ShortOptionMutator - Interface in org.refcodes.cli
Provides a mutator for a short option property.
ShortOptionAccessor.ShortOptionProperty - Interface in org.refcodes.cli
Provides a short option property.
ShortOptionPrefixAccessor - Interface in org.refcodes.cli
Provides an accessor for a short option prefix property.
ShortOptionPrefixAccessor.ShortOptionPrefixBuilder<B extends ShortOptionPrefixAccessor.ShortOptionPrefixBuilder<B>> - Interface in org.refcodes.cli
Provides a builder method for a short option prefix property returning the builder for applying multiple build operations.
ShortOptionPrefixAccessor.ShortOptionPrefixMutator - Interface in org.refcodes.cli
Provides a mutator for a short option prefix property.
ShortOptionPrefixAccessor.ShortOptionPrefixProperty - Interface in org.refcodes.cli
Provides a short option prefix property.
ShortPropertyPrefixAccessor - Interface in org.refcodes.cli
Provides an accessor for a short option prefix property.
ShortPropertyPrefixAccessor.ShortPropertyPrefixBuilder<B extends ShortPropertyPrefixAccessor.ShortPropertyPrefixBuilder<B>> - Interface in org.refcodes.cli
Provides a builder method for a short option prefix property returning the builder for applying multiple build operations.
ShortPropertyPrefixAccessor.ShortPropertyPrefixMutator - Interface in org.refcodes.cli
Provides a mutator for a short option prefix property.
ShortPropertyPrefixAccessor.ShortPropertyPrefixProperty - Interface in org.refcodes.cli
Provides a short option prefix property.
stringOperand(String, String) - Static method in class org.refcodes.cli.CliSugar
Instantiates a new StringOperand.
stringOperand(String, String, Consumer<StringOperand>) - Static method in class org.refcodes.cli.CliSugar
Instantiates a new StringOperand.
StringOperand - Class in org.refcodes.cli
An Operand (neither a short option nor a long option prepended nor being a switch) being s String.
StringOperand(String, String) - Constructor for class org.refcodes.cli.StringOperand
Instantiates a new StringOperand.
StringOperand(String, String, Consumer<StringOperand>) - Constructor for class org.refcodes.cli.StringOperand
Instantiates a new StringOperand.
StringOperand(Relation<String, String>) - Constructor for class org.refcodes.cli.StringOperand
Instantiates a new {StringOperand Flag} with the alias being the proerty's key and the value being the property's value.
StringOperand(Relation<String, String>, Consumer<StringOperand>) - Constructor for class org.refcodes.cli.StringOperand
Instantiates a new {StringOperand Flag} with the alias being the proerty's key and the value being the property's value.
stringOption(Character, String, String) - Static method in class org.refcodes.cli.CliSugar
Instantiates a new StringOption with the given arguments.
stringOption(Character, String, String, String) - Static method in class org.refcodes.cli.CliSugar
Instantiates a new StringOption with the given arguments.
stringOption(Character, String, String, String, Consumer<StringOption>) - Static method in class org.refcodes.cli.CliSugar
Instantiates a new StringOption with the given arguments.
stringOption(Character, String, String, Consumer<StringOption>) - Static method in class org.refcodes.cli.CliSugar
Instantiates a new StringOption with the given arguments.
stringOption(String, String) - Static method in class org.refcodes.cli.CliSugar
Instantiates a new StringOption with the given arguments.
stringOption(String, String, String) - Static method in class org.refcodes.cli.CliSugar
Instantiates a new StringOption with the given arguments.
stringOption(String, String, String, Consumer<StringOption>) - Static method in class org.refcodes.cli.CliSugar
Instantiates a new StringOption with the given arguments.
stringOption(String, String, Consumer<StringOption>) - Static method in class org.refcodes.cli.CliSugar
Instantiates a new StringOption with the given arguments.
StringOption - Class in org.refcodes.cli
The StringOption represents an Option holding String values.
StringOption(Character, String, String) - Constructor for class org.refcodes.cli.StringOption
Instantiates a new StringOption with the given arguments.
StringOption(Character, String, String, String) - Constructor for class org.refcodes.cli.StringOption
Instantiates a new StringOption with the given arguments.
StringOption(Character, String, String, String, Consumer<StringOption>) - Constructor for class org.refcodes.cli.StringOption
Instantiates a new StringOption with the given arguments.
StringOption(Character, String, String, Consumer<StringOption>) - Constructor for class org.refcodes.cli.StringOption
Instantiates a new StringOption with the given arguments.
StringOption(String, String) - Constructor for class org.refcodes.cli.StringOption
Instantiates a new StringOption with the given arguments.
StringOption(String, String, String) - Constructor for class org.refcodes.cli.StringOption
Instantiates a new StringOption with the given arguments.
StringOption(String, String, String, Consumer<StringOption>) - Constructor for class org.refcodes.cli.StringOption
Instantiates a new StringOption with the given arguments.
StringOption(String, String, Consumer<StringOption>) - Constructor for class org.refcodes.cli.StringOption
Instantiates a new StringOption with the given arguments.
StringOption(Relation<String, String>) - Constructor for class org.refcodes.cli.StringOption
Instantiates a new StringOption with the alias being the proerty's key and the value being the property's value.
StringOption(Relation<String, String>, Consumer<StringOption>) - Constructor for class org.refcodes.cli.StringOption
Instantiates a new StringOption with the alias being the proerty's key and the value being the property's value.
stringProperty(Character, String, String) - Static method in class org.refcodes.cli.CliSugar
Instantiates a new StringProperty with the given arguments.
stringProperty(Character, String, String, String) - Static method in class org.refcodes.cli.CliSugar
Instantiates a new StringProperty with the given arguments.
stringProperty(Character, String, String, String, Consumer<StringProperty>) - Static method in class org.refcodes.cli.CliSugar
Instantiates a new StringProperty with the given arguments.
stringProperty(Character, String, String, Consumer<StringProperty>) - Static method in class org.refcodes.cli.CliSugar
Instantiates a new StringProperty with the given arguments.
stringProperty(String, String) - Static method in class org.refcodes.cli.CliSugar
Instantiates a new StringProperty with the given arguments.
stringProperty(String, String, String) - Static method in class org.refcodes.cli.CliSugar
Instantiates a new StringProperty with the given arguments.
stringProperty(String, String, String, Consumer<StringProperty>) - Static method in class org.refcodes.cli.CliSugar
Instantiates a new StringProperty with the given arguments.
stringProperty(String, String, Consumer<StringProperty>) - Static method in class org.refcodes.cli.CliSugar
Instantiates a new StringProperty with the given arguments.
StringProperty - Class in org.refcodes.cli
The StringProperty represents an PropertyOption holding String values.
StringProperty(Character, String, String) - Constructor for class org.refcodes.cli.StringProperty
Instantiates a new StringProperty with the given arguments.
StringProperty(Character, String, String, String) - Constructor for class org.refcodes.cli.StringProperty
Instantiates a new StringProperty with the given arguments.
StringProperty(Character, String, String, String, Consumer<StringProperty>) - Constructor for class org.refcodes.cli.StringProperty
Instantiates a new StringProperty with the given arguments.
StringProperty(Character, String, String, Consumer<StringProperty>) - Constructor for class org.refcodes.cli.StringProperty
Instantiates a new StringProperty with the given arguments.
StringProperty(String, String) - Constructor for class org.refcodes.cli.StringProperty
Instantiates a new StringProperty with the given arguments.
StringProperty(String, String, String) - Constructor for class org.refcodes.cli.StringProperty
Instantiates a new StringProperty with the given arguments.
StringProperty(String, String, String, Consumer<StringProperty>) - Constructor for class org.refcodes.cli.StringProperty
Instantiates a new StringProperty with the given arguments.
StringProperty(String, String, Consumer<StringProperty>) - Constructor for class org.refcodes.cli.StringProperty
Instantiates a new StringProperty with the given arguments.
StringProperty(Relation<String, String>) - Constructor for class org.refcodes.cli.StringProperty
Instantiates a new StringProperty with the alias being the proerty's key and the value being the property's value.
StringProperty(Relation<String, String>, Consumer<StringProperty>) - Constructor for class org.refcodes.cli.StringProperty
Instantiates a new StringProperty with the alias being the proerty's key and the value being the property's value.
SuperfluousArgsException - Exception in org.refcodes.cli
Thrown in case there were arguments found not being used (superfluous arguments).
SuperfluousArgsException(String[], Throwable) - Constructor for exception org.refcodes.cli.SuperfluousArgsException
SuperfluousArgsException(String[], Throwable, String) - Constructor for exception org.refcodes.cli.SuperfluousArgsException
SuperfluousArgsException(String[], Term, Throwable) - Constructor for exception org.refcodes.cli.SuperfluousArgsException
SuperfluousArgsException(String[], Term, Throwable, String) - Constructor for exception org.refcodes.cli.SuperfluousArgsException
SuperfluousArgsException(String, String[]) - Constructor for exception org.refcodes.cli.SuperfluousArgsException
SuperfluousArgsException(String, String[], String) - Constructor for exception org.refcodes.cli.SuperfluousArgsException
SuperfluousArgsException(String, String[], Throwable) - Constructor for exception org.refcodes.cli.SuperfluousArgsException
SuperfluousArgsException(String, String[], Throwable, String) - Constructor for exception org.refcodes.cli.SuperfluousArgsException
SuperfluousArgsException(String, String[], Term) - Constructor for exception org.refcodes.cli.SuperfluousArgsException
SuperfluousArgsException(String, String[], Term, String) - Constructor for exception org.refcodes.cli.SuperfluousArgsException
SuperfluousArgsException(String, String[], Term, Throwable) - Constructor for exception org.refcodes.cli.SuperfluousArgsException
SuperfluousArgsException(String, String[], Term, Throwable, String) - Constructor for exception org.refcodes.cli.SuperfluousArgsException
Synopsisable - Interface in org.refcodes.cli
The Synopsisable interface defines those methods required to create a human readable usage String similar to a manpage's synopsis from the implementing instance.
SyntaxMetrics - Interface in org.refcodes.cli
The SyntaxMetrics provides properties specific to a specific command line syntax notation.
SyntaxMetricsAccessor - Interface in org.refcodes.cli
Provides an accessor for a SyntaxMetrics property.
SyntaxMetricsAccessor.SyntaxMetricsBuilder<B extends SyntaxMetricsAccessor.SyntaxMetricsBuilder<B>> - Interface in org.refcodes.cli
Provides a builder method for a SyntaxMetrics property returning the builder for applying multiple build operations.
SyntaxMetricsAccessor.SyntaxMetricsMutator - Interface in org.refcodes.cli
Provides a mutator for a SyntaxMetrics property.
SyntaxMetricsAccessor.SyntaxMetricsProperty - Interface in org.refcodes.cli
Provides a SyntaxMetrics property.
SyntaxMetricsImpl - Class in org.refcodes.cli
The SyntaxMetricsImpl class implements the SyntaxMetrics interface for building custom SyntaxMetrics instances.
SyntaxMetricsImpl(Character, String, String, String, String, String, String, String, String, String, String, String, String, String, String, String, String, String, String) - Constructor for class org.refcodes.cli.SyntaxMetricsImpl
Constructs an accordingly configured SyntaxMetricsImpl instance.
SyntaxMetricsImpl.Builder - Class in org.refcodes.cli
Builder to build SyntaxMetrics instances.
SyntaxNotation - Enum Class in org.refcodes.cli
The SyntaxNotation is used by a the Term.toSyntax(CliContext) method to determine which notation to be used for the generated syntax.
sysInfoFlag() - Static method in class org.refcodes.cli.CliSugar
Constructs the predefined system info Flag.
sysInfoFlag(boolean) - Static method in class org.refcodes.cli.CliSugar
Constructs the predefined system info Flag.
sysInfoFlag(String) - Static method in class org.refcodes.cli.CliSugar
Constructs the predefined system info Flag.
SysInfoFlag - Class in org.refcodes.cli
A predefined system information Flag: A predefined Flag gives its SysInfoFlag.SHORT_OPTION, its SysInfoFlag.LONG_OPTION as well as its SysInfoFlag.ALIAS an according semantics regarded by other subsystems..
SysInfoFlag() - Constructor for class org.refcodes.cli.SysInfoFlag
Constructs the predefined system information Flag.
SysInfoFlag(boolean) - Constructor for class org.refcodes.cli.SysInfoFlag
Constructs the predefined system information Flag.
SysInfoFlag(String) - Constructor for class org.refcodes.cli.SysInfoFlag
Constructs the predefined system information Flag.
SysInfoFlag(String, boolean) - Constructor for class org.refcodes.cli.SysInfoFlag
Constructs the predefined system information Flag.

T

Term - Interface in org.refcodes.cli
A Term 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.
toAllOptions(Term) - Method in class org.refcodes.cli.CliContext
Determines all options (short and long) found in the provided Term node and its children.
toArgsDiff(String[], String[]) - Static method in class org.refcodes.cli.AbstractCondition
Creates the difference between the provided set and the provided subset.
toArgsDiff(String[], List<? extends Operand<?>>) - Static method in class org.refcodes.cli.AbstractCondition
Creates the difference between the provided set and the provided Lists therein found argument arrays subset (as of Operand.getParsedArgs()).
toArgsDiff(String[], Operand<?>[]) - Static method in class org.refcodes.cli.AbstractCondition
Creates the difference between the provided set and the provided Lists therein found argument arrays subset (as of Operand.getParsedArgs()).
toArgsFilter(String) - Static method in enum class org.refcodes.cli.ArgsFilter
Retrieves a ArgsFilter depending on the given string, ignoring the case as well as being graceful regarding "-" and "_",.
toArgumentEscapeCode() - Method in class org.refcodes.cli.CliContext
Constructs the argument escape code depending on the escape code status (as of CliContext.isEscapeCodesEnabled()) and whether the argument escape code is not null or null (as of CliContext.getArgumentEscapeCode()).
toArgumentSpec(Operand<?>) - Method in class org.refcodes.cli.CliContext
Creates the argument specification from the provided Operand.
toArgumentSpec(Operand<?>, int, int) - Method in class org.refcodes.cli.CliContext
Creates the argument specification from the provided Operand.
toConditions(String[]) - Method in interface org.refcodes.cli.Condition
Determines the potential Condition instances matching the given args (intersection) which might be useful to get more details on failing to parse arguments (in case we have superfluous arguments and want to see which Condition parent's Operand child addressed them).
toException(String[], CliContext) - Method in class org.refcodes.cli.AbstractOption
Convenience method to create an UnknownArgsException.
toExpandOptions(String[]) - Method in class org.refcodes.cli.CliContext
Expands the provided args' short options and returns the resulting args.
toFiltered(String[]) - Method in enum class org.refcodes.cli.ArgsFilter
Filters the provided args by excluding (filtering) the args matching this enumerations criteria.
toFiltered(String[], Pattern) - Static method in enum class org.refcodes.cli.ArgsFilter
Filters the provided args by excluding (filtering) the args matching the provided Pattern.
toFiltered(List<String>) - Method in enum class org.refcodes.cli.ArgsFilter
Filters the provided args by excluding (filtering) the args matching this enumerations criteria.
toFiltered(List<String>, Pattern) - Static method in enum class org.refcodes.cli.ArgsFilter
Filters the provided args by excluding (filtering) the args matching the provided Pattern.
toHeuristicMessage() - Method in exception org.refcodes.cli.ArgsSyntaxException
Tries to determine the most verbose description of this exception by crawling the exception tree down the causes and suppressed exceptions and evaluating their Term source's Term.getMatchCount() argument match counts.
toLongOption(Option<?>) - Method in class org.refcodes.cli.CliContext
Creates the CliContext instance specific prefixed long option String from the provided Option by prefixing the Option's long option (as of Option.getLongOption()) with the long option prefix (as of LongOptionPrefixAccessor.getLongOptionPrefix()).
toOperand(Class<T>) - Method in interface org.refcodes.cli.Condition
Traverses the hierarchy of Condition tree and returns the (first) operand matching the given type.
toOperand(String) - Method in interface org.refcodes.cli.Condition
Traverses the hierarchy of Condition tree and returns the (first) operand matching the given alias.
toOperand(String, Class<T>) - Method in class org.refcodes.cli.AbstractCondition
Traverses the hierarchy of Condition tree and returns the (first) operand matching the given alias and type.
toOperand(String, Class<T>) - Method in interface org.refcodes.cli.Condition
Traverses the hierarchy of Condition tree and returns the (first) operand matching the given alias and type.
toOperands() - Method in class org.refcodes.cli.AbstractCondition
Traverses the hierarchy of Conditions and collects all therein found Operands and sub-types such as the Flag or the Option.
toOperands() - Method in interface org.refcodes.cli.Condition
Traverses the hierarchy of Conditions and collects all therein found Operands and sub-types such as the Flag or the Option.
toOperands(String[]) - Method in interface org.refcodes.cli.Condition
Determines the potential Operand instances matching the given args (intersection) which might be useful to get more details on failing to parse arguments (in case we have superfluous arguments and want to see which Operand addressed them).
toOptionEscapeCode() - Method in class org.refcodes.cli.CliContext
Constructs the option escape code depending on the escape code status (as of CliContext.isEscapeCodesEnabled()) and whether the option escape code is not null or null (as of CliContext.getOptionEscapeCode()).
toOptionPrefixes() - Method in interface org.refcodes.cli.SyntaxMetrics
Returns an array of the prefixes configured by this SyntaxMetrics instance, omitting any null or empty prefixes as well as any duplicates.
toOptions(Option<?>) - Method in class org.refcodes.cli.CliContext
Retrieves an array of the context specific options being configured for the given Option instance, being the long option (when set) and the short option (when set), by prepending the according runtime specific short option and long option prefix (if applicable).
toOptions(Option<?>) - Method in interface org.refcodes.cli.Optionable
Retrieves an array of the context specific options being configured for the given Option instance, being the long option (when set) and the short option (when set), by prepending the according runtime specific short option and long option prefix (if applicable).
toOptions(Option<?>) - Method in interface org.refcodes.cli.ParseArgs
Retrieves an array of the context specific options being configured for the given Option instance, being the long option (when set) and the short option (when set), by prepending the according runtime specific short option and long option prefix (if applicable).
toOptionSpec(Option<?>) - Method in class org.refcodes.cli.CliContext
Creates the CliContext instance specific option notation String (without any arguments), consisting of the short option (as of CliContext.toShortOption(Option)) and(!)
toOptionUsage(Option<?>) - Method in class org.refcodes.cli.CliContext
Creates the CliContext instance specific preferred prefixed option String, being the short option (as of CliContext.toShortOption(Option)) or, in case of the short option being null, the long option (as of CliContext.toLongOption(Option)).
toParsedArgs(Operand<?>[]...) - Static method in class org.refcodes.cli.AbstractCondition
Takes all Operand instances found in the provided Lists and adds all therein found argument arrays (as of Operand.getParsedArgs()) to the result.
toPropertyArgument(String[], String) - Static method in class org.refcodes.cli.AbstractPropertyOption
Takes the Option's short-option and long-option and tries to determine that Option's value in the provided command line arguments.
toPropertyArgument(String[], CliContext) - Method in class org.refcodes.cli.AbstractPropertyOption
Takes the Option's short-option and long-option and tries to determine that Option's value in the provided command line arguments.
toResetEscapeCode() - Method in class org.refcodes.cli.CliContext
Constructs the reset escape code depending on the escape code status (as of CliContext.isEscapeCodesEnabled()) and whether the reset escape code is not null or null (as of CliContext.getResetEscapeCode()).
toRootMatchCause() - Method in exception org.refcodes.cli.ArgsSyntaxException
Determines the root cause of this exception with the same match count (ArgsSyntaxException.getMatchCount()) as this exception.
toSchema() - Method in class org.refcodes.cli.AbstractCondition
toSchema() - Method in class org.refcodes.cli.AbstractOperand
toSchema() - Method in class org.refcodes.cli.AbstractOption
toSchema() - Method in class org.refcodes.cli.ArrayOperand
toSchema() - Method in interface org.refcodes.cli.ParseArgs
toSchema() - Method in interface org.refcodes.cli.Term
toShortOption(Option<?>) - Method in class org.refcodes.cli.CliContext
Creates the CliContext instance specific prefixed short option String from the provided Option by prefixing the Option's short option (as of Option.getShortOption()) with the short option prefix (as of ShortOptionPrefixAccessor.getShortOptionPrefix()).
toSpec() - Method in interface org.refcodes.cli.Operand
Creates a specification for this Operand and its arguments.
toSpec(CliContext) - Method in interface org.refcodes.cli.Operand
Creates a specification for this Operand and its arguments.
toSpec(Operand<?>) - Method in class org.refcodes.cli.CliContext
Creates a specification for the given Operand and its arguments.
toString() - Method in class org.refcodes.cli.AbstractCondition
toString() - Method in class org.refcodes.cli.AbstractOperand
toString() - Method in class org.refcodes.cli.AbstractOption
toSynopsis() - Method in interface org.refcodes.cli.Synopsisable
Returns the human readable (verbose) syntax of implementing class ATTENTION: As of different parenthesis settings for some notations regarding the root Term and the child Terms, the method Term.toSyntax(CliContext) is called from inside a Term hierarchy.
toSynopsis(String, String, String) - Method in interface org.refcodes.cli.Synopsisable
Returns the human readable (verbose) syntax of implementing class ATTENTION: As of different parenthesis settings for some notations regarding the root Term and the child Terms, the method Term.toSyntax(CliContext) is called from inside a Term hierarchy.
toSynopsis(CliContext) - Method in class org.refcodes.cli.AllCondition
Returns the human readable (verbose) syntax of the implementing class ATTENTION: As of different parenthesis settings for some notations regarding the root Term and the child Terms, the method Term.toSyntax(CliContext) is called from inside a Term hierarchy.
toSynopsis(CliContext) - Method in class org.refcodes.cli.AndCondition
Returns the human readable (verbose) syntax of the implementing class ATTENTION: As of different parenthesis settings for some notations regarding the root Term and the child Terms, the method Term.toSyntax(CliContext) is called from inside a Term hierarchy.
toSynopsis(CliContext) - Method in class org.refcodes.cli.OrCondition
Returns the human readable (verbose) syntax of the implementing class ATTENTION: As of different parenthesis settings for some notations regarding the root Term and the child Terms, the method Term.toSyntax(CliContext) is called from inside a Term hierarchy.
toSynopsis(CliContext) - Method in interface org.refcodes.cli.Synopsisable
Returns the human readable (verbose) syntax of the implementing class ATTENTION: As of different parenthesis settings for some notations regarding the root Term and the child Terms, the method Term.toSyntax(CliContext) is called from inside a Term hierarchy.
toSynopsis(CliContext) - Method in interface org.refcodes.cli.Term
Returns the human readable (verbose) syntax of the implementing class ATTENTION: As of different parenthesis settings for some notations regarding the root Term and the child Terms, the method Term.toSyntax(CliContext) is called from inside a Term hierarchy.
toSynopsis(CliContext) - Method in class org.refcodes.cli.XorCondition
Returns the human readable (verbose) syntax of the implementing class ATTENTION: As of different parenthesis settings for some notations regarding the root Term and the child Terms, the method Term.toSyntax(CliContext) is called from inside a Term hierarchy.
toSynopsis(SyntaxNotation) - Method in interface org.refcodes.cli.Synopsisable
Returns the human readable (verbose) syntax of implementing class ATTENTION: As of different parenthesis settings for some notations regarding the root Term and the child Terms, the method Term.toSyntax(CliContext) is called from inside a Term hierarchy.
toSynopsis(SyntaxNotation, String, String, String) - Method in interface org.refcodes.cli.Synopsisable
Returns the human readable (verbose) syntax of implementing class ATTENTION: As of different parenthesis settings for some notations regarding the root Term and the child Terms, the method Term.toSyntax(CliContext) is called from inside a Term hierarchy.
toSyntax() - Method in interface org.refcodes.cli.Term
This method is to be called from inside the Term hierarchy; use the method Synopsisable.toSynopsis(SyntaxNotation) in case you invoke syntax retrieval from the root Term.
toSyntax(String, String, String) - Method in interface org.refcodes.cli.Term
This method is to be called from inside the Term hierarchy; use the method Synopsisable.toSynopsis(SyntaxNotation) in case you invoke syntax retrieval from the root Term.
toSyntax(CliContext) - Method in class org.refcodes.cli.AbstractCondition
This method is to be called from inside the Term hierarchy; use the method Synopsisable.toSynopsis(SyntaxNotation) in case you invoke syntax retrieval from the root Term.
toSyntax(CliContext) - Method in class org.refcodes.cli.AbstractOperand
This method is to be called from inside the Term hierarchy; use the method Synopsisable.toSynopsis(SyntaxNotation) in case you invoke syntax retrieval from the root Term.
toSyntax(CliContext) - Method in class org.refcodes.cli.AbstractOption
This method is to be called from inside the Term hierarchy; use the method Synopsisable.toSynopsis(SyntaxNotation) in case you invoke syntax retrieval from the root Term.
toSyntax(CliContext) - Method in class org.refcodes.cli.AbstractPropertyOption
This method is to be called from inside the Term hierarchy; use the method Synopsisable.toSynopsis(SyntaxNotation) in case you invoke syntax retrieval from the root Term.
toSyntax(CliContext) - Method in class org.refcodes.cli.AllCondition
This method is to be called from inside the Term hierarchy; use the method Synopsisable.toSynopsis(SyntaxNotation) in case you invoke syntax retrieval from the root Term.
toSyntax(CliContext) - Method in class org.refcodes.cli.AndCondition
This method is to be called from inside the Term hierarchy; use the method Synopsisable.toSynopsis(SyntaxNotation) in case you invoke syntax retrieval from the root Term.
toSyntax(CliContext) - Method in class org.refcodes.cli.AnyCondition
This method is to be called from inside the Term hierarchy; use the method Synopsisable.toSynopsis(SyntaxNotation) in case you invoke syntax retrieval from the root Term.
toSyntax(CliContext) - Method in class org.refcodes.cli.ArrayOperand
This method is to be called from inside the Term hierarchy; use the method Synopsisable.toSynopsis(SyntaxNotation) in case you invoke syntax retrieval from the root Term.
toSyntax(CliContext) - Method in class org.refcodes.cli.ArrayOption
This method is to be called from inside the Term hierarchy; use the method Synopsisable.toSynopsis(SyntaxNotation) in case you invoke syntax retrieval from the root Term.
toSyntax(CliContext) - Method in class org.refcodes.cli.Flag
This method is to be called from inside the Term hierarchy; use the method Synopsisable.toSynopsis(SyntaxNotation) in case you invoke syntax retrieval from the root Term.
toSyntax(CliContext) - Method in class org.refcodes.cli.NoneOperand
This method is to be called from inside the Term hierarchy; use the method Synopsisable.toSynopsis(SyntaxNotation) in case you invoke syntax retrieval from the root Term.
toSyntax(CliContext) - Method in class org.refcodes.cli.Operation
This method is to be called from inside the Term hierarchy; use the method Synopsisable.toSynopsis(SyntaxNotation) in case you invoke syntax retrieval from the root Term.
toSyntax(CliContext) - Method in interface org.refcodes.cli.Term
This method is to be called from inside the Term hierarchy; use the method Synopsisable.toSynopsis(SyntaxNotation) in case you invoke syntax retrieval from the root Term.
toSyntax(SyntaxNotation) - Method in interface org.refcodes.cli.Term
This method is to be called from inside the Term hierarchy; use the method Synopsisable.toSynopsis(SyntaxNotation) in case you invoke syntax retrieval from the root Term.
toSyntax(SyntaxNotation, String, String, String) - Method in interface org.refcodes.cli.Term
This method is to be called from inside the Term hierarchy; use the method Synopsisable.toSynopsis(SyntaxNotation) in case you invoke syntax retrieval from the root Term.
toSyntaxNotation(String) - Static method in enum class org.refcodes.cli.SyntaxNotation
Retrieves a SyntaxNotation depending on the given string, ignoring the case as well as being graceful regarding "-" and "_",.
toType(String) - Method in class org.refcodes.cli.AbstractOperand
Double dispatch hook to be implemented by subclasses of the AbstractOperand for converting a command line argument to the required Operand's type.
toType(String) - Method in class org.refcodes.cli.BooleanOption
Double dispatch hook to be implemented by subclasses of the AbstractOperand for converting a command line argument to the required Operand's type.
toType(String) - Method in class org.refcodes.cli.BooleanProperty
Double dispatch hook to be implemented by subclasses of the AbstractOperand for converting a command line argument to the required Operand's type.
toType(String) - Method in class org.refcodes.cli.CharOption
Double dispatch hook to be implemented by subclasses of the AbstractOperand for converting a command line argument to the required Operand's type.
toType(String) - Method in class org.refcodes.cli.CharProperty
Double dispatch hook to be implemented by subclasses of the AbstractOperand for converting a command line argument to the required Operand's type.
toType(String) - Method in class org.refcodes.cli.DoubleOption
Double dispatch hook to be implemented by subclasses of the AbstractOperand for converting a command line argument to the required Operand's type.
toType(String) - Method in class org.refcodes.cli.DoubleProperty
Double dispatch hook to be implemented by subclasses of the AbstractOperand for converting a command line argument to the required Operand's type.
toType(String) - Method in class org.refcodes.cli.EnumOption
Double dispatch hook to be implemented by subclasses of the AbstractOperand for converting a command line argument to the required Operand's type.
toType(String) - Method in class org.refcodes.cli.EnumProperty
Double dispatch hook to be implemented by subclasses of the AbstractOperand for converting a command line argument to the required Operand's type.
toType(String) - Method in class org.refcodes.cli.FileOption
Double dispatch hook to be implemented by subclasses of the AbstractOperand for converting a command line argument to the required Operand's type.
toType(String) - Method in class org.refcodes.cli.FileProperty
Double dispatch hook to be implemented by subclasses of the AbstractOperand for converting a command line argument to the required Operand's type.
toType(String) - Method in class org.refcodes.cli.Flag
Double dispatch hook to be implemented by subclasses of the AbstractOperand for converting a command line argument to the required Operand's type.
toType(String) - Method in class org.refcodes.cli.FloatOption
Double dispatch hook to be implemented by subclasses of the AbstractOperand for converting a command line argument to the required Operand's type.
toType(String) - Method in class org.refcodes.cli.FloatProperty
Double dispatch hook to be implemented by subclasses of the AbstractOperand for converting a command line argument to the required Operand's type.
toType(String) - Method in class org.refcodes.cli.IntOption
Double dispatch hook to be implemented by subclasses of the AbstractOperand for converting a command line argument to the required Operand's type.
toType(String) - Method in class org.refcodes.cli.IntProperty
Double dispatch hook to be implemented by subclasses of the AbstractOperand for converting a command line argument to the required Operand's type.
toType(String) - Method in class org.refcodes.cli.LongOption
Double dispatch hook to be implemented by subclasses of the AbstractOperand for converting a command line argument to the required Operand's type.
toType(String) - Method in class org.refcodes.cli.LongProperty
Double dispatch hook to be implemented by subclasses of the AbstractOperand for converting a command line argument to the required Operand's type.
toType(String) - Method in class org.refcodes.cli.NoneOperand
To value.
toType(String) - Method in class org.refcodes.cli.Operation
Double dispatch hook to be implemented by subclasses of the AbstractOperand for converting a command line argument to the required Operand's type.
toType(String) - Method in class org.refcodes.cli.StringOperand
To value.
toType(String) - Method in class org.refcodes.cli.StringOption
Double dispatch hook to be implemented by subclasses of the AbstractOperand for converting a command line argument to the required Operand's type.
toType(String) - Method in class org.refcodes.cli.StringProperty
Double dispatch hook to be implemented by subclasses of the AbstractOperand for converting a command line argument to the required Operand's type.
toUsage() - Method in interface org.refcodes.cli.Operand
Creates a specification for this Operand, helpful e.g. in human readable messages.
toUsage(CliContext) - Method in class org.refcodes.cli.AbstractPropertyOption
Creates a specification for this Operand, helpful e.g. in human readable messages.
toUsage(CliContext) - Method in interface org.refcodes.cli.Operand
Creates a specification for this Operand, helpful e.g. in human readable messages.
toUsage(Operand<?>) - Method in class org.refcodes.cli.CliContext
Creates a specification for the given Operand and its arguments.
toValue(String) - Method in class org.refcodes.cli.AbstractCondition
Searches for a value being set for the given for given alias in the syntax tree parsing the command line arguments; if a node in the syntax tree has a value for the given alias, then this value is returned.
toValue(String) - Method in interface org.refcodes.cli.Operand
Searches for a value being set for the given for given alias in the syntax tree parsing the command line arguments; if a node in the syntax tree has a value for the given alias, then this value is returned.
toValue(String) - Method in interface org.refcodes.cli.Term
Searches for a value being set for the given for given alias in the syntax tree parsing the command line arguments; if a node in the syntax tree has a value for the given alias, then this value is returned.

U

UnknownArgsException - Exception in org.refcodes.cli
Thrown in case command line arguments were not processed (did not match the expected arguments), e.g. the arguments were rejected as them did not work for the according syntax.
UnknownArgsException(String[], Throwable) - Constructor for exception org.refcodes.cli.UnknownArgsException
UnknownArgsException(String[], Throwable, String) - Constructor for exception org.refcodes.cli.UnknownArgsException
UnknownArgsException(String[], Term, Throwable) - Constructor for exception org.refcodes.cli.UnknownArgsException
UnknownArgsException(String[], Term, Throwable, String) - Constructor for exception org.refcodes.cli.UnknownArgsException
UnknownArgsException(String, String[]) - Constructor for exception org.refcodes.cli.UnknownArgsException
UnknownArgsException(String, String[], String) - Constructor for exception org.refcodes.cli.UnknownArgsException
UnknownArgsException(String, String[], Throwable) - Constructor for exception org.refcodes.cli.UnknownArgsException
UnknownArgsException(String, String[], Throwable, String) - Constructor for exception org.refcodes.cli.UnknownArgsException
UnknownArgsException(String, String[], Term) - Constructor for exception org.refcodes.cli.UnknownArgsException
UnknownArgsException(String, String[], Term, String) - Constructor for exception org.refcodes.cli.UnknownArgsException
UnknownArgsException(String, String[], Term, Throwable) - Constructor for exception org.refcodes.cli.UnknownArgsException
UnknownArgsException(String, String[], Term, Throwable, String) - Constructor for exception org.refcodes.cli.UnknownArgsException
UnknownOptionArgsException - Exception in org.refcodes.cli
Thrown in case command line arguments were not processed (did not match the expected arguments) by an Option (having a short- and/or a long-option), e.g. the arguments were rejected as them did not work for the according syntax.
UnknownOptionArgsException(String, String[], String, String) - Constructor for exception org.refcodes.cli.UnknownOptionArgsException
UnknownOptionArgsException(String, String[], String, String, String) - Constructor for exception org.refcodes.cli.UnknownOptionArgsException
UnknownOptionArgsException(String, String[], String, String, Throwable) - Constructor for exception org.refcodes.cli.UnknownOptionArgsException
UnknownOptionArgsException(String, String[], String, String, Throwable, String) - Constructor for exception org.refcodes.cli.UnknownOptionArgsException
UnknownOptionArgsException(String, String[], String, String, Throwable, Term) - Constructor for exception org.refcodes.cli.UnknownOptionArgsException
UnknownOptionArgsException(String, String[], String, String, Throwable, Term, String) - Constructor for exception org.refcodes.cli.UnknownOptionArgsException
UnknownOptionArgsException(String, String[], String, String, Term) - Constructor for exception org.refcodes.cli.UnknownOptionArgsException
UnknownOptionArgsException(String, String[], String, String, Term, String) - Constructor for exception org.refcodes.cli.UnknownOptionArgsException
UnknownOptionArgsException(String, String, String[], Throwable) - Constructor for exception org.refcodes.cli.UnknownOptionArgsException
UnknownOptionArgsException(String, String, String[], Throwable, String) - Constructor for exception org.refcodes.cli.UnknownOptionArgsException
UnknownOptionArgsException(String, String, String[], Throwable, Term) - Constructor for exception org.refcodes.cli.UnknownOptionArgsException
UnknownOptionArgsException(String, String, String[], Throwable, Term, String) - Constructor for exception org.refcodes.cli.UnknownOptionArgsException

V

valueOf(String) - Static method in enum class org.refcodes.cli.ArgsFilter
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class org.refcodes.cli.SyntaxNotation
Returns the enum constant of this class with the specified name.
values() - Static method in enum class org.refcodes.cli.ArgsFilter
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class org.refcodes.cli.SyntaxNotation
Returns an array containing the constants of this enum class, in the order they are declared.
VERBOSE - Enum constant in enum class org.refcodes.cli.SyntaxNotation
A verbose notation using words instead of single character symbols.
verboseFlag() - Static method in class org.refcodes.cli.CliSugar
Constructs the predefined verbose Flag.
verboseFlag(boolean) - Static method in class org.refcodes.cli.CliSugar
Constructs the predefined verbose Flag.
verboseFlag(String) - Static method in class org.refcodes.cli.CliSugar
Constructs the predefined verbose Flag.
VerboseFlag - Class in org.refcodes.cli
A predefined verbose Flag: A predefined Flag gives its VerboseFlag.SHORT_OPTION, its VerboseFlag.LONG_OPTION as well as its VerboseFlag.ALIAS an according semantics regarded by other subsystems.
VerboseFlag() - Constructor for class org.refcodes.cli.VerboseFlag
Constructs the predefined verbose Flag.
VerboseFlag(boolean) - Constructor for class org.refcodes.cli.VerboseFlag
Constructs the predefined verbose Flag.
VerboseFlag(String) - Constructor for class org.refcodes.cli.VerboseFlag
Constructs the predefined verbose Flag.
VerboseFlag(String, boolean) - Constructor for class org.refcodes.cli.VerboseFlag
Constructs the predefined clean Flag.

W

WINDOWS - Enum constant in enum class org.refcodes.cli.SyntaxNotation
A notation which tries to mimic CMD's notation and in case of lack of CMD notation conventions, the SyntaxNotation.GNU_POSIX equivalent is used.
withAddExample(String, Operand<?>...) - Method in class org.refcodes.cli.ArgsParser
Builder method adding an application's Example element.
withAddExample(String, Operand<?>...) - Method in interface org.refcodes.cli.ArgsProcessorBuilder
Builder method adding an application's Example element.
withAddExample(String, Operand<?>...) - Method in interface org.refcodes.cli.ParseArgs
Builder method adding an application's Example element.
withAddExample(Example) - Method in class org.refcodes.cli.ArgsParser
Builder method adding an application's Example element.
withAddExample(Example) - Method in interface org.refcodes.cli.ArgsProcessorBuilder
Builder method adding an application's Example element.
withAddExample(Example) - Method in interface org.refcodes.cli.ParseArgs
Builder method adding an application's Example element.
withAllSymbol(String) - Method in class org.refcodes.cli.SyntaxMetricsImpl.Builder
Sets the symbol for representing an ALL notation.
withAndSymbol(String) - Method in class org.refcodes.cli.SyntaxMetricsImpl.Builder
Sets the symbol for representing an AND notation.
withAnySymbol(String) - Method in class org.refcodes.cli.SyntaxMetricsImpl.Builder
Sets the symbol for representing an ANY notation.
withArgs(String[]) - Method in interface org.refcodes.cli.ArgsProvidierBuilder
Builder method providing the application's command line arguments.
withArgs(String[], Pattern) - Method in interface org.refcodes.cli.ArgsProvidierBuilder
Builder method providing the application's command line arguments, filtering (excluding) the arguments matching the provided Pattern.
withArgs(String[], ArgsFilter) - Method in interface org.refcodes.cli.ArgsProvidierBuilder
Builder method providing the application's command line arguments, filtering (excluding) the arguments matching the provided ArgsFilter.
withArgs(List<String>) - Method in interface org.refcodes.cli.ArgsProvidierBuilder
Builder method providing the application's command line arguments.
withArgs(List<String>, Pattern) - Method in interface org.refcodes.cli.ArgsProvidierBuilder
Builder method providing the application's command line arguments, filtering (excluding) the arguments matching the provided Pattern.
withArgs(List<String>, ArgsFilter) - Method in interface org.refcodes.cli.ArgsProvidierBuilder
Builder method providing the application's command line arguments, filtering (excluding) the arguments matching the provided ArgsFilter.
withArgsParser(ParseArgs) - Method in interface org.refcodes.cli.ArgsParserAccessor.ArgsParserBuilder
Sets the args-parser for the ParseArgs property.
withArgsSyntax(Term) - Method in class org.refcodes.cli.ArgsParser
Sets the (root) Term for the (root) Term property.
withArgsSyntax(Term) - Method in interface org.refcodes.cli.ArgsSyntaxAccessor.ArgsSyntaxBuilder
Sets the (root) Term for the (root) Term property.
withArgumentEscapeCode(String) - Method in class org.refcodes.cli.ArgsParser
Sets the argument Escape-Code for the argument Escape-Code property.
withArgumentEscapeCode(String) - Method in interface org.refcodes.cli.ArgumentEscapeCodeAccessor.ArgumentEscapeCodeBuilder
Sets the argument Escape-Code for the argument Escape-Code property.
withArgumentEscapeCode(String) - Method in class org.refcodes.cli.CliContext.Builder
Sets the argument Escape-Code for the argument Escape-Code property.
withArgumentEscapeCode(String) - Method in interface org.refcodes.cli.ParseArgs
Sets the argument Escape-Code for the argument Escape-Code property.
withArgumentPrefix(String) - Method in interface org.refcodes.cli.ArgumentPrefixAccessor.ArgumentPrefixBuilder
Sets the argument prefix for the argument prefix property.
withArgumentPrefix(String) - Method in class org.refcodes.cli.SyntaxMetricsImpl.Builder
Sets the argument prefix for the argument prefix property.
withArgumentSuffix(String) - Method in interface org.refcodes.cli.ArgumentSuffixAccessor.ArgumentSuffixBuilder
Sets the argument suffix for the argument suffix property.
withArgumentSuffix(String) - Method in class org.refcodes.cli.SyntaxMetricsImpl.Builder
Sets the argument suffix for the argument suffix property.
withBannerBorderEscapeCode(String) - Method in class org.refcodes.cli.ArgsParser
Sets the banner border Escape-Code for the banner border Escape-Code property.
withBannerBorderEscapeCode(String) - Method in interface org.refcodes.cli.BannerBorderEscapeCodeAccessor.BannerBorderEscapeCodeBuilder
Sets the banner border Escape-Code for the banner border Escape-Code property.
withBannerBorderEscapeCode(String) - Method in interface org.refcodes.cli.ParseArgs
Sets the banner border Escape-Code for the banner border Escape-Code property.
withBannerEscapeCode(String) - Method in class org.refcodes.cli.ArgsParser
Sets the banner Escape-Code for the banner Escape-Code property.
withBannerEscapeCode(String) - Method in interface org.refcodes.cli.BannerEscapeCodeAccessor.BannerEscapeCodeBuilder
Sets the banner Escape-Code for the banner Escape-Code property.
withBannerEscapeCode(String) - Method in interface org.refcodes.cli.ParseArgs
Sets the banner Escape-Code for the banner Escape-Code property.
withBannerFont(Font) - Method in class org.refcodes.cli.ArgsParser
Sets the banner Font for the banner Font property.
withBannerFont(Font) - Method in interface org.refcodes.cli.BannerFontAccessor.BannerFontBuilder
Sets the banner Font for the banner Font property.
withBannerFont(Font) - Method in interface org.refcodes.cli.ParseArgs
Sets the banner Font for the banner Font property.
withBannerFontPalette(char[]) - Method in class org.refcodes.cli.ArgsParser
Sets the banner font palette for the banner font palette property.
withBannerFontPalette(char[]) - Method in interface org.refcodes.cli.BannerFontPaletteAccessor.BannerFontPaletteBuilder
Sets the banner font palette for the banner font palette property.
withBannerFontPalette(char[]) - Method in interface org.refcodes.cli.ParseArgs
Sets the banner font palette for the banner font palette property.
withBannerFontPalette(AsciiColorPalette) - Method in class org.refcodes.cli.ArgsParser
Sets the banner font palette for the banner font palette property.
withBannerFontPalette(AsciiColorPalette) - Method in interface org.refcodes.cli.BannerFontPaletteAccessor.BannerFontPaletteBuilder
Sets the banner font palette for the banner font palette property.
withBeginArraySymbol(String) - Method in class org.refcodes.cli.SyntaxMetricsImpl.Builder
Sets the symbol representing the beginning of an array, e.g. an opening square brace.
withBeginListSymbol(String) - Method in class org.refcodes.cli.SyntaxMetricsImpl.Builder
Sets the symbol representing the beginning of a list, e.g. an opening brace.
withBeginOptionalSymbol(String) - Method in class org.refcodes.cli.SyntaxMetricsImpl.Builder
Sets the symbol representing the beginning optional elements, e.g. an opening square brace.
withBeginRangeSymbol(String) - Method in class org.refcodes.cli.SyntaxMetricsImpl.Builder
Sets the symbol representing the beginning of a range, e.g. an opening square brace.
withCliContext(CliContext) - Method in interface org.refcodes.cli.CliContextAccessor.CliContextBuilder
Sets the CliContext for the CliContext property.
withCommandEscapeCode(String) - Method in class org.refcodes.cli.ArgsParser
Sets the command Escape-Code for the command Escape-Code property.
withCommandEscapeCode(String) - Method in interface org.refcodes.cli.CommandEscapeCodeAccessor.CommandEscapeCodeBuilder
Sets the command Escape-Code for the command Escape-Code property.
withCommandEscapeCode(String) - Method in interface org.refcodes.cli.ParseArgs
Sets the command Escape-Code for the command Escape-Code property.
withConsoleWidth(int) - Method in class org.refcodes.cli.ArgsParser
withConsoleWidth(int) - Method in interface org.refcodes.cli.ParseArgs
withCopyright(String) - Method in class org.refcodes.cli.ArgsParser
Sets the copyright for the copyright property.
withCopyright(String) - Method in interface org.refcodes.cli.CopyrightAccessor.CopyrightBuilder
Sets the copyright for the copyright property.
withCopyright(String) - Method in interface org.refcodes.cli.ParseArgs
Sets the copyright for the copyright property.
withDescription(String) - Method in class org.refcodes.cli.ArgsParser
withDescription(String) - Method in interface org.refcodes.cli.ParseArgs
withDescriptionEscapeCode(String) - Method in class org.refcodes.cli.ArgsParser
Sets the description Escape-Code for the description Escape-Code property.
withDescriptionEscapeCode(String) - Method in interface org.refcodes.cli.DescriptionEscapeCodeAccessor.DescriptionEscapeCodeBuilder
Sets the description Escape-Code for the description Escape-Code property.
withDescriptionEscapeCode(String) - Method in interface org.refcodes.cli.ParseArgs
Sets the description Escape-Code for the description Escape-Code property.
withEMptySymbol(String) - Method in class org.refcodes.cli.SyntaxMetricsImpl.Builder
Sets the symbol for representing an EMPTY notation.
withEndArraySymbol(String) - Method in class org.refcodes.cli.SyntaxMetricsImpl.Builder
Sets the symbol representing the end of an array, e.g. a closing square brace.
withEndListSymbol(String) - Method in class org.refcodes.cli.SyntaxMetricsImpl.Builder
Sets the symbol representing the end of a list, e.g. a closing brace.
withEndOptionalSymbol(String) - Method in class org.refcodes.cli.SyntaxMetricsImpl.Builder
Sets the symbol representing the end of optional elements, e.g. a closing square brace.
withEndRangeSymbol(String) - Method in class org.refcodes.cli.SyntaxMetricsImpl.Builder
Sets the symbol representing the end of a range, e.g. a closing square brace.
withErrorOut(PrintStream) - Method in class org.refcodes.cli.ArgsParser
Set the error out PrintStream and make other adjustments with the result (with regards to the Builder-Pattern).
withErrorOut(PrintStream) - Method in interface org.refcodes.cli.ArgsProcessorBuilder
Set the error out PrintStream and make other adjustments with the result (with regards to the Builder-Pattern).
withErrorOut(PrintStream) - Method in interface org.refcodes.cli.ParseArgs
Set the error out PrintStream and make other adjustments with the result (with regards to the Builder-Pattern).
withEscapeCodesEnabled(boolean) - Method in class org.refcodes.cli.ArgsParser
withEscapeCodesEnabled(boolean) - Method in class org.refcodes.cli.CliContext.Builder
withEscapeCodesEnabled(boolean) - Method in interface org.refcodes.cli.ParseArgs
withEvalArgs(String[]) - Method in class org.refcodes.cli.ArgsParser
Evaluates the provided command line arguments.
withEvalArgs(String[]) - Method in interface org.refcodes.cli.ArgsParserBuilder
Evaluates the provided command line arguments.
withEvalArgs(String[]) - Method in interface org.refcodes.cli.ParseArgs
Evaluates the provided command line arguments.
withEvalArgs(String[], Pattern) - Method in class org.refcodes.cli.ArgsParser
Evaluates the provided command line arguments, filtering (excluding) the arguments matching the provided Pattern.
withEvalArgs(String[], Pattern) - Method in interface org.refcodes.cli.ArgsParserBuilder
Evaluates the provided command line arguments, filtering (excluding) the arguments matching the provided Pattern.
withEvalArgs(String[], ArgsFilter) - Method in class org.refcodes.cli.ArgsParser
Evaluates the provided command line arguments, filtering (excluding) the arguments matching the provided ArgsFilter.
withEvalArgs(String[], ArgsFilter) - Method in interface org.refcodes.cli.ArgsParserBuilder
Evaluates the provided command line arguments, filtering (excluding) the arguments matching the provided ArgsFilter.
withEvalArgs(List<String>) - Method in class org.refcodes.cli.ArgsParser
Evaluates the provided command line arguments .
withEvalArgs(List<String>) - Method in interface org.refcodes.cli.ArgsParserBuilder
Evaluates the provided command line arguments .
withEvalArgs(List<String>) - Method in interface org.refcodes.cli.ParseArgs
Evaluates the provided command line arguments .
withEvalArgs(List<String>, Pattern) - Method in class org.refcodes.cli.ArgsParser
Evaluates the provided command line arguments, filtering (excluding) the arguments matching the provided Pattern.
withEvalArgs(List<String>, Pattern) - Method in interface org.refcodes.cli.ArgsParserBuilder
Evaluates the provided command line arguments, filtering (excluding) the arguments matching the provided Pattern.
withEvalArgs(List<String>, ArgsFilter) - Method in class org.refcodes.cli.ArgsParser
Evaluates the provided command line arguments, filtering (excluding) the arguments matching the provided ArgsFilter.
withEvalArgs(List<String>, ArgsFilter) - Method in interface org.refcodes.cli.ArgsParserBuilder
Evaluates the provided command line arguments, filtering (excluding) the arguments matching the provided ArgsFilter.
withExamples(Collection<Example>) - Method in class org.refcodes.cli.ArgsParser
Builder method providing the application's Example elements.
withExamples(Collection<Example>) - Method in interface org.refcodes.cli.ExamplesAccessor.ExamplesBuilder
Builder method providing the application's Example elements.
withExamples(Collection<Example>) - Method in interface org.refcodes.cli.ParseArgs
Builder method providing the application's Example elements.
withExamples(Example[]) - Method in class org.refcodes.cli.ArgsParser
Sets the Example instances for the Example instances property.
withExamples(Example[]) - Method in interface org.refcodes.cli.ExamplesAccessor.ExamplesBuilder
Sets the Example instances for the Example instances property.
withExamples(Example[]) - Method in interface org.refcodes.cli.ParseArgs
Sets the Example instances for the Example instances property.
withIntervalSymbol(String) - Method in class org.refcodes.cli.SyntaxMetricsImpl.Builder
Sets the symbol representing an interval, e.g. "..." or "-".
withLicense(String) - Method in class org.refcodes.cli.ArgsParser
Sets the license for the license property.
withLicense(String) - Method in interface org.refcodes.cli.LicenseAccessor.LicenseBuilder
Sets the license for the license property.
withLicense(String) - Method in interface org.refcodes.cli.ParseArgs
Sets the license for the license property.
withLineBreak(String) - Method in class org.refcodes.cli.ArgsParser
withLineBreak(String) - Method in interface org.refcodes.cli.ParseArgs
withLineSeparatorEscapeCode(String) - Method in class org.refcodes.cli.ArgsParser
Sets the line separator Escape-Code for the line separator Escape-Code property.
withLineSeparatorEscapeCode(String) - Method in interface org.refcodes.cli.LineSeparatorEscapeCodeAccessor.LineSeparatorEscapeCodeBuilder
Sets the line separator Escape-Code for the line separator Escape-Code property.
withLineSeparatorEscapeCode(String) - Method in interface org.refcodes.cli.ParseArgs
Sets the line separator Escape-Code for the line separator Escape-Code property.
withLongOption(String) - Method in interface org.refcodes.cli.LongOptionAccessor.LongOptionBuilder
Sets the long option for the long option property.
withLongOptionPrefix(String) - Method in class org.refcodes.cli.ArgsParser
Sets the long option prefix for the long option prefix property.
withLongOptionPrefix(String) - Method in interface org.refcodes.cli.LongOptionPrefixAccessor.LongOptionPrefixBuilder
Sets the long option prefix for the long option prefix property.
withLongOptionPrefix(String) - Method in interface org.refcodes.cli.ParseArgs
Sets the long option prefix for the long option prefix property.
withLongOptionPrefix(String) - Method in class org.refcodes.cli.SyntaxMetricsImpl.Builder
Sets the long option prefix for the long option prefix property.
withLongPropertyPrefix(String) - Method in interface org.refcodes.cli.LongPropertyPrefixAccessor.LongPropertyPrefixBuilder
Sets the long option prefix for the long option prefix property.
withMatchCount(int) - Method in interface org.refcodes.cli.MatchCountAccessor.MatchCountBuilder
Sets the match-count for the match-count property.
withMaxConsoleWidth(int) - Method in class org.refcodes.cli.ArgsParser
withMaxConsoleWidth(int) - Method in interface org.refcodes.cli.ParseArgs
withName(String) - Method in class org.refcodes.cli.ArgsParser
withName(String) - Method in interface org.refcodes.cli.ParseArgs
withOptionEscapeCode(String) - Method in class org.refcodes.cli.ArgsParser
Sets the option Escape-Code for the option Escape-Code property.
withOptionEscapeCode(String) - Method in class org.refcodes.cli.CliContext.Builder
Sets the option Escape-Code for the option Escape-Code property.
withOptionEscapeCode(String) - Method in interface org.refcodes.cli.OptionEscapeCodeAccessor.OptionEscapeCodeBuilder
Sets the option Escape-Code for the option Escape-Code property.
withOptionEscapeCode(String) - Method in interface org.refcodes.cli.ParseArgs
Sets the option Escape-Code for the option Escape-Code property.
withOrSymbol(String) - Method in class org.refcodes.cli.SyntaxMetricsImpl.Builder
Sets the symbol for representing an OR notation.
withPropertyEscapeCode(String) - Method in interface org.refcodes.cli.PropertyEscapeCodeAccessor.PropertyEscapeCodeBuilder
Sets the option Escape-Code for the option Escape-Code property.
withResetEscapeCode(String) - Method in class org.refcodes.cli.ArgsParser
withResetEscapeCode(String) - Method in class org.refcodes.cli.CliContext.Builder
withResetEscapeCode(String) - Method in interface org.refcodes.cli.ParseArgs
withSeparatorLnChar(char) - Method in class org.refcodes.cli.ArgsParser
Builder method adding an separator line char.
withSeparatorLnChar(char) - Method in interface org.refcodes.cli.ArgsProcessorBuilder
Builder method adding an separator line char.
withSeparatorLnChar(char) - Method in interface org.refcodes.cli.ParseArgs
Builder method adding an separator line char.
withShortOption(String) - Method in interface org.refcodes.cli.ShortOptionAccessor.ShortOptionBuilder
Sets the short option for the short option property.
withShortOptionPrefix(Character) - Method in class org.refcodes.cli.ArgsParser
Sets the short option prefix for the short option prefix property.
withShortOptionPrefix(Character) - Method in interface org.refcodes.cli.ParseArgs
Sets the short option prefix for the short option prefix property.
withShortOptionPrefix(Character) - Method in interface org.refcodes.cli.ShortOptionPrefixAccessor.ShortOptionPrefixBuilder
Sets the short option prefix for the short option prefix property.
withShortOptionPrefix(Character) - Method in class org.refcodes.cli.SyntaxMetricsImpl.Builder
Sets the short option prefix for the short option prefix property.
withShortPropertyPrefix(Character) - Method in interface org.refcodes.cli.ShortPropertyPrefixAccessor.ShortPropertyPrefixBuilder
Sets the short option prefix for the short option prefix property.
withStandardOut(PrintStream) - Method in class org.refcodes.cli.ArgsParser
Set the standard out PrintStream and make other adjustments with the result (with regards to the Builder-Pattern).
withStandardOut(PrintStream) - Method in interface org.refcodes.cli.ArgsProcessorBuilder
Set the standard out PrintStream and make other adjustments with the result (with regards to the Builder-Pattern).
withStandardOut(PrintStream) - Method in interface org.refcodes.cli.ParseArgs
Set the standard out PrintStream and make other adjustments with the result (with regards to the Builder-Pattern).
withSyntaxMetrics(SyntaxMetrics) - Method in class org.refcodes.cli.ArgsParser
Sets the SyntaxMetrics for the SyntaxMetrics property.
withSyntaxMetrics(SyntaxMetrics) - Method in class org.refcodes.cli.CliContext.Builder
Sets the SyntaxMetrics for the SyntaxMetrics property.
withSyntaxMetrics(SyntaxMetrics) - Method in interface org.refcodes.cli.ParseArgs
Sets the SyntaxMetrics for the SyntaxMetrics property.
withSyntaxMetrics(SyntaxMetrics) - Method in interface org.refcodes.cli.SyntaxMetricsAccessor.SyntaxMetricsBuilder
Sets the SyntaxMetrics for the SyntaxMetrics property.
withSyntaxMetrics(SyntaxNotation) - Method in class org.refcodes.cli.ArgsParser
Sets the SyntaxNotation for the SyntaxNotation property.
withSyntaxMetrics(SyntaxNotation) - Method in interface org.refcodes.cli.SyntaxMetricsAccessor.SyntaxMetricsBuilder
Sets the SyntaxNotation for the SyntaxNotation property.
withTextBoxGrid(TextBoxGrid) - Method in class org.refcodes.cli.ArgsParser
withTextBoxGrid(TextBoxGrid) - Method in interface org.refcodes.cli.ParseArgs
withTextBoxGrid(TextBoxStyle) - Method in class org.refcodes.cli.ArgsParser
withTextBoxGrid(TextBoxStyle) - Method in interface org.refcodes.cli.ParseArgs
withTitle(String) - Method in class org.refcodes.cli.ArgsParser
withTitle(String) - Method in interface org.refcodes.cli.ParseArgs
withXorSymbol(String) - Method in class org.refcodes.cli.SyntaxMetricsImpl.Builder
Sets the symbol for representing an XOR notation.

X

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

_

_args - Variable in exception org.refcodes.cli.CliException.CliArgsException
 
_children - Variable in class org.refcodes.cli.AbstractCondition
 
_description - Variable in class org.refcodes.cli.AbstractCondition
 
_errStream - Variable in class org.refcodes.cli.ArgsParser
 
_exception - Variable in class org.refcodes.cli.AbstractCondition
 
_matchCount - Variable in class org.refcodes.cli.AbstractOperand
 
_matchCount - Variable in exception org.refcodes.cli.ArgsSyntaxException
 
_source - Variable in exception org.refcodes.cli.ArgsSyntaxException
 
_stdStream - Variable in class org.refcodes.cli.ArgsParser
 
A B C D E F G H I L M N O P Q R S T U V W X _ 
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form