Package | Description |
---|---|
org.refcodes.console |
Getting started:
Consider you have a tool called "foo-bar" to be invoked with the below
allowed argument combinations (syntax):
foo-bar [{ -a | -d }] -f <file>
"foo-bar" can be invoked either with an optional "-a" or with an optional
"-d" switch, but not both of them at the same time, and a file
"-f <file>" must be provided, else the passed arguments are rejected as
not being valid.
|
org.refcodes.console.impls |
Implementations:
The
impls package contains implementations of the types defined
by this artifact. |
Modifier and Type | Method and Description |
---|---|
default ArgsParser |
ArgsParser.withBannerFont(org.refcodes.textual.Font aBannerFont) |
default ArgsParser |
ArgsParser.withBannerFontPalette(char[] aColorPalette) |
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) |
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.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.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) |
default ArgsParser |
ArgsParser.withSeparatorChar(char aSeparatorChar)
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.withTitle(String aTitle) |
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 | Class and Description |
---|---|
class |
ArgsParserImpl
A straightforward implementation of the
ArgsParser interface. |
Copyright © 2016. All rights reserved.