Modifier and Type | Class | Description |
---|---|---|
class |
ArgsParserImpl |
A straightforward implementation of the
ArgsParser interface. |
Modifier and Type | Method | Description |
---|---|---|
ArgsParser |
ArgsParserAccessor.getArgsParser() |
Retrieves the args-parser from the
ArgsParser property. |
default ArgsParser |
ArgsParserAccessor.ArgsParserProperty.letArgsParser(ArgsParser aArgsParser) |
This method stores and passes through the given argument, which is
very useful for builder APIs: Sets the given
ArgsParser
(setter) as of ArgsParserAccessor.ArgsParserMutator.setArgsParser(ArgsParser) and returns the
very same value (getter). |
default ArgsParser |
ArgsParser.withBannerBorderEscapeCode(String aBannerBorderEscCode) |
Sets the banner's border Escape-Code for the banner border Escape-Code
property.
|
default ArgsParser |
ArgsParser.withBannerEscapeCode(String aBannerEscCode) |
Sets the banner's content Escape-Code for the banner Escape-Code
property.
|
default ArgsParser |
ArgsParser.withBannerFont(org.refcodes.textual.Font aBannerFont) |
With banner font.
|
default ArgsParser |
ArgsParser.withBannerFontPalette(char[] aColorPalette) |
With banner font palette.
|
default ArgsParser |
ArgsParser.withConsoleWidth(int aConsoleWidth) |
Set the console with.
|
default ArgsParser |
ArgsParser.withCopyrightNote(String aCopyrightNote) |
Set the copyright note used by the
printHelp() method when
writing out the copyright claim and make other adjustments with the
result (with regards to the Builder-Pattern). |
default ArgsParser |
ArgsParser.withDescription(String aDescription) |
With description.
|
default ArgsParser |
ArgsParser.withDescriptionEscapeCode(String aDescriptionEscCode) |
Sets the description Escape-Code for the description Escape-Code
property.
|
default ArgsParser |
ArgsParser.withErrorOut(PrintStream aErrorOut) |
Set the error out
PrintStream and make other adjustments with the
result (with regards to the Builder-Pattern). |
default ArgsParser |
ArgsParser.withEscapeCodesEnabled(boolean isEscCodeEnabled) |
|
default ArgsParser |
ArgsParser.withEvalArgs(String[] aArgs) |
Same as
evalArgs(String[]) with the difference that this class's
instance being invoked is returned as of the builder pattern. |
default ArgsParser |
ArgsParser.withEvalArgs(List<String> aArgs) |
Same as
evalArgs(List) with the difference that this class's
instance being invoked is returned as of the builder pattern. |
default ArgsParser |
ArgsParser.withExampleUsage(String aDescription,
Operand<?>... aOperands) |
Adds a usage example by providing a description of the example and the
command line arguments required by the example.
|
default ArgsParser |
ArgsParser.withLicenseNote(String aLicenseNote) |
Set the license note used by the
printHelp() method when writing
out the licensing conditions and make other adjustments with the result
(with regards to the Builder-Pattern). |
default ArgsParser |
ArgsParser.withLineBreak(String aLineBreak) |
Set the console's line break.
|
default ArgsParser |
ArgsParser.withLineSeparatorEscapeCode(String aLineSeparatorEscCode) |
Sets the line separator Escape-Code for the line separator Escape-Code
property.
|
default ArgsParser |
ArgsParser.withMaxConsoleWidth(int aMaxConsoleWidth) |
Set the maximum console width to use in case the console width is greater
than the maximum you want.
|
default ArgsParser |
ArgsParser.withName(String aName) |
With name.
|
default ArgsParser |
ArgsParser.withParameterEscapeCode(String aParamEscCode) |
Sets the parameter Escape-Code for the parameter Escape-Code property.
|
default ArgsParser |
ArgsParser.withResetEscapeCode(String aResetEscCode) |
|
default ArgsParser |
ArgsParser.withSeparatorLnChar(char aSeparatorLnChar) |
Set the character to be used when printing a separator line with the
printSeparatorLn() method. |
default ArgsParser |
ArgsParser.withStandardOut(PrintStream aStandardOut) |
Set the standard out
PrintStream and make other adjustments with
the result (with regards to the Builder-Pattern). |
default ArgsParser |
ArgsParser.withSyntaxNotation(SyntaxNotation aSyntaxNotation) |
Set the
SyntaxNotation and make other adjustments with the result
(with regards to the Builder-Pattern). |
default ArgsParser |
ArgsParser.withTextBoxGrid(org.refcodes.textual.TextBoxGrid aTextBoxGrid) |
|
default ArgsParser |
ArgsParser.withTitle(String aTitle) |
With title.
|
default ArgsParser |
ArgsParser.withUsageLabel(String aUsageLabel) |
Set the usage label used by the
printHelp() method when writing
out the syntax and make other adjustments with the result (with regards
to the Builder-Pattern). |
Modifier and Type | Method | Description |
---|---|---|
default ArgsParser |
ArgsParserAccessor.ArgsParserProperty.letArgsParser(ArgsParser aArgsParser) |
This method stores and passes through the given argument, which is
very useful for builder APIs: Sets the given
ArgsParser
(setter) as of ArgsParserAccessor.ArgsParserMutator.setArgsParser(ArgsParser) and returns the
very same value (getter). |
void |
ArgsParserAccessor.ArgsParserMutator.setArgsParser(ArgsParser aProperties) |
Sets the args-parser for the
ArgsParser property. |
B |
ArgsParserAccessor.ArgsParserBuilder.withArgsParser(ArgsParser aProperties) |
Sets the args-parser for the
ArgsParser property. |
Copyright © 2021. All rights reserved.