Index
All Classes and Interfaces|All Packages
A
- ArgsParserProperties - Class in org.refcodes.properties.ext.cli
-
The
ArgsParserProperties
class implements theParseArgsProperties
type to combine theParseArgs
type with theProperties
type in a dedicated class. - ArgsParserProperties() - Constructor for class org.refcodes.properties.ext.cli.ArgsParserProperties
-
Constructs the
ParseArgsProperties
instance with no syntax notation (no rootCondition
). - ArgsParserProperties(String[]) - Constructor for class org.refcodes.properties.ext.cli.ArgsParserProperties
-
Constructs the
ParseArgsProperties
instance with the given arguments and the defaultSyntaxNotation.LOGICAL
. - ArgsParserProperties(String[], CliContext) - Constructor for class org.refcodes.properties.ext.cli.ArgsParserProperties
-
Constructs the
ParseArgsProperties
instance with the given arguments and the defaultSyntaxNotation.LOGICAL
. - ArgsParserProperties(String[], Condition) - Constructor for class org.refcodes.properties.ext.cli.ArgsParserProperties
-
Constructs the
ParseArgsProperties
instance with the given rootCondition
and the defaultSyntaxNotation.LOGICAL
. - ArgsParserProperties(String[], Condition, CliContext) - Constructor for class org.refcodes.properties.ext.cli.ArgsParserProperties
-
Constructs the
ParseArgsProperties
instance with the given rootCondition
and the defaultSyntaxNotation.LOGICAL
. - ArgsParserProperties(String[], Option<?>) - Constructor for class org.refcodes.properties.ext.cli.ArgsParserProperties
-
Constructs the
ParseArgsProperties
instance with the given rootOption
and the defaultSyntaxNotation.LOGICAL
. - ArgsParserProperties(String[], Option<?>, CliContext) - Constructor for class org.refcodes.properties.ext.cli.ArgsParserProperties
-
Constructs the
ParseArgsProperties
instance with the given rootOption
and the defaultSyntaxNotation.LOGICAL
. - ArgsParserProperties(CliContext) - Constructor for class org.refcodes.properties.ext.cli.ArgsParserProperties
-
Constructs the
ParseArgsProperties
instance with no syntax notation (no rootCondition
). - ArgsParserProperties(Term) - Constructor for class org.refcodes.properties.ext.cli.ArgsParserProperties
-
Constructs the
ParseArgsProperties
instance with the given rootTerm
and the defaultSyntaxNotation.LOGICAL
. - ArgsParserProperties(Term, CliContext) - Constructor for class org.refcodes.properties.ext.cli.ArgsParserProperties
-
Constructs the
ParseArgsProperties
instance with the given rootTerm
and the defaultSyntaxNotation.LOGICAL
. - ArgsParserPropertiesAccessor - Interface in org.refcodes.properties.ext.cli
-
Provides an accessor for a
ParseArgsProperties
property. - ArgsParserPropertiesAccessor.ArgsParserPropertiesBuilder<B extends ArgsParserPropertiesAccessor.ArgsParserPropertiesBuilder<B>> - Interface in org.refcodes.properties.ext.cli
-
Provides a builder method for a
ParseArgsProperties
property returning the builder for applying multiple build operations. - ArgsParserPropertiesAccessor.ArgsParserPropertiesMutator - Interface in org.refcodes.properties.ext.cli
-
Provides a mutator for a
ParseArgsProperties
property. - ArgsParserPropertiesAccessor.ArgsParserPropertiesProperty - Interface in org.refcodes.properties.ext.cli
-
Provides a
ParseArgsProperties
property.
C
- containsKey(Object) - Method in class org.refcodes.properties.ext.cli.ArgsParserProperties
E
- evalArgs(String[]) - Method in class org.refcodes.properties.ext.cli.ArgsParserProperties
-
Evaluates the command line arguments and sets the identified properties in this
Properties
instance. - evalArgs(String[]) - Method in interface org.refcodes.properties.ext.cli.ParseArgsProperties
-
Evaluates the command line arguments and sets the identified properties in this
Properties
instance. - evalArgs(String, String[]) - Method in class org.refcodes.properties.ext.cli.ArgsParserProperties
-
Same as
evalArgs(String[])
with the difference that the identified properties are inserted below the provided path. - evalArgs(String, String[]) - Method in interface org.refcodes.properties.ext.cli.ParseArgsProperties
-
Same as
evalArgs(String[])
with the difference that the identified properties are inserted below the provided path. - evalArgs(String, List<String>) - Method in class org.refcodes.properties.ext.cli.ArgsParserProperties
-
Same as
evalArgs(String[])
with the difference that the identified properties are inserted below the provided path. - evalArgs(String, List<String>) - Method in interface org.refcodes.properties.ext.cli.ParseArgsProperties
-
Same as
evalArgs(String[])
with the difference that the identified properties are inserted below the provided path. - evalArgs(List<String>) - Method in class org.refcodes.properties.ext.cli.ArgsParserProperties
-
Evaluates the command line arguments and sets the identified properties in this
Properties
instance. - evalArgs(List<String>) - Method in interface org.refcodes.properties.ext.cli.ParseArgsProperties
-
Evaluates the command line arguments and sets the identified properties in this
Properties
instance.
G
- get(Object) - Method in class org.refcodes.properties.ext.cli.ArgsParserProperties
- getAnnotator() - Method in class org.refcodes.properties.ext.cli.ArgsParserProperties
- getArgsParserProperties() - Method in interface org.refcodes.properties.ext.cli.ArgsParserPropertiesAccessor
-
Retrieves the args-properties from the
ParseArgsProperties
property. - getDelimiter() - Method in class org.refcodes.properties.ext.cli.ArgsParserProperties
I
- isEmpty() - Method in class org.refcodes.properties.ext.cli.ArgsParserProperties
K
- keySet() - Method in class org.refcodes.properties.ext.cli.ArgsParserProperties
L
- letArgsParserProperties(ParseArgsProperties) - Method in interface org.refcodes.properties.ext.cli.ArgsParserPropertiesAccessor.ArgsParserPropertiesProperty
-
This method stores and passes through the given argument, which is very useful for builder APIs: Sets the given
ParseArgsProperties
(setter) as ofArgsParserPropertiesAccessor.ArgsParserPropertiesMutator.setArgsParserProperties(ParseArgsProperties)
and returns the very same value (getter).
O
- org.refcodes.properties.ext.cli - module org.refcodes.properties.ext.cli
- org.refcodes.properties.ext.cli - package org.refcodes.properties.ext.cli
-
This artifact extends the refcodes-properties toolkit with functionality from the refcodes-cli toolkit, integrating command line arguments into the ArgsParserProperties sub-type of the Properties type.
P
- ParseArgsProperties - Interface in org.refcodes.properties.ext.cli
-
The
ParseArgsProperties
representProperties
generated from command line arguments being parsed by a command line syntax as of the definition for theParseArgs
.
R
- retrieveFrom(String) - Method in class org.refcodes.properties.ext.cli.ArgsParserProperties
- retrieveTo(String) - Method in class org.refcodes.properties.ext.cli.ArgsParserProperties
S
- setArgsParserProperties(ParseArgsProperties) - Method in interface org.refcodes.properties.ext.cli.ArgsParserPropertiesAccessor.ArgsParserPropertiesMutator
-
Sets the args-properties for the
ParseArgsProperties
property. - size() - Method in class org.refcodes.properties.ext.cli.ArgsParserProperties
T
- toDataStructure(String) - Method in class org.refcodes.properties.ext.cli.ArgsParserProperties
V
- values() - Method in class org.refcodes.properties.ext.cli.ArgsParserProperties
W
- withAddExample(String, Operand<?>...) - Method in class org.refcodes.properties.ext.cli.ArgsParserProperties
- withAddExample(Example) - Method in class org.refcodes.properties.ext.cli.ArgsParserProperties
- withArgsParserProperties(ParseArgsProperties) - Method in interface org.refcodes.properties.ext.cli.ArgsParserPropertiesAccessor.ArgsParserPropertiesBuilder
-
Sets the args-properties for the
ParseArgsProperties
property. - withArgsSyntax(Term) - Method in class org.refcodes.properties.ext.cli.ArgsParserProperties
- withArgumentEscapeCode(String) - Method in class org.refcodes.properties.ext.cli.ArgsParserProperties
- withBannerBorderEscapeCode(String) - Method in class org.refcodes.properties.ext.cli.ArgsParserProperties
- withBannerEscapeCode(String) - Method in class org.refcodes.properties.ext.cli.ArgsParserProperties
- withBannerFont(Font) - Method in class org.refcodes.properties.ext.cli.ArgsParserProperties
- withBannerFontPalette(char[]) - Method in class org.refcodes.properties.ext.cli.ArgsParserProperties
- withBannerFontPalette(AsciiColorPalette) - Method in class org.refcodes.properties.ext.cli.ArgsParserProperties
- withCommandEscapeCode(String) - Method in class org.refcodes.properties.ext.cli.ArgsParserProperties
- withConsoleWidth(int) - Method in class org.refcodes.properties.ext.cli.ArgsParserProperties
- withCopyright(String) - Method in class org.refcodes.properties.ext.cli.ArgsParserProperties
- withDescription(String) - Method in class org.refcodes.properties.ext.cli.ArgsParserProperties
- withDescriptionEscapeCode(String) - Method in class org.refcodes.properties.ext.cli.ArgsParserProperties
- withErrorOut(PrintStream) - Method in class org.refcodes.properties.ext.cli.ArgsParserProperties
- withEscapeCodesEnabled(boolean) - Method in class org.refcodes.properties.ext.cli.ArgsParserProperties
- withEvalArgs(String[]) - Method in class org.refcodes.properties.ext.cli.ArgsParserProperties
-
Same as
evalArgs(String[])
with the difference that this class's instance being invoked is returned as of the builder pattern. - withEvalArgs(String[]) - Method in interface org.refcodes.properties.ext.cli.ParseArgsProperties
-
Same as
evalArgs(String[])
with the difference that this class's instance being invoked is returned as of the builder pattern. - withEvalArgs(String[], Pattern) - Method in class org.refcodes.properties.ext.cli.ArgsParserProperties
- withEvalArgs(String[], ArgsFilter) - Method in class org.refcodes.properties.ext.cli.ArgsParserProperties
- withEvalArgs(String, String[]) - Method in class org.refcodes.properties.ext.cli.ArgsParserProperties
-
Same as
evalArgs(String[])
with the difference that the identified properties are inserted below the provided path and that this class's instance being invoked is returned as of the builder pattern. - withEvalArgs(String, String[]) - Method in interface org.refcodes.properties.ext.cli.ParseArgsProperties
-
Same as
evalArgs(String[])
with the difference that the identified properties are inserted below the provided path and that this class's instance being invoked is returned as of the builder pattern. - withEvalArgs(String, List<String>) - Method in class org.refcodes.properties.ext.cli.ArgsParserProperties
-
Same as
evalArgs(String[])
with the difference that the identified properties are inserted below the provided path and that this class's instance being invoked is returned as of the builder pattern. - withEvalArgs(String, List<String>) - Method in interface org.refcodes.properties.ext.cli.ParseArgsProperties
-
Same as
evalArgs(String[])
with the difference that the identified properties are inserted below the provided path and that this class's instance being invoked is returned as of the builder pattern. - withEvalArgs(List<String>) - Method in class org.refcodes.properties.ext.cli.ArgsParserProperties
-
Same as
evalArgs(List)
with the difference that this class's instance being invoked is returned as of the builder pattern. - withEvalArgs(List<String>) - Method in interface org.refcodes.properties.ext.cli.ParseArgsProperties
-
Same as
evalArgs(List)
with the difference that this class's instance being invoked is returned as of the builder pattern. - withEvalArgs(List<String>, Pattern) - Method in class org.refcodes.properties.ext.cli.ArgsParserProperties
- withEvalArgs(List<String>, ArgsFilter) - Method in class org.refcodes.properties.ext.cli.ArgsParserProperties
- withExamples(Collection<Example>) - Method in class org.refcodes.properties.ext.cli.ArgsParserProperties
- withExamples(Example[]) - Method in class org.refcodes.properties.ext.cli.ArgsParserProperties
- withLicense(String) - Method in class org.refcodes.properties.ext.cli.ArgsParserProperties
- withLineBreak(String) - Method in class org.refcodes.properties.ext.cli.ArgsParserProperties
- withLineSeparatorEscapeCode(String) - Method in class org.refcodes.properties.ext.cli.ArgsParserProperties
- withLongOptionPrefix(String) - Method in class org.refcodes.properties.ext.cli.ArgsParserProperties
- withMaxConsoleWidth(int) - Method in class org.refcodes.properties.ext.cli.ArgsParserProperties
- withName(String) - Method in class org.refcodes.properties.ext.cli.ArgsParserProperties
- withOptionEscapeCode(String) - Method in class org.refcodes.properties.ext.cli.ArgsParserProperties
- withResetEscapeCode(String) - Method in class org.refcodes.properties.ext.cli.ArgsParserProperties
- withSeparatorLnChar(char) - Method in class org.refcodes.properties.ext.cli.ArgsParserProperties
- withShortOptionPrefix(Character) - Method in class org.refcodes.properties.ext.cli.ArgsParserProperties
- withStandardOut(PrintStream) - Method in class org.refcodes.properties.ext.cli.ArgsParserProperties
- withSyntaxMetrics(SyntaxMetrics) - Method in class org.refcodes.properties.ext.cli.ArgsParserProperties
- withSyntaxMetrics(SyntaxNotation) - Method in class org.refcodes.properties.ext.cli.ArgsParserProperties
- withTextBoxGrid(TextBoxGrid) - Method in class org.refcodes.properties.ext.cli.ArgsParserProperties
- withTextBoxGrid(TextBoxStyle) - Method in class org.refcodes.properties.ext.cli.ArgsParserProperties
- withTitle(String) - Method in class org.refcodes.properties.ext.cli.ArgsParserProperties
All Classes and Interfaces|All Packages