Interface ArgsParser

All Superinterfaces:

ArgsParserBuilder<ArgsParser>, ArgsProcessorBuilder<ArgsParser>, ArgsSyntaxAccessor, ArgsSyntaxAccessor.ArgsSyntaxBuilder<ArgsParser>, ArgsSyntaxAccessor.ArgsSyntaxMutator, ArgsSyntaxAccessor.ArgsSyntaxProperty, ArgumentEscapeCodeAccessor, ArgumentEscapeCodeAccessor.ArgumentEscapeCodeBuilder<ArgsParser>, ArgumentEscapeCodeAccessor.ArgumentEscapeCodeMutator, ArgumentEscapeCodeAccessor.ArgumentEscapeCodeProperty, BannerBorderEscapeCodeAccessor, BannerBorderEscapeCodeAccessor.BannerBorderEscapeCodeBuilder<ArgsParser>, BannerBorderEscapeCodeAccessor.BannerBorderEscapeCodeMutator, BannerBorderEscapeCodeAccessor.BannerBorderEscapeCodeProperty, BannerEscapeCodeAccessor, BannerEscapeCodeAccessor.BannerEscapeCodeBuilder<ArgsParser>, BannerEscapeCodeAccessor.BannerEscapeCodeMutator, BannerEscapeCodeAccessor.BannerEscapeCodeProperty, BannerFontAccessor, BannerFontAccessor.BannerFontBuilder<ArgsParser>, BannerFontAccessor.BannerFontMutator, BannerFontAccessor.BannerFontProperty, BannerFontPaletteAccessor, BannerFontPaletteAccessor.BannerFontPaletteBuilder<ArgsParser>, BannerFontPaletteAccessor.BannerFontPaletteMutator, BannerFontPaletteAccessor.BannerFontPaletteProperty, CliMetrics, CommandEscapeCodeAccessor, CommandEscapeCodeAccessor.CommandEscapeCodeBuilder<ArgsParser>, CommandEscapeCodeAccessor.CommandEscapeCodeMutator, CommandEscapeCodeAccessor.CommandEscapeCodeProperty, ConsoleWidthAccessor, ConsoleWidthAccessor.ConsoleWidthBuilder<ArgsParser>, ConsoleWidthAccessor.ConsoleWidthMutator, ConsoleWidthAccessor.ConsoleWidthProperty, CopyrightAccessor, CopyrightAccessor.CopyrightBuilder<ArgsParser>, CopyrightAccessor.CopyrightMutator, CopyrightAccessor.CopyrightProperty, DescriptionAccessor, DescriptionAccessor.DescriptionBuilder<ArgsParser>, DescriptionAccessor.DescriptionMutator, DescriptionAccessor.DescriptionProperty, DescriptionEscapeCodeAccessor, DescriptionEscapeCodeAccessor.DescriptionEscapeCodeBuilder<ArgsParser>, DescriptionEscapeCodeAccessor.DescriptionEscapeCodeMutator, DescriptionEscapeCodeAccessor.DescriptionEscapeCodeProperty, Diagnosable, EscapeCodesStatusAccessor, EscapeCodesStatusAccessor.EscapeCodeStatusBuilder<ArgsParser>, EscapeCodesStatusAccessor.EscapeCodeStatusMutator, EscapeCodesStatusAccessor.EscapeCodeStatusProperty, ExamplesAccessor, ExamplesAccessor.ExamplesBuilder<ArgsParser>, ExamplesAccessor.ExamplesMutator, ExamplesAccessor.ExamplesProperty, KeywordEscapeCodeAccessor, KeywordEscapeCodeAccessor.KeywordEscapeCodeBuilder<ArgsParser>, KeywordEscapeCodeAccessor.KeywordEscapeCodeMutator, KeywordEscapeCodeAccessor.KeywordEscapeCodeProperty, LicenseAccessor, LicenseAccessor.LicenseBuilder<ArgsParser>, LicenseAccessor.LicenseMutator, LicenseAccessor.LicenseProperty, LineBreakAccessor, LineBreakAccessor.LineBreakBuilder<ArgsParser>, LineBreakAccessor.LineBreakMutator, LineBreakAccessor.LineBreakProperty, LineSeparatorEscapeCodeAccessor, LineSeparatorEscapeCodeAccessor.LineSeparatorEscapeCodeBuilder<ArgsParser>, LineSeparatorEscapeCodeAccessor.LineSeparatorEscapeCodeMutator, LineSeparatorEscapeCodeAccessor.LineSeparatorEscapeCodeProperty, LongOptionPrefixAccessor, LongOptionPrefixAccessor.LongOptionPrefixBuilder<ArgsParser>, LongOptionPrefixAccessor.LongOptionPrefixMutator, LongOptionPrefixAccessor.LongOptionPrefixProperty, MaxConsoleWidthAccessor, MaxConsoleWidthAccessor.MaxConsoleWidthBuilder<ArgsParser>, MaxConsoleWidthAccessor.MaxConsoleWidthMutator, MaxConsoleWidthAccessor.MaxConsoleWidthProperty, NameAccessor, NameAccessor.NameBuilder<ArgsParser>, NameAccessor.NameMutator, NameAccessor.NameProperty, Optionable, Resetable, ResetEscapeCodeAccessor, ResetEscapeCodeAccessor.ResetEscapeCodeBuilder<ArgsParser>, ResetEscapeCodeAccessor.ResetEscapeCodeMutator, ResetEscapeCodeAccessor.ResetEscapeCodeProperty, Schemable<DiagnosticOptions>, ShortOptionPrefixAccessor, ShortOptionPrefixAccessor.ShortOptionPrefixBuilder<ArgsParser>, ShortOptionPrefixAccessor.ShortOptionPrefixMutator, ShortOptionPrefixAccessor.ShortOptionPrefixProperty, SyntaxMetricsAccessor, SyntaxMetricsAccessor.SyntaxMetricsBuilder<ArgsParser>, SyntaxMetricsAccessor.SyntaxMetricsMutator, SyntaxMetricsAccessor.SyntaxMetricsProperty, TextBoxGridAccessor, TextBoxGridAccessor.TextBoxGridBuilder<ArgsParser>, TextBoxGridAccessor.TextBoxGridMutator, TextBoxGridAccessor.TextBoxGridProperty, TitleAccessor, TitleAccessor.TitleBuilder<ArgsParser>, TitleAccessor.TitleMutator, TitleAccessor.TitleProperty

All Known Implementing Classes:

CliArgsParser

public interface ArgsParser
extends Optionable, CliMetrics, LineBreakAccessor.LineBreakProperty, LineSeparatorEscapeCodeAccessor.LineSeparatorEscapeCodeProperty, DescriptionEscapeCodeAccessor.DescriptionEscapeCodeProperty, LicenseAccessor.LicenseProperty, CopyrightAccessor.CopyrightProperty, ConsoleWidthAccessor.ConsoleWidthProperty, MaxConsoleWidthAccessor.MaxConsoleWidthProperty, BannerFontPaletteAccessor.BannerFontPaletteProperty, BannerFontAccessor.BannerFontProperty, CommandEscapeCodeAccessor.CommandEscapeCodeProperty, BannerEscapeCodeAccessor.BannerEscapeCodeProperty, BannerBorderEscapeCodeAccessor.BannerBorderEscapeCodeProperty, ExamplesAccessor.ExamplesProperty, TitleAccessor.TitleProperty, NameAccessor.NameProperty, DescriptionAccessor.DescriptionProperty, EscapeCodesStatusAccessor.EscapeCodeStatusProperty, ResetEscapeCodeAccessor.ResetEscapeCodeProperty, KeywordEscapeCodeAccessor.KeywordEscapeCodeProperty, ArgumentEscapeCodeAccessor.ArgumentEscapeCodeProperty, SyntaxMetricsAccessor.SyntaxMetricsProperty, ShortOptionPrefixAccessor.ShortOptionPrefixProperty, LongOptionPrefixAccessor.LongOptionPrefixProperty, TextBoxGridAccessor.TextBoxGridProperty, ArgsSyntaxAccessor.ArgsSyntaxProperty, ArgsProcessorBuilder<ArgsParser>, ArgsParserBuilder<ArgsParser>, Resetable, Diagnosable

The ArgsParser provides means for parsing command line arguments and constructing a command line utility's help output.

Nested Class Summary

Nested classes/interfaces inherited from interface ArgsSyntaxAccessor

ArgsSyntaxAccessor.ArgsSyntaxBuilder<B>, ArgsSyntaxAccessor.ArgsSyntaxMutator, ArgsSyntaxAccessor.ArgsSyntaxProperty

Nested classes/interfaces inherited from interface ArgumentEscapeCodeAccessor

ArgumentEscapeCodeAccessor.ArgumentEscapeCodeBuilder<B>, ArgumentEscapeCodeAccessor.ArgumentEscapeCodeMutator, ArgumentEscapeCodeAccessor.ArgumentEscapeCodeProperty

Nested classes/interfaces inherited from interface BannerBorderEscapeCodeAccessor

BannerBorderEscapeCodeAccessor.BannerBorderEscapeCodeBuilder<B>, BannerBorderEscapeCodeAccessor.BannerBorderEscapeCodeMutator, BannerBorderEscapeCodeAccessor.BannerBorderEscapeCodeProperty

Nested classes/interfaces inherited from interface BannerEscapeCodeAccessor

BannerEscapeCodeAccessor.BannerEscapeCodeBuilder<B>, BannerEscapeCodeAccessor.BannerEscapeCodeMutator, BannerEscapeCodeAccessor.BannerEscapeCodeProperty

Nested classes/interfaces inherited from interface BannerFontAccessor

BannerFontAccessor.BannerFontBuilder<B>, BannerFontAccessor.BannerFontMutator, BannerFontAccessor.BannerFontProperty

Nested classes/interfaces inherited from interface BannerFontPaletteAccessor

BannerFontPaletteAccessor.BannerFontPaletteBuilder<B>, BannerFontPaletteAccessor.BannerFontPaletteMutator, BannerFontPaletteAccessor.BannerFontPaletteProperty

Nested classes/interfaces inherited from interface CommandEscapeCodeAccessor

CommandEscapeCodeAccessor.CommandEscapeCodeBuilder<B>, CommandEscapeCodeAccessor.CommandEscapeCodeMutator, CommandEscapeCodeAccessor.CommandEscapeCodeProperty

Nested classes/interfaces inherited from interface ConsoleWidthAccessor

ConsoleWidthAccessor.ConsoleWidthBuilder<B>, ConsoleWidthAccessor.ConsoleWidthMutator, ConsoleWidthAccessor.ConsoleWidthProperty

Nested classes/interfaces inherited from interface CopyrightAccessor

CopyrightAccessor.CopyrightBuilder<B>, CopyrightAccessor.CopyrightMutator, CopyrightAccessor.CopyrightProperty

Nested classes/interfaces inherited from interface DescriptionAccessor

DescriptionAccessor.DescriptionBuilder<B>, DescriptionAccessor.DescriptionMutator, DescriptionAccessor.DescriptionProperty

Nested classes/interfaces inherited from interface DescriptionEscapeCodeAccessor

DescriptionEscapeCodeAccessor.DescriptionEscapeCodeBuilder<B>, DescriptionEscapeCodeAccessor.DescriptionEscapeCodeMutator, DescriptionEscapeCodeAccessor.DescriptionEscapeCodeProperty

Nested classes/interfaces inherited from interface EscapeCodesStatusAccessor

EscapeCodesStatusAccessor.EscapeCodeStatusBuilder<B>, EscapeCodesStatusAccessor.EscapeCodeStatusMutator, EscapeCodesStatusAccessor.EscapeCodeStatusProperty

Nested classes/interfaces inherited from interface ExamplesAccessor

ExamplesAccessor.ExamplesBuilder<B>, ExamplesAccessor.ExamplesMutator, ExamplesAccessor.ExamplesProperty

Nested classes/interfaces inherited from interface KeywordEscapeCodeAccessor

KeywordEscapeCodeAccessor.KeywordEscapeCodeBuilder<B>, KeywordEscapeCodeAccessor.KeywordEscapeCodeMutator, KeywordEscapeCodeAccessor.KeywordEscapeCodeProperty

Nested classes/interfaces inherited from interface LicenseAccessor

LicenseAccessor.LicenseBuilder<B>, LicenseAccessor.LicenseMutator, LicenseAccessor.LicenseProperty

Nested classes/interfaces inherited from interface LineBreakAccessor

LineBreakAccessor.LineBreakBuilder<B>, LineBreakAccessor.LineBreakMutator, LineBreakAccessor.LineBreakProperty

Nested classes/interfaces inherited from interface LineSeparatorEscapeCodeAccessor

LineSeparatorEscapeCodeAccessor.LineSeparatorEscapeCodeBuilder<B>, LineSeparatorEscapeCodeAccessor.LineSeparatorEscapeCodeMutator, LineSeparatorEscapeCodeAccessor.LineSeparatorEscapeCodeProperty

Nested classes/interfaces inherited from interface LongOptionPrefixAccessor

LongOptionPrefixAccessor.LongOptionPrefixBuilder<B>, LongOptionPrefixAccessor.LongOptionPrefixMutator, LongOptionPrefixAccessor.LongOptionPrefixProperty

Nested classes/interfaces inherited from interface MaxConsoleWidthAccessor

MaxConsoleWidthAccessor.MaxConsoleWidthBuilder<B>, MaxConsoleWidthAccessor.MaxConsoleWidthMutator, MaxConsoleWidthAccessor.MaxConsoleWidthProperty

Nested classes/interfaces inherited from interface NameAccessor

NameAccessor.NameBuilder<B>, NameAccessor.NameMutator, NameAccessor.NameProperty

Nested classes/interfaces inherited from interface ResetEscapeCodeAccessor

ResetEscapeCodeAccessor.ResetEscapeCodeBuilder<B>, ResetEscapeCodeAccessor.ResetEscapeCodeMutator, ResetEscapeCodeAccessor.ResetEscapeCodeProperty

Nested classes/interfaces inherited from interface ShortOptionPrefixAccessor

ShortOptionPrefixAccessor.ShortOptionPrefixBuilder<B>, ShortOptionPrefixAccessor.ShortOptionPrefixMutator, ShortOptionPrefixAccessor.ShortOptionPrefixProperty

Nested classes/interfaces inherited from interface SyntaxMetricsAccessor

SyntaxMetricsAccessor.SyntaxMetricsBuilder<B>, SyntaxMetricsAccessor.SyntaxMetricsMutator, SyntaxMetricsAccessor.SyntaxMetricsProperty

Nested classes/interfaces inherited from interface TextBoxGridAccessor

TextBoxGridAccessor.TextBoxGridBuilder<B>, TextBoxGridAccessor.TextBoxGridMutator, TextBoxGridAccessor.TextBoxGridProperty

Nested classes/interfaces inherited from interface TitleAccessor

TitleAccessor.TitleBuilder<B>, TitleAccessor.TitleMutator, TitleAccessor.TitleProperty

Method Summary

Modifier and Type	Method	Description
default void	addExample(String aDescription, Operand<?>... aOperands)	Adds an usage example by providing a description of the example and the command line arguments required by the example.
void	addExample(Example aExample)	Adds an usage example by providing a description of the example and the command line arguments required by the example.
void	errorLn(String aLine)	Prints the given line to standard error with regards to the console width as specified by the withConsoleWidth(int) method.
Operand<?>[]	evalArgs(String[] aArgs)	Evaluates the provided command line arguments and determines the according values by evaluating the root Condition.
default Operand<?>[]	evalArgs(String[] aArgs, Pattern aFilterExp)	Evaluates the provided command line arguments as of evalArgs(String[]), additionally filtering (excluding) the arguments matching the provided Pattern.
default Operand<?>[]	evalArgs(String[] aArgs, ArgsFilter aArgsFilter)	Evaluates the provided command line arguments as of evalArgs(String[]), additionally filtering (excluding) the arguments matching the provided ArgsFilter.
default Operand<?>[]	evalArgs(List<String> aArgs)	Same as evalArgs(String[]) with the difference that the elements representing the arguments are passed as a list instead of an array.
default Operand<?>[]	evalArgs(List<String> aArgs, Pattern aFilterExp)	Evaluates the provided command line arguments as of evalArgs(String[]), additionally filtering (excluding) the arguments matching the provided Pattern.
default Operand<?>[]	evalArgs(List<String> aArgs, ArgsFilter aArgsFilter)	Evaluates the provided command line arguments as of evalArgs(String[]), additionally filtering (excluding) the arguments matching the provided ArgsFilter.
Term	getArgsSyntax()	Retrieves the (root) Term from the (root) Term property.
String	getArgumentEscapeCode()	Retrieves the argument Escape-Code from the argument Escape-Code property.
String	getBannerBorderEscapeCode()	Retrieves the banner border Escape-Code from the banner border Escape-Code property.
String	getBannerEscapeCode()	Retrieves the banner Escape-Code from the banner Escape-Code property.
String	getCommandEscapeCode()	Retrieves the command Escape-Code from the command Escape-Code property.
String	getCopyright()	Retrieves the copyright from the copyright property.
String	getDescription()
String	getDescriptionEscapeCode()	Retrieves the description Escape-Code from the description Escape-Code property.
Example[]	getExamples()	Retrieves the Example instances from the Example instances property.
String	getKeywordEscapeCode()	Retrieves the keyword (e.g. short- and long-options) Escape-Code from the option Escape-Code property.
String	getLicense()	Retrieves the license from the license property.
String	getLineSeparatorEscapeCode()	Retrieves the line separator Escape-Code from the line separator Escape-Code property.
char	getSeparatorLnChar()	Gets the character to be used when printing a separator line with the printSeparatorLn() method.
void	printBanner()	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.
default void	printBody()	Prints the help as of printHelp() without the banner.
void	printCopyright()	Prints the copyright note as specified by the withCopyright(String) method; with regards to the console width as specified by the withConsoleWidth(int) method.
void	printDescription()	Prints the description as set by the withDescription(String) method with regards to the console width as specified by the withConsoleWidth(int) method.
void	printExamples()	Prints example usages as as added by the addExample(String, Operand...) method with regards to the console width as specified by the withConsoleWidth(int) method.
void	printHeader()	Prints the header, which might be a simplified banner: Can be used when overriding methods such as printHelp() or printBanner().
default void	printHelp()	Prints the help to the standard output specified by the withStandardOut(PrintStream) method.
void	printLicense()	Prints the license note as specified by the withLicense(String) method; with regards to the console width as specified by the withConsoleWidth(int) method.
void	printLn()	Prints an empty line / a line break.
void	printLn(String aLine)	Prints the given line to standard out with regards to the console width as specified by the withConsoleWidth(int) method.
void	printOptions()	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 withConsoleWidth(int) method.
void	printSeparatorLn()	Prints a separator line using the separator character as specified by the withSeparatorLnChar(char) method; with regards to the console width as specified by the withConsoleWidth(int) method.
void	printSynopsis()	Prints the syntax as retrieved by the root Condition element as of Synopsisable.toSynopsis(SyntaxNotation) with regards to the SyntaxNotation set by the withSyntaxMetrics(SyntaxMetrics) method.
void	setErrorOut(PrintStream aErrorOut)	Set the error out PrintStream and make other adjustments with the result (with regards to the Builder-Pattern).
void	setLineSeparatorEscapeCode(String aLineSeparatorEscCode)	Sets the line separator Escape-Code for the line separator Escape-Code property.
void	setSeparatorLnChar(char aSeparatorLnChar)	Set the character to be used when printing a separator line with the printSeparatorLn() method.
void	setStandardOut(PrintStream aStandardOut)	Set the standard out PrintStream and make other adjustments with the result (with regards to the Builder-Pattern).
void	setSyntaxMetrics(SyntaxMetrics aSyntaxMetrics)	Sets the SyntaxMetrics for the SyntaxMetrics property.
default String[]	toOptions(Option<?> aOption)	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).
default Schema	toSchema()
default ArgsParser	withAddExample(String aDescription, Operand<?>... aOperands)	Builder method adding an application's Example element.
default ArgsParser	withAddExample(Example aExample)	Builder method adding an application's Example element.
default ArgsParser	withArgumentEscapeCode(String aParamEscCode)	Sets the argument Escape-Code for the argument Escape-Code property.
default ArgsParser	withBannerBorderEscapeCode(String aBannerBorderEscCode)	Sets the banner border Escape-Code for the banner border Escape-Code property.
default ArgsParser	withBannerEscapeCode(String aBannerEscCode)	Sets the banner Escape-Code for the banner Escape-Code property.
default ArgsParser	withBannerFont(Font aBannerFont)	Sets the banner Font for the banner Font property.
default ArgsParser	withBannerFontPalette(char[] aColorPalette)	Sets the banner font palette for the banner font palette property.
default ArgsParser	withCommandEscapeCode(String aCommandEscCode)	Sets the command Escape-Code for the command Escape-Code property.
default ArgsParser	withConsoleWidth(int aConsoleWidth)
default ArgsParser	withCopyright(String aCopyright)	Sets the copyright for the copyright property.
default ArgsParser	withDescription(String aDescription)
default ArgsParser	withDescriptionEscapeCode(String aDescriptionEscCode)	Sets the description Escape-Code for the description Escape-Code property.
default ArgsParser	withErrorOut(PrintStream aErrorOut)	Set the error out PrintStream and make other adjustments with the result (with regards to the Builder-Pattern).
default ArgsParser	withEscapeCodesEnabled(boolean isEscCodeEnabled)
default ArgsParser	withEvalArgs(String[] aArgs)	Evaluates the provided command line arguments.
default ArgsParser	withEvalArgs(List<String> aArgs)	Evaluates the provided command line arguments .
default ArgsParser	withExamples(Collection<Example> aExamples)	Builder method providing the application's Example elements.
default ArgsParser	withExamples(Example[] aExamples)	Sets the Example instances for the Example instances property.
default ArgsParser	withKeywordEscapeCode(String aOptEscCode)	Sets the keyword (e.g. short- and long-options) Escape-Code for the keyword Escape-Code property.
default ArgsParser	withLicense(String aLicense)	Sets the license for the license property.
default ArgsParser	withLineBreak(String aLineBreak)
default ArgsParser	withLineSeparatorEscapeCode(String aLineSeparatorEscCode)	Sets the line separator Escape-Code for the line separator Escape-Code property.
default ArgsParser	withLongOptionPrefix(String aLongOptionPrefix)	Sets the long option prefix for the long option prefix property.
default ArgsParser	withMaxConsoleWidth(int aMaxConsoleWidth)
default ArgsParser	withName(String aName)
default ArgsParser	withResetEscapeCode(String aResetEscCode)
default ArgsParser	withSeparatorLnChar(char aSeparatorLnChar)	Builder method adding an separator line char.
default ArgsParser	withShortOptionPrefix(Character aShortOptionPrefix)	Sets the short option prefix for the short option prefix property.
default ArgsParser	withStandardOut(PrintStream aStandardOut)	Set the standard out PrintStream and make other adjustments with the result (with regards to the Builder-Pattern).
default ArgsParser	withSyntaxMetrics(SyntaxMetrics aSyntaxMetrics)	Sets the SyntaxMetrics for the SyntaxMetrics property.
default ArgsParser	withTextBoxGrid(TextBoxGrid aTextBoxGrid)
default ArgsParser	withTextBoxGrid(TextBoxStyle aTextBoxStyle)
default ArgsParser	withTitle(String aTitle)

Methods inherited from interface ArgsParserBuilder

withEvalArgs, withEvalArgs, withEvalArgs, withEvalArgs

Methods inherited from interface ArgsSyntaxAccessor.ArgsSyntaxBuilder

withArgsSyntax

Methods inherited from interface ArgsSyntaxAccessor.ArgsSyntaxMutator

setArgsSyntax

Methods inherited from interface ArgsSyntaxAccessor.ArgsSyntaxProperty

letArgsSyntax

Methods inherited from interface ArgumentEscapeCodeAccessor.ArgumentEscapeCodeMutator

setArgumentEscapeCode

Methods inherited from interface ArgumentEscapeCodeAccessor.ArgumentEscapeCodeProperty

letArgumentEscapeCode

Methods inherited from interface BannerBorderEscapeCodeAccessor.BannerBorderEscapeCodeMutator

setBannerBorderEscapeCode

Methods inherited from interface BannerBorderEscapeCodeAccessor.BannerBorderEscapeCodeProperty

letBannerBorderEscapeCode

Methods inherited from interface BannerEscapeCodeAccessor.BannerEscapeCodeMutator

setBannerEscapeCode

Methods inherited from interface BannerEscapeCodeAccessor.BannerEscapeCodeProperty

letBannerEscapeCode

Methods inherited from interface BannerFontAccessor

getBannerFont

Methods inherited from interface BannerFontAccessor.BannerFontMutator

setBannerFont

Methods inherited from interface BannerFontAccessor.BannerFontProperty

letBannerFont

Methods inherited from interface BannerFontPaletteAccessor

getBannerFontPalette

Methods inherited from interface BannerFontPaletteAccessor.BannerFontPaletteBuilder

withBannerFontPalette

Methods inherited from interface BannerFontPaletteAccessor.BannerFontPaletteMutator

setBannerFontPalette, setBannerFontPalette

Methods inherited from interface BannerFontPaletteAccessor.BannerFontPaletteProperty

letBannerFontPalette

Methods inherited from interface CommandEscapeCodeAccessor.CommandEscapeCodeMutator

setCommandEscapeCode

Methods inherited from interface CommandEscapeCodeAccessor.CommandEscapeCodeProperty

letCommandEscapeCode

Methods inherited from interface ConsoleWidthAccessor

getConsoleWidth

Methods inherited from interface ConsoleWidthAccessor.ConsoleWidthMutator

setConsoleWidth

Methods inherited from interface ConsoleWidthAccessor.ConsoleWidthProperty

letConsoleWidth

Methods inherited from interface CopyrightAccessor.CopyrightMutator

setCopyright

Methods inherited from interface CopyrightAccessor.CopyrightProperty

letCopyright

Methods inherited from interface DescriptionAccessor.DescriptionMutator

setDescription

Methods inherited from interface DescriptionAccessor.DescriptionProperty

letDescription

Methods inherited from interface DescriptionEscapeCodeAccessor.DescriptionEscapeCodeMutator

setDescriptionEscapeCode

Methods inherited from interface DescriptionEscapeCodeAccessor.DescriptionEscapeCodeProperty

letDescriptionEscapeCode

Methods inherited from interface EscapeCodesStatusAccessor

isEscapeCodesEnabled

Methods inherited from interface EscapeCodesStatusAccessor.EscapeCodeStatusMutator

setEscapeCodesEnabled

Methods inherited from interface EscapeCodesStatusAccessor.EscapeCodeStatusProperty

letEscapeCodesEnabled

Methods inherited from interface ExamplesAccessor.ExamplesMutator

setExamples, setExamples

Methods inherited from interface ExamplesAccessor.ExamplesProperty

letExamples

Methods inherited from interface KeywordEscapeCodeAccessor.KeywordEscapeCodeMutator

setKeywordEscapeCode

Methods inherited from interface KeywordEscapeCodeAccessor.KeywordEscapeCodeProperty

letKeywordEscapeCode

Methods inherited from interface LicenseAccessor.LicenseMutator

setLicense

Methods inherited from interface LicenseAccessor.LicenseProperty

letLicense

Methods inherited from interface LineBreakAccessor

getLineBreak

Methods inherited from interface LineBreakAccessor.LineBreakMutator

setLineBreak

Methods inherited from interface LineBreakAccessor.LineBreakProperty

letLineBreak

Methods inherited from interface LineSeparatorEscapeCodeAccessor.LineSeparatorEscapeCodeProperty

letLineSeparatorEscapeCode

Methods inherited from interface LongOptionPrefixAccessor

getLongOptionPrefix

Methods inherited from interface LongOptionPrefixAccessor.LongOptionPrefixMutator

setLongOptionPrefix

Methods inherited from interface LongOptionPrefixAccessor.LongOptionPrefixProperty

letLongOptionPrefix

Methods inherited from interface MaxConsoleWidthAccessor

getMaxConsoleWidth

Methods inherited from interface MaxConsoleWidthAccessor.MaxConsoleWidthMutator

setMaxConsoleWidth

Methods inherited from interface MaxConsoleWidthAccessor.MaxConsoleWidthProperty

letMaxConsoleWidth

Methods inherited from interface NameAccessor

getName

Methods inherited from interface NameAccessor.NameMutator

setName

Methods inherited from interface NameAccessor.NameProperty

letName

Methods inherited from interface Resetable

reset

Methods inherited from interface ResetEscapeCodeAccessor

getResetEscapeCode

Methods inherited from interface ResetEscapeCodeAccessor.ResetEscapeCodeMutator

setResetEscapeCode

Methods inherited from interface ResetEscapeCodeAccessor.ResetEscapeCodeProperty

letResetEscapeCode

Methods inherited from interface Schemable

toSchema

Methods inherited from interface ShortOptionPrefixAccessor

getShortOptionPrefix

Methods inherited from interface ShortOptionPrefixAccessor.ShortOptionPrefixMutator

setShortOptionPrefix

Methods inherited from interface ShortOptionPrefixAccessor.ShortOptionPrefixProperty

letShortOptionPrefix

Methods inherited from interface SyntaxMetricsAccessor

getSyntaxMetrics

Methods inherited from interface SyntaxMetricsAccessor.SyntaxMetricsBuilder

withSyntaxMetrics

Methods inherited from interface SyntaxMetricsAccessor.SyntaxMetricsMutator

setSyntaxMetrics

Methods inherited from interface SyntaxMetricsAccessor.SyntaxMetricsProperty

letSyntaxMetrics, letSyntaxMetrics

Methods inherited from interface TextBoxGridAccessor

getTextBoxGrid

Methods inherited from interface TextBoxGridAccessor.TextBoxGridMutator

setTextBoxGrid, setTextBoxGrid

Methods inherited from interface TextBoxGridAccessor.TextBoxGridProperty

letTextBoxGrid, letTextBoxGrid

Methods inherited from interface TitleAccessor

getTitle

Methods inherited from interface TitleAccessor.TitleMutator

setTitle

Methods inherited from interface TitleAccessor.TitleProperty

letTitle

Method Details

addExample

void addExample(Example aExample)

Adds an usage example by providing a description of the example and the command line arguments required by the example.

Parameters:

aExample - The description as well as the command line arguments used by the example.

addExample

default void addExample(String aDescription,
 Operand<?>... aOperands)

Adds an usage example by providing a description of the example and the command line arguments required by the example.

Parameters:

aDescription - The description of the example.

aOperands - The command line arguments used by the example.

errorLn

void errorLn(String aLine)

Prints the given line to standard error with regards to the console width as specified by the withConsoleWidth(int) method.

Parameters:

aLine - The line to be printed.

evalArgs

default Operand<?>[] evalArgs(List<String> aArgs)
                       throws ArgsSyntaxException

Same as evalArgs(String[]) with the difference that the elements representing the arguments are passed as a list instead of an array.

Parameters:

aArgs - The command line arguments to be evaluated.

Returns:

The list of evaluated command line arguments being instances of the Operand interfaces or its sub-types. In case an Operand implements the Approvable interface or inherits from the AbstractOperand type, then the Operand is also approved by invoking Approvable.approve() or AbstractOperand.approve() (which may trigger a registered lambda expression).

Throws:

ArgsSyntaxException - thrown in case of a command line arguments mismatch regarding provided and expected args.

evalArgs

default Operand<?>[] evalArgs(List<String> aArgs,
 ArgsFilter aArgsFilter)
                       throws ArgsSyntaxException

Evaluates the provided command line arguments as of evalArgs(String[]), additionally filtering (excluding) the arguments matching the provided ArgsFilter.

Parameters:

aArgs - The command line arguments to be evaluated.

aArgsFilter - The ArgsFilter used to filter (exclude) any "unwanted" or otherwise evaluated arguments.

Returns:

The list of evaluated command line arguments being instances of the Operand interfaces or its sub-types. In case an Operand implements the Approvable interface or inherits from the AbstractOperand type, then the Operand is also approved by invoking Approvable.approve() or AbstractOperand.approve() (which may trigger a registered lambda expression).

Throws:

ArgsSyntaxException - thrown in case of a command line arguments mismatch regarding provided and expected args.

evalArgs

default Operand<?>[] evalArgs(List<String> aArgs,
 Pattern aFilterExp)
                       throws ArgsSyntaxException

Evaluates the provided command line arguments as of evalArgs(String[]), additionally filtering (excluding) the arguments matching the provided Pattern.

Parameters:

aArgs - The command line arguments to be evaluated.

aFilterExp - The Pattern used to filter (exclude) any "unwanted" or otherwise evaluated arguments.

Returns:

The list of evaluated command line arguments being instances of the Operand interfaces or its sub-types. In case an Operand implements the Approvable interface or inherits from the AbstractOperand type, then the Operand is also approved by invoking Approvable.approve() or AbstractOperand.approve() (which may trigger a registered lambda expression).

Throws:

ArgsSyntaxException - thrown in case of a command line arguments mismatch regarding provided and expected args.

evalArgs

Operand<?>[] evalArgs(String[] aArgs)
               throws ArgsSyntaxException

Evaluates the provided command line arguments and determines the according values by evaluating the root Condition. In case of parsing failure, an according exception is thrown. ATTENTION: This method tests(!) for superfluous command line arguments being passed; e.g. command line arguments not being evaluated by any of the Term instance being traversed starting at the root Condition will be reported. Business logic therefore should invoke this root node's evalArgs(String[]) method instead of a Condition's Term.parseArgs(String[], String[], CliContext) method; as ignoring superfluous command line arguments will aCause unexpected behavior from the point of view of the invoker.

Parameters:

aArgs - The command line arguments to be evaluated.

Returns:

The list of evaluated command line arguments being instances of the Operand interfaces or its sub-types. In case an Operand implements the Approvable interface or inherits from the AbstractOperand type, then the Operand is also approved by invoking Approvable.approve() or AbstractOperand.approve() (which may trigger a registered lambda expression).

Throws:

ArgsSyntaxException - thrown in case of a command line arguments mismatch regarding provided and expected args.

evalArgs

default Operand<?>[] evalArgs(String[] aArgs,
 ArgsFilter aArgsFilter)
                       throws ArgsSyntaxException

Evaluates the provided command line arguments as of evalArgs(String[]), additionally filtering (excluding) the arguments matching the provided ArgsFilter.

Parameters:

aArgs - The command line arguments to be evaluated.

aArgsFilter - The ArgsFilter used to filter (exclude) any "unwanted" or otherwise evaluated arguments.

Returns:

The list of evaluated command line arguments being instances of the Operand interfaces or its sub-types. In case an Operand implements the Approvable interface or inherits from the AbstractOperand type, then the Operand is also approved by invoking Approvable.approve() or AbstractOperand.approve() (which may trigger a registered lambda expression).

Throws:

ArgsSyntaxException - thrown in case of a command line arguments mismatch regarding provided and expected args.

evalArgs

default Operand<?>[] evalArgs(String[] aArgs,
 Pattern aFilterExp)
                       throws ArgsSyntaxException

Evaluates the provided command line arguments as of evalArgs(String[]), additionally filtering (excluding) the arguments matching the provided Pattern.

Parameters:

aArgs - The command line arguments to be evaluated.

aFilterExp - The Pattern used to filter (exclude) any "unwanted" or otherwise evaluated arguments.

Returns:

The list of evaluated command line arguments being instances of the Operand interfaces or its sub-types. In case an Operand implements the Approvable interface or inherits from the AbstractOperand type, then the Operand is also approved by invoking Approvable.approve() or AbstractOperand.approve() (which may trigger a registered lambda expression).

Throws:

ArgsSyntaxException - thrown in case of a command line arguments mismatch regarding provided and expected args.

getArgsSyntax

Term getArgsSyntax()

Retrieves the (root) Term from the (root) Term property.

Specified by:

getArgsSyntax in interface ArgsSyntaxAccessor

Returns:

The (root) Term stored by the (root) Term property.

getArgumentEscapeCode

String getArgumentEscapeCode()

Retrieves the argument Escape-Code from the argument Escape-Code property.

Specified by:

getArgumentEscapeCode in interface ArgumentEscapeCodeAccessor

Returns:

The argument Escape-Code stored by the argument Escape-Code property.

getBannerBorderEscapeCode

String getBannerBorderEscapeCode()

Retrieves the banner border Escape-Code from the banner border Escape-Code property.

Specified by:

getBannerBorderEscapeCode in interface BannerBorderEscapeCodeAccessor

Returns:

The banner border Escape-Code stored by the banner border Escape-Code property.

getBannerEscapeCode

String getBannerEscapeCode()

Retrieves the banner Escape-Code from the banner Escape-Code property.

Specified by:

getBannerEscapeCode in interface BannerEscapeCodeAccessor

Returns:

The banner Escape-Code stored by the banner Escape-Code property.

getCommandEscapeCode

String getCommandEscapeCode()

Retrieves the command Escape-Code from the command Escape-Code property.

Specified by:

getCommandEscapeCode in interface CommandEscapeCodeAccessor

Returns:

The command Escape-Code stored by the command Escape-Code property.

getCopyright

String getCopyright()

Retrieves the copyright from the copyright property.

Specified by:

getCopyright in interface CopyrightAccessor

Returns:

The copyright stored by the copyright property.

getDescription

String getDescription()

Specified by:

getDescription in interface DescriptionAccessor

getDescriptionEscapeCode

String getDescriptionEscapeCode()

Retrieves the description Escape-Code from the description Escape-Code property.

Specified by:

getDescriptionEscapeCode in interface DescriptionEscapeCodeAccessor

Returns:

The description Escape-Code stored by the description Escape-Code property.

getExamples

Example[] getExamples()

Retrieves the Example instances from the Example instances property.

Specified by:

getExamples in interface ExamplesAccessor

Returns:

The Example instances stored by the Example instances property.

getLicense

String getLicense()

Retrieves the license from the license property.

Specified by:

getLicense in interface LicenseAccessor

Returns:

The license stored by the license property.

getLineSeparatorEscapeCode

String getLineSeparatorEscapeCode()

Retrieves the line separator Escape-Code from the line separator Escape-Code property.

Specified by:

getLineSeparatorEscapeCode in interface LineSeparatorEscapeCodeAccessor

Returns:

The line separator Escape-Code stored by the line separator Escape-Code property.

getKeywordEscapeCode

String getKeywordEscapeCode()

Retrieves the keyword (e.g. short- and long-options) Escape-Code from the option Escape-Code property.

Specified by:

getKeywordEscapeCode in interface KeywordEscapeCodeAccessor

Returns:

The keyword (e.g. short- and long-options) Escape-Code stored by the option Escape-Code property.

getSeparatorLnChar

char getSeparatorLnChar()

Gets the character to be used when printing a separator line with the printSeparatorLn() method.

Returns:

aSeparatorChar The character used by the printSeparatorLn() method when printing out the line of characters..

printBanner

void printBanner()

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

default void printBody()

Prints the help as of printHelp() without the banner.

printCopyright

void printCopyright()

Prints the copyright note as specified by the withCopyright(String) method; with regards to the console width as specified by the withConsoleWidth(int) method.

printDescription

void printDescription()

Prints the description as set by the withDescription(String) method with regards to the console width as specified by the withConsoleWidth(int) method.

printExamples

void printExamples()

Prints example usages as as added by the addExample(String, Operand...) method with regards to the console width as specified by the withConsoleWidth(int) method.

printHeader

void printHeader()

Prints the header, which might be a simplified banner: Can be used when overriding methods such as printHelp() or printBanner().

printHelp

default void printHelp()

Prints the help to the standard output specified by the withStandardOut(PrintStream) method. This method can make use of the more atomic methods printBanner(), printSynopsis(), printDescription(), printOptions() or printSeparatorLn() to print a help text which's look depends strongly on the taste of the author implementing this interface. In case you dislike the implementing author's taste, feel free to overwrite this method and compose your own help text from the building blocks such as printBanner(), printSynopsis(), printDescription(), printOptions() or printSeparatorLn()

printLicense

void printLicense()

Prints the license note as specified by the withLicense(String) method; with regards to the console width as specified by the withConsoleWidth(int) method.

printLn

void printLn()

Prints an empty line / a line break.

printLn

void printLn(String aLine)

Prints the given line to standard out with regards to the console width as specified by the withConsoleWidth(int) method.

Parameters:

aLine - The line to be printed.

printOptions

void printOptions()

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 withConsoleWidth(int) method.

printSeparatorLn

void printSeparatorLn()

Prints a separator line using the separator character as specified by the withSeparatorLnChar(char) method; with regards to the console width as specified by the withConsoleWidth(int) method.

printSynopsis

void printSynopsis()

Prints the syntax as retrieved by the root Condition element as of Synopsisable.toSynopsis(SyntaxNotation) with regards to the SyntaxNotation set by the withSyntaxMetrics(SyntaxMetrics) method.

setErrorOut

void setErrorOut(PrintStream aErrorOut)

Set the error out PrintStream and make other adjustments with the result (with regards to the Builder-Pattern).

Parameters:

aErrorOut - The error out PrintStream to set.

setLineSeparatorEscapeCode

void setLineSeparatorEscapeCode(String aLineSeparatorEscCode)

Sets the line separator Escape-Code for the line separator Escape-Code property.

Specified by:

setLineSeparatorEscapeCode in interface LineSeparatorEscapeCodeAccessor.LineSeparatorEscapeCodeMutator

Parameters:

aLineSeparatorEscCode - The line separator Escape-Code to be stored by the line separator Escape-Code property.

setSeparatorLnChar

void setSeparatorLnChar(char aSeparatorLnChar)

Set the character to be used when printing a separator line with the printSeparatorLn() method.

Parameters:

aSeparatorLnChar - The character used by the printSeparatorLn() method when printing out the line of characters..

setStandardOut

void setStandardOut(PrintStream aStandardOut)

Set the standard out PrintStream and make other adjustments with the result (with regards to the Builder-Pattern).

Parameters:

aStandardOut - The standard out PrintStream to set.

setSyntaxMetrics

void setSyntaxMetrics(SyntaxMetrics aSyntaxMetrics)

Sets the SyntaxMetrics for the SyntaxMetrics property.

Specified by:

setSyntaxMetrics in interface SyntaxMetricsAccessor.SyntaxMetricsMutator

Parameters:

aSyntaxMetrics - The SyntaxMetrics to be stored by the SyntaxMetrics property.

toOptions

default String[] toOptions(Option<?> aOption)

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).

Specified by:

toOptions in interface Optionable

Parameters:

aOption - The Option instance for which to get the configured short and long options.

Returns:

The array of options being the long option (if not null) and the short option (if not null) with the according context specific prefixes.

toSchema

default Schema toSchema()

Specified by:

toSchema in interface Schemable<DiagnosticOptions>

withAddExample

default ArgsParser withAddExample(Example aExample)

Builder method adding an application's Example element.

Specified by:

withAddExample in interface ArgsProcessorBuilder<ArgsParser>

Parameters:

aExample - The application's Example element to be added.

Returns:

This builder as of the builder pattern.

withAddExample

default ArgsParser withAddExample(String aDescription,
 Operand<?>... aOperands)

Builder method adding an application's Example element.

Specified by:

withAddExample in interface ArgsProcessorBuilder<ArgsParser>

Parameters:

aDescription - The example's description.

aOperands - The command line arguments required by the example.

Returns:

This builder as of the builder pattern.

withArgumentEscapeCode

default ArgsParser withArgumentEscapeCode(String aParamEscCode)

Sets the argument Escape-Code for the argument Escape-Code property.

Specified by:

withArgumentEscapeCode in interface ArgumentEscapeCodeAccessor.ArgumentEscapeCodeBuilder<ArgsParser>

Parameters:

aParamEscCode - The argument Escape-Code to be stored by the argument Escape-Code property.

Returns:

The builder for applying multiple build operations.

withBannerBorderEscapeCode

default ArgsParser withBannerBorderEscapeCode(String aBannerBorderEscCode)

Sets the banner border Escape-Code for the banner border Escape-Code property.

Specified by:

withBannerBorderEscapeCode in interface BannerBorderEscapeCodeAccessor.BannerBorderEscapeCodeBuilder<ArgsParser>

Parameters:

aBannerBorderEscCode - The banner border Escape-Code to be stored by the banner border Escape-Code property.

Returns:

The builder for applying multiple build operations.

withBannerEscapeCode

default ArgsParser withBannerEscapeCode(String aBannerEscCode)

Sets the banner Escape-Code for the banner Escape-Code property.

Specified by:

withBannerEscapeCode in interface BannerEscapeCodeAccessor.BannerEscapeCodeBuilder<ArgsParser>

Parameters:

aBannerEscCode - The banner Escape-Code to be stored by the banner Escape-Code property.

Returns:

The builder for applying multiple build operations.

withBannerFont

default ArgsParser withBannerFont(Font aBannerFont)

Sets the banner Font for the banner Font property.

Specified by:

withBannerFont in interface BannerFontAccessor.BannerFontBuilder<ArgsParser>

Parameters:

aBannerFont - The banner Font to be stored by the banner Font property.

Returns:

The builder for applying multiple build operations.

withBannerFontPalette

default ArgsParser withBannerFontPalette(char[] aColorPalette)

Sets the banner font palette for the banner font palette property.

Specified by:

withBannerFontPalette in interface BannerFontPaletteAccessor.BannerFontPaletteBuilder<ArgsParser>

Parameters:

aColorPalette - The banner font palette to be stored by the banner palette property.

Returns:

The builder for applying multiple build operations.

withCommandEscapeCode

default ArgsParser withCommandEscapeCode(String aCommandEscCode)

Sets the command Escape-Code for the command Escape-Code property.

Specified by:

withCommandEscapeCode in interface CommandEscapeCodeAccessor.CommandEscapeCodeBuilder<ArgsParser>

Parameters:

aCommandEscCode - The command Escape-Code to be stored by the command Escape-Code property.

Returns:

The builder for applying multiple build operations.

withConsoleWidth

default ArgsParser withConsoleWidth(int aConsoleWidth)

Specified by:

withConsoleWidth in interface ConsoleWidthAccessor.ConsoleWidthBuilder<ArgsParser>

withCopyright

default ArgsParser withCopyright(String aCopyright)

Sets the copyright for the copyright property.

Specified by:

withCopyright in interface CopyrightAccessor.CopyrightBuilder<ArgsParser>

Parameters:

aCopyright - The copyright to be stored by the console width property.

Returns:

The builder for applying multiple build operations.

withDescription

default ArgsParser withDescription(String aDescription)

Specified by:

withDescription in interface DescriptionAccessor.DescriptionBuilder<ArgsParser>

withDescriptionEscapeCode

default ArgsParser withDescriptionEscapeCode(String aDescriptionEscCode)

Sets the description Escape-Code for the description Escape-Code property.

Specified by:

withDescriptionEscapeCode in interface DescriptionEscapeCodeAccessor.DescriptionEscapeCodeBuilder<ArgsParser>

Parameters:

aDescriptionEscCode - The description Escape-Code to be stored by the description Escape-Code property.

Returns:

The builder for applying multiple build operations.

withErrorOut

default ArgsParser withErrorOut(PrintStream aErrorOut)

Set the error out PrintStream and make other adjustments with the result (with regards to the Builder-Pattern).

Specified by:

withErrorOut in interface ArgsProcessorBuilder<ArgsParser>

Parameters:

aErrorOut - The error out PrintStream to set.

Returns:

This instance with regard to the builder pattern.

withEscapeCodesEnabled

default ArgsParser withEscapeCodesEnabled(boolean isEscCodeEnabled)

Specified by:

withEscapeCodesEnabled in interface EscapeCodesStatusAccessor.EscapeCodeStatusBuilder<ArgsParser>

withEvalArgs

default ArgsParser withEvalArgs(List<String> aArgs)
                         throws ArgsSyntaxException

Evaluates the provided command line arguments .

Specified by:

withEvalArgs in interface ArgsParserBuilder<ArgsParser>

Parameters:

aArgs - The command line arguments to be evaluated.

Returns:

This instance as of the builder pattern to chain further method calls.

Throws:

ArgsSyntaxException - thrown in case of a command line arguments mismatch regarding provided and expected args.

withEvalArgs

default ArgsParser withEvalArgs(String[] aArgs)
                         throws ArgsSyntaxException

Evaluates the provided command line arguments.

Specified by:

withEvalArgs in interface ArgsParserBuilder<ArgsParser>

Parameters:

aArgs - The command line arguments to be evaluated.

Returns:

This instance as of the builder pattern to chain further method calls.

Throws:

ArgsSyntaxException - thrown in case of a command line arguments mismatch regarding provided and expected args.

withExamples

default ArgsParser withExamples(Collection<Example> aExamples)

Builder method providing the application's Example elements.

Specified by:

withExamples in interface ExamplesAccessor.ExamplesBuilder<ArgsParser>

Parameters:

aExamples - The application's Example elements to use.

Returns:

This builder as of the builder pattern.

withExamples

default ArgsParser withExamples(Example[] aExamples)

Sets the Example instances for the Example instances property.

Specified by:

withExamples in interface ExamplesAccessor.ExamplesBuilder<ArgsParser>

Parameters:

aExamples - The Example instances to be stored.

Returns:

The builder for applying multiple build operations.

withLicense

default ArgsParser withLicense(String aLicense)

Sets the license for the license property.

Specified by:

withLicense in interface LicenseAccessor.LicenseBuilder<ArgsParser>

Parameters:

aLicense - The license to be stored by the console width property.

Returns:

The builder for applying multiple build operations.

withLineBreak

default ArgsParser withLineBreak(String aLineBreak)

Specified by:

withLineBreak in interface LineBreakAccessor.LineBreakBuilder<ArgsParser>

withLineSeparatorEscapeCode

default ArgsParser withLineSeparatorEscapeCode(String aLineSeparatorEscCode)

Sets the line separator Escape-Code for the line separator Escape-Code property.

Specified by:

withLineSeparatorEscapeCode in interface LineSeparatorEscapeCodeAccessor.LineSeparatorEscapeCodeBuilder<ArgsParser>

Parameters:

aLineSeparatorEscCode - The line separator Escape-Code to be stored by the line separator Escape-Code property.

Returns:

The builder for applying multiple build operations.

withLongOptionPrefix

default ArgsParser withLongOptionPrefix(String aLongOptionPrefix)

Sets the long option prefix for the long option prefix property.

Specified by:

withLongOptionPrefix in interface LongOptionPrefixAccessor.LongOptionPrefixBuilder<ArgsParser>

Parameters:

aLongOptionPrefix - The long option prefix to be stored by the long option prefix property.

Returns:

The builder for applying multiple build operations.

withMaxConsoleWidth

default ArgsParser withMaxConsoleWidth(int aMaxConsoleWidth)

Specified by:

withMaxConsoleWidth in interface MaxConsoleWidthAccessor.MaxConsoleWidthBuilder<ArgsParser>

withName

default ArgsParser withName(String aName)

Specified by:

withName in interface NameAccessor.NameBuilder<ArgsParser>

withKeywordEscapeCode

default ArgsParser withKeywordEscapeCode(String aOptEscCode)

Sets the keyword (e.g. short- and long-options) Escape-Code for the keyword Escape-Code property.

Specified by:

withKeywordEscapeCode in interface KeywordEscapeCodeAccessor.KeywordEscapeCodeBuilder<ArgsParser>

Parameters:

aOptEscCode - The keyword (e.g. short- and long-options) Escape-Code to be stored by the option Escape-Code property.

Returns:

The builder for applying multiple build operations.

withResetEscapeCode

default ArgsParser withResetEscapeCode(String aResetEscCode)

Specified by:

withResetEscapeCode in interface ResetEscapeCodeAccessor.ResetEscapeCodeBuilder<ArgsParser>

withSeparatorLnChar

default ArgsParser withSeparatorLnChar(char aSeparatorLnChar)

Builder method adding an separator line char.

Specified by:

withSeparatorLnChar in interface ArgsProcessorBuilder<ArgsParser>

Parameters:

aSeparatorLnChar - THe according separator line char to use.

Returns:

This builder as of the builder pattern.

withShortOptionPrefix

default ArgsParser withShortOptionPrefix(Character aShortOptionPrefix)

Sets the short option prefix for the short option prefix property.

Specified by:

withShortOptionPrefix in interface ShortOptionPrefixAccessor.ShortOptionPrefixBuilder<ArgsParser>

Parameters:

aShortOptionPrefix - The short option prefix to be stored by the short option prefix property.

Returns:

The builder for applying multiple build operations.

withStandardOut

default ArgsParser withStandardOut(PrintStream aStandardOut)

Set the standard out PrintStream and make other adjustments with the result (with regards to the Builder-Pattern).

Specified by:

withStandardOut in interface ArgsProcessorBuilder<ArgsParser>

Parameters:

aStandardOut - The standard out PrintStream to set.

Returns:

This instance with regard to the builder pattern.

withSyntaxMetrics

default ArgsParser withSyntaxMetrics(SyntaxMetrics aSyntaxMetrics)

Sets the SyntaxMetrics for the SyntaxMetrics property.

Specified by:

withSyntaxMetrics in interface SyntaxMetricsAccessor.SyntaxMetricsBuilder<ArgsParser>

Parameters:

aSyntaxMetrics - The SyntaxMetrics to be stored by the SyntaxMetrics property.

Returns:

The builder for applying multiple build operations.

withTextBoxGrid

default ArgsParser withTextBoxGrid(TextBoxGrid aTextBoxGrid)

Specified by:

withTextBoxGrid in interface TextBoxGridAccessor.TextBoxGridBuilder<ArgsParser>

withTextBoxGrid

default ArgsParser withTextBoxGrid(TextBoxStyle aTextBoxStyle)

Specified by:

withTextBoxGrid in interface TextBoxGridAccessor.TextBoxGridBuilder<ArgsParser>

withTitle

default ArgsParser withTitle(String aTitle)

Specified by:

withTitle in interface TitleAccessor.TitleBuilder<ArgsParser>