Class CliArgsParser

java.lang.Object

org.refcodes.cli.CliArgsParser

All Implemented Interfaces:

ArgsParser, 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, CopyrightAccessor, CopyrightAccessor.CopyrightBuilder<ArgsParser>, CopyrightAccessor.CopyrightMutator, CopyrightAccessor.CopyrightProperty, DescriptionEscapeCodeAccessor, DescriptionEscapeCodeAccessor.DescriptionEscapeCodeBuilder<ArgsParser>, DescriptionEscapeCodeAccessor.DescriptionEscapeCodeMutator, DescriptionEscapeCodeAccessor.DescriptionEscapeCodeProperty, ExamplesAccessor, ExamplesAccessor.ExamplesBuilder<ArgsParser>, ExamplesAccessor.ExamplesMutator, ExamplesAccessor.ExamplesProperty, KeywordEscapeCodeAccessor, KeywordEscapeCodeAccessor.KeywordEscapeCodeBuilder<ArgsParser>, KeywordEscapeCodeAccessor.KeywordEscapeCodeMutator, KeywordEscapeCodeAccessor.KeywordEscapeCodeProperty, LicenseAccessor, LicenseAccessor.LicenseBuilder<ArgsParser>, LicenseAccessor.LicenseMutator, LicenseAccessor.LicenseProperty, LineSeparatorEscapeCodeAccessor, LineSeparatorEscapeCodeAccessor.LineSeparatorEscapeCodeBuilder<ArgsParser>, LineSeparatorEscapeCodeAccessor.LineSeparatorEscapeCodeMutator, LineSeparatorEscapeCodeAccessor.LineSeparatorEscapeCodeProperty, LongOptionPrefixAccessor, LongOptionPrefixAccessor.LongOptionPrefixBuilder<ArgsParser>, LongOptionPrefixAccessor.LongOptionPrefixMutator, LongOptionPrefixAccessor.LongOptionPrefixProperty, Optionable, ShortOptionPrefixAccessor, ShortOptionPrefixAccessor.ShortOptionPrefixBuilder<ArgsParser>, ShortOptionPrefixAccessor.ShortOptionPrefixMutator, ShortOptionPrefixAccessor.ShortOptionPrefixProperty, SyntaxMetricsAccessor, SyntaxMetricsAccessor.SyntaxMetricsBuilder<ArgsParser>, SyntaxMetricsAccessor.SyntaxMetricsMutator, SyntaxMetricsAccessor.SyntaxMetricsProperty, ConsoleWidthAccessor, ConsoleWidthAccessor.ConsoleWidthBuilder<ArgsParser>, ConsoleWidthAccessor.ConsoleWidthMutator, ConsoleWidthAccessor.ConsoleWidthProperty, DescriptionAccessor, DescriptionAccessor.DescriptionBuilder<ArgsParser>, DescriptionAccessor.DescriptionMutator, DescriptionAccessor.DescriptionProperty, EscapeCodesStatusAccessor, EscapeCodesStatusAccessor.EscapeCodeStatusBuilder<ArgsParser>, EscapeCodesStatusAccessor.EscapeCodeStatusMutator, EscapeCodesStatusAccessor.EscapeCodeStatusProperty, LineBreakAccessor, LineBreakAccessor.LineBreakBuilder<ArgsParser>, LineBreakAccessor.LineBreakMutator, LineBreakAccessor.LineBreakProperty, MaxConsoleWidthAccessor, MaxConsoleWidthAccessor.MaxConsoleWidthBuilder<ArgsParser>, MaxConsoleWidthAccessor.MaxConsoleWidthMutator, MaxConsoleWidthAccessor.MaxConsoleWidthProperty, NameAccessor, NameAccessor.NameBuilder<ArgsParser>, NameAccessor.NameMutator, NameAccessor.NameProperty, Resetable, ResetEscapeCodeAccessor, ResetEscapeCodeAccessor.ResetEscapeCodeBuilder<ArgsParser>, ResetEscapeCodeAccessor.ResetEscapeCodeMutator, ResetEscapeCodeAccessor.ResetEscapeCodeProperty, TitleAccessor, TitleAccessor.TitleBuilder<ArgsParser>, TitleAccessor.TitleMutator, TitleAccessor.TitleProperty, Diagnosable, Schemable<DiagnosticOptions>, TextBoxGridAccessor, TextBoxGridAccessor.TextBoxGridBuilder<ArgsParser>, TextBoxGridAccessor.TextBoxGridMutator, TextBoxGridAccessor.TextBoxGridProperty

public class CliArgsParser
extends Object
implements ArgsParser

A straightforward implementation of the ArgsParser interface. The constructor only provides means to set the required attributes as the attributes to be adjusted optionally are already sufficiently preconfigured. For adjusting them, a flavor of the Builder-Pattern is provided with which you can easily chain the configuration of this instance; as them methods return the instance of this class being configured. This helps to prevent the telescoping constructor anti-pattern.

The SyntaxNotation is pre-set with the SyntaxNotation.LOGICAL notation.

The console width id preconfigured with the console's width as determined by the SystemUtility.getTerminalWidth().

The standard out PrintStream is preconfigured with the System.out PrintStream.

The newline characters to be used for line breaks is "\r\n" on Windows machines and "\"n" on all other machines as of the SystemUtility.getLineBreak().

See Also:

• "http://en.wikipedia.org/wiki/Builder_pattern"

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

Field Summary

Fields

Modifier and Type	Field	Description
protected PrintStream	_errStream
protected PrintStream	_stdStream

Constructor Summary

Constructors

Constructor	Description
CliArgsParser()	Constructs the ArgsParser instance without any restrictions to the parsed arguments.
CliArgsParser(CliContext aCliCtx)	Constructs the ArgsParser instance without any restrictions to the parsed arguments.
CliArgsParser(Term aArgsSyntax)	Constructs the ArgsParser instance with the given root Condition and the default SyntaxNotation.LOGICAL.
CliArgsParser(Term aArgsSyntax, CliContext aCliCtx)	Constructs the ArgsParser instance with the given root Condition and the default SyntaxNotation.LOGICAL.

Method Summary

Modifier and Type	Method	Description
void	addExample(Example aExampleUsage)	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 ArgsParser.withConsoleWidth(int) method.
Operand<?>[]	evalArgs(String[] aArgs)	Evaluates the provided command line arguments and determines the according values by evaluating the root Condition.
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.
Font	getBannerFont()	Retrieves the banner Font from the banner Font property.
char[]	getBannerFontPalette()	Retrieves the banner font palette from the banner font palette property.
String	getCommandEscapeCode()	Retrieves the command Escape-Code from the command Escape-Code property.
int	getConsoleWidth()
String	getCopyright()	Retrieves the copyright from the copyright property.
protected char	getDelimiter()	The delimiter to be used for colliding command line args when creating non colliding arg's aliases (keys for key/value-pairs).
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	getLineBreak()
String	getLineSeparatorEscapeCode()	Retrieves the line separator Escape-Code from the line separator Escape-Code property.
String	getLongOptionPrefix()	Retrieves the long option prefix from the long option prefix property.
int	getMaxConsoleWidth()
String	getName()
String	getResetEscapeCode()
char	getSeparatorLnChar()	Gets the character to be used when printing a separator line with the ArgsParser.printSeparatorLn() method.
Character	getShortOptionPrefix()	Retrieves the short option prefix from the short option prefix property.
SyntaxMetrics	getSyntaxMetrics()	Retrieves the SyntaxMetrics from the SyntaxMetrics property.
TextBoxGrid	getTextBoxGrid()
String	getTitle()
boolean	isEscapeCodesEnabled()
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.
void	printCopyright()	Prints the copyright note as specified by the ArgsParser.withCopyright(String) method; with regards to the console width as specified by the ArgsParser.withConsoleWidth(int) method.
void	printDescription()	Prints the description as set by the ArgsParser.withDescription(String) method with regards to the console width as specified by the ArgsParser.withConsoleWidth(int) method.
void	printExamples()	Prints example usages as as added by the ArgsParser.addExample(String, Operand...) method with regards to the console width as specified by the ArgsParser.withConsoleWidth(int) method.
void	printHeader()	Prints the header, which might be a simplified banner: Can be used when overriding methods such as ArgsParser.printHelp() or ArgsParser.printBanner().
void	printLicense()	Prints the license note as specified by the ArgsParser.withLicense(String) method; with regards to the console width as specified by the ArgsParser.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 ArgsParser.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 ArgsParser.withConsoleWidth(int) method.
void	printSeparatorLn()	Prints a separator line using the separator character as specified by the ArgsParser.withSeparatorLnChar(char) method; with regards to the console width as specified by the ArgsParser.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 ArgsParser.withSyntaxMetrics(SyntaxMetrics) method.
void	reset()
void	setArgsSyntax(Term aArgsSyntax)	Sets the (root) Term for the (root) Term property.
void	setArgumentEscapeCode(String aParamEscapeCode)	Sets the argument Escape-Code for the argument Escape-Code property.
void	setBannerBorderEscapeCode(String aBannerBorderEscapeCode)	Sets the banner border Escape-Code for the banner border Escape-Code property.
void	setBannerEscapeCode(String aBannerEscapeCode)	Sets the banner Escape-Code for the banner Escape-Code property.
void	setBannerFont(Font aBannerFont)	Sets the banner Font for the banner Font property.
void	setBannerFontPalette(char[] aColorPalette)	Sets the banner font palette for the banner font palette property.
void	setBannerFontPalette(AsciiColorPalette aBannerFontPalette)	Sets the banner font palette for the banner font palette property.
void	setCommandEscapeCode(String aCommandEscapeCode)	Sets the command Escape-Code for the command Escape-Code property.
void	setConsoleWidth(int aConsoleWidth)
void	setCopyright(String aCopyrightNote)	Sets the copyright for the copyright property.
void	setDescription(String aDescription)
void	setDescriptionEscapeCode(String aDescriptionEscapeCode)	Sets the description Escape-Code for the description Escape-Code property.
void	setErrorOut(PrintStream aErrorOut)	Set the error out PrintStream and make other adjustments with the result (with regards to the Builder-Pattern).
void	setEscapeCodesEnabled(boolean isEscapeCodesEnabled)
void	setExamples(Example[] aExamples)	Sets the Example instances for the Example instances property.
void	setKeywordEscapeCode(String aOptEscapeCode)	Sets the keyword (e.g. short- and long-options) Escape-Code for the option Escape-Code property.
void	setLicense(String aLicenseNote)	Sets the license for the license property.
void	setLineBreak(String aLineBreak)
void	setLineSeparatorEscapeCode(String aLineSeparatorEscapeCode)	Sets the line separator Escape-Code for the line separator Escape-Code property.
void	setLongOptionPrefix(String aLongOptionPrefix)	Sets the long option prefix for the long option prefix property.
void	setMaxConsoleWidth(int aMaxConsoleWidth)
void	setName(String aName)
void	setResetEscapeCode(String aResetEscapeCode)
void	setSeparatorLnChar(char aSeparatorLnChar)	Set the character to be used when printing a separator line with the ArgsParser.printSeparatorLn() method.
void	setShortOptionPrefix(Character aShortOptionPrefix)	Sets the short option prefix for the short option prefix property.
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.
void	setTextBoxGrid(TextBoxGrid aTextBoxGrid)
void	setTitle(String aTitle)
CliArgsParser	withAddExample(String aDescription, Operand<?>... aOperands)	Builder method adding an application's Example element.
CliArgsParser	withAddExample(Example aExamples)	Builder method adding an application's Example element.
CliArgsParser	withArgsSyntax(Term aArgsSyntax)	Sets the (root) Term for the (root) Term property.
CliArgsParser	withArgumentEscapeCode(String aParamEscCode)	Sets the argument Escape-Code for the argument Escape-Code property.
CliArgsParser	withBannerBorderEscapeCode(String aBannerBorderEscCode)	Sets the banner border Escape-Code for the banner border Escape-Code property.
CliArgsParser	withBannerEscapeCode(String aBannerEscCode)	Sets the banner Escape-Code for the banner Escape-Code property.
CliArgsParser	withBannerFont(Font aBannerFont)	Sets the banner Font for the banner Font property.
CliArgsParser	withBannerFontPalette(char[] aColorPalette)	Sets the banner font palette for the banner font palette property.
CliArgsParser	withBannerFontPalette(AsciiColorPalette aBannerFontPalette)	Sets the banner font palette for the banner font palette property.
CliArgsParser	withCommandEscapeCode(String aCommandEscCode)	Sets the command Escape-Code for the command Escape-Code property.
CliArgsParser	withConsoleWidth(int aConsoleWidth)
CliArgsParser	withCopyright(String aCopyright)	Sets the copyright for the copyright property.
CliArgsParser	withDescription(String aDescription)
CliArgsParser	withDescriptionEscapeCode(String aDescriptionEscCode)	Sets the description Escape-Code for the description Escape-Code property.
CliArgsParser	withErrorOut(PrintStream aErrorOut)	Set the error out PrintStream and make other adjustments with the result (with regards to the Builder-Pattern).
CliArgsParser	withEscapeCodesEnabled(boolean aIsEscCodeEnabled)
CliArgsParser	withEvalArgs(String[] aArgs)	Evaluates the provided command line arguments.
CliArgsParser	withEvalArgs(String[] aArgs, Pattern aFilterExp)	Evaluates the provided command line arguments, filtering (excluding) the arguments matching the provided Pattern.
CliArgsParser	withEvalArgs(String[] aArgs, ArgsFilter aArgsFilter)	Evaluates the provided command line arguments, filtering (excluding) the arguments matching the provided ArgsFilter.
CliArgsParser	withEvalArgs(List<String> aArgs)	Evaluates the provided command line arguments .
CliArgsParser	withEvalArgs(List<String> aArgs, Pattern aFilterExp)	Evaluates the provided command line arguments, filtering (excluding) the arguments matching the provided Pattern.
CliArgsParser	withEvalArgs(List<String> aArgs, ArgsFilter aArgsFilter)	Evaluates the provided command line arguments, filtering (excluding) the arguments matching the provided ArgsFilter.
CliArgsParser	withExamples(Collection<Example> aExamples)	Builder method providing the application's Example elements.
CliArgsParser	withExamples(Example[] aExamples)	Sets the Example instances for the Example instances property.
CliArgsParser	withKeywordEscapeCode(String aOptEscCode)	Sets the keyword (e.g. short- and long-options) Escape-Code for the keyword Escape-Code property.
CliArgsParser	withLicense(String aLicense)	Sets the license for the license property.
CliArgsParser	withLineBreak(String aLineBreak)
CliArgsParser	withLineSeparatorEscapeCode(String aLineSeparatorEscCode)	Sets the line separator Escape-Code for the line separator Escape-Code property.
CliArgsParser	withLongOptionPrefix(String aLongOptionPrefix)	Sets the long option prefix for the long option prefix property.
CliArgsParser	withMaxConsoleWidth(int aMaxConsoleWidth)
CliArgsParser	withName(String aName)
CliArgsParser	withResetEscapeCode(String aResetEscCode)
CliArgsParser	withSeparatorLnChar(char aSeparatorLnChar)	Builder method adding an separator line char.
CliArgsParser	withShortOptionPrefix(Character aShortOptionPrefix)	Sets the short option prefix for the short option prefix property.
CliArgsParser	withStandardOut(PrintStream aStandardOut)	Set the standard out PrintStream and make other adjustments with the result (with regards to the Builder-Pattern).
CliArgsParser	withSyntaxMetrics(SyntaxMetrics aSyntaxMetrics)	Sets the SyntaxMetrics for the SyntaxMetrics property.
CliArgsParser	withSyntaxMetrics(SyntaxNotation aSyntaxNotation)	Sets the SyntaxNotation for the SyntaxNotation property.
CliArgsParser	withTextBoxGrid(TextBoxGrid aTextBoxGrid)
CliArgsParser	withTextBoxGrid(TextBoxStyle aTextBoxStyle)
CliArgsParser	withTitle(String aTitle)

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface ArgsParser

addExample, evalArgs, evalArgs, evalArgs, evalArgs, evalArgs, printBody, printHelp, toOptions, toSchema

Methods inherited from interface ArgsSyntaxAccessor.ArgsSyntaxProperty

letArgsSyntax

Methods inherited from interface ArgumentEscapeCodeAccessor.ArgumentEscapeCodeProperty

letArgumentEscapeCode

Methods inherited from interface BannerBorderEscapeCodeAccessor.BannerBorderEscapeCodeProperty

letBannerBorderEscapeCode

Methods inherited from interface BannerEscapeCodeAccessor.BannerEscapeCodeProperty

letBannerEscapeCode

Methods inherited from interface BannerFontAccessor.BannerFontProperty

letBannerFont

Methods inherited from interface BannerFontPaletteAccessor.BannerFontPaletteProperty

letBannerFontPalette

Methods inherited from interface CommandEscapeCodeAccessor.CommandEscapeCodeProperty

letCommandEscapeCode

Methods inherited from interface ConsoleWidthAccessor.ConsoleWidthProperty

letConsoleWidth

Methods inherited from interface CopyrightAccessor.CopyrightProperty

letCopyright

Methods inherited from interface DescriptionAccessor.DescriptionProperty

letDescription

Methods inherited from interface DescriptionEscapeCodeAccessor.DescriptionEscapeCodeProperty

letDescriptionEscapeCode

Methods inherited from interface EscapeCodesStatusAccessor.EscapeCodeStatusProperty

letEscapeCodesEnabled

Methods inherited from interface ExamplesAccessor.ExamplesMutator

setExamples

Methods inherited from interface ExamplesAccessor.ExamplesProperty

letExamples

Methods inherited from interface KeywordEscapeCodeAccessor.KeywordEscapeCodeProperty

letKeywordEscapeCode

Methods inherited from interface LicenseAccessor.LicenseProperty

letLicense

Methods inherited from interface LineBreakAccessor.LineBreakProperty

letLineBreak

Methods inherited from interface LineSeparatorEscapeCodeAccessor.LineSeparatorEscapeCodeProperty

letLineSeparatorEscapeCode

Methods inherited from interface LongOptionPrefixAccessor.LongOptionPrefixProperty

letLongOptionPrefix

Methods inherited from interface MaxConsoleWidthAccessor.MaxConsoleWidthProperty

letMaxConsoleWidth

Methods inherited from interface NameAccessor.NameProperty

letName

Methods inherited from interface ResetEscapeCodeAccessor.ResetEscapeCodeProperty

letResetEscapeCode

Methods inherited from interface Schemable

toSchema

Methods inherited from interface ShortOptionPrefixAccessor.ShortOptionPrefixProperty

letShortOptionPrefix

Methods inherited from interface SyntaxMetricsAccessor.SyntaxMetricsMutator

setSyntaxMetrics

Methods inherited from interface SyntaxMetricsAccessor.SyntaxMetricsProperty

letSyntaxMetrics, letSyntaxMetrics

Methods inherited from interface TextBoxGridAccessor.TextBoxGridMutator

setTextBoxGrid

Methods inherited from interface TextBoxGridAccessor.TextBoxGridProperty

letTextBoxGrid, letTextBoxGrid

Methods inherited from interface TitleAccessor.TitleProperty

letTitle

Field Details

_errStream

protected PrintStream _errStream

_stdStream

protected PrintStream _stdStream

Constructor Details

CliArgsParser

public CliArgsParser()

Constructs the ArgsParser instance without any restrictions to the parsed arguments. The constructor only provides means to set the required attributes as the attributes to be adjusted optionally are already sufficiently preconfigured. For adjusting them, a flavor of the Builder-Pattern is provided with which you can easily chain the configuration of this instance; as them methods return the instance of this class being configured.

CliArgsParser

public CliArgsParser(CliContext aCliCtx)

Constructs the ArgsParser instance without any restrictions to the parsed arguments. The constructor only provides means to set the required attributes as the attributes to be adjusted optionally are already sufficiently preconfigured. For adjusting them, a flavor of the Builder-Pattern is provided with which you can easily chain the configuration of this instance; as them methods return the instance of this class being configured.

Parameters:

aCliCtx - The CliContext to be used for initializing.

CliArgsParser

public CliArgsParser(Term aArgsSyntax)

Constructs the ArgsParser instance with the given root Condition and the default SyntaxNotation.LOGICAL. The constructor only provides means to set the required attributes as the attributes to be adjusted optionally are already sufficiently preconfigured. For adjusting them, a flavor of the Builder-Pattern is provided with which you can easily chain the configuration of this instance; as them methods return the instance of this class being configured.

Parameters:

aArgsSyntax - The args syntax root Term node being the node from which parsing the command line arguments starts.

CliArgsParser

public CliArgsParser(Term aArgsSyntax,
 CliContext aCliCtx)

Constructs the ArgsParser instance with the given root Condition and the default SyntaxNotation.LOGICAL. The constructor only provides means to set the required attributes as the attributes to be adjusted optionally are already sufficiently preconfigured. For adjusting them, a flavor of the Builder-Pattern is provided with which you can easily chain the configuration of this instance; as them methods return the instance of this class being configured.

Parameters:

aArgsSyntax - The args syntax root Term node being the node from which parsing the command line arguments starts.

aCliCtx - The CliContext to be used for initializing.

Method Details

addExample

public void addExample(Example aExampleUsage)

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

Specified by:

addExample in interface ArgsParser

Parameters:

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

errorLn

public void errorLn(String aLine)

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

Specified by:

errorLn in interface ArgsParser

Parameters:

aLine - The line to be printed.

evalArgs

public 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 ArgsParser.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.

Specified by:

evalArgs in interface ArgsParser

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.

getArgsSyntax

public Term getArgsSyntax()

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

Specified by:

getArgsSyntax in interface ArgsParser

Specified by:

getArgsSyntax in interface ArgsSyntaxAccessor

Returns:

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

getArgumentEscapeCode

public String getArgumentEscapeCode()

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

Specified by:

getArgumentEscapeCode in interface ArgsParser

Specified by:

getArgumentEscapeCode in interface ArgumentEscapeCodeAccessor

Returns:

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

getBannerBorderEscapeCode

public String getBannerBorderEscapeCode()

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

Specified by:

getBannerBorderEscapeCode in interface ArgsParser

Specified by:

getBannerBorderEscapeCode in interface BannerBorderEscapeCodeAccessor

Returns:

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

getBannerEscapeCode

public String getBannerEscapeCode()

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

Specified by:

getBannerEscapeCode in interface ArgsParser

Specified by:

getBannerEscapeCode in interface BannerEscapeCodeAccessor

Returns:

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

getBannerFont

public Font getBannerFont()

Retrieves the banner Font from the banner Font property.

Specified by:

getBannerFont in interface BannerFontAccessor

Returns:

The banner Font stored by the banner Font property.

getBannerFontPalette

public char[] getBannerFontPalette()

Retrieves the banner font palette from the banner font palette property.

Specified by:

getBannerFontPalette in interface BannerFontPaletteAccessor

Returns:

The banner font palette stored by the banner font palette property.

getCommandEscapeCode

public String getCommandEscapeCode()

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

Specified by:

getCommandEscapeCode in interface ArgsParser

Specified by:

getCommandEscapeCode in interface CommandEscapeCodeAccessor

Returns:

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

getConsoleWidth

public int getConsoleWidth()

Specified by:

getConsoleWidth in interface ConsoleWidthAccessor

getCopyright

public String getCopyright()

Retrieves the copyright from the copyright property.

Specified by:

getCopyright in interface ArgsParser

Specified by:

getCopyright in interface CopyrightAccessor

Returns:

The copyright stored by the copyright property.

getDescription

public String getDescription()

Specified by:

getDescription in interface ArgsParser

Specified by:

getDescription in interface DescriptionAccessor

getDescriptionEscapeCode

public String getDescriptionEscapeCode()

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

Specified by:

getDescriptionEscapeCode in interface ArgsParser

Specified by:

getDescriptionEscapeCode in interface DescriptionEscapeCodeAccessor

Returns:

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

getExamples

public Example[] getExamples()

Retrieves the Example instances from the Example instances property.

Specified by:

getExamples in interface ArgsParser

Specified by:

getExamples in interface ExamplesAccessor

Returns:

The Example instances stored by the Example instances property.

getLicense

public String getLicense()

Retrieves the license from the license property.

Specified by:

getLicense in interface ArgsParser

Specified by:

getLicense in interface LicenseAccessor

Returns:

The license stored by the license property.

getLineBreak

public String getLineBreak()

Specified by:

getLineBreak in interface LineBreakAccessor

getLineSeparatorEscapeCode

public String getLineSeparatorEscapeCode()

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

Specified by:

getLineSeparatorEscapeCode in interface ArgsParser

Specified by:

getLineSeparatorEscapeCode in interface LineSeparatorEscapeCodeAccessor

Returns:

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

getLongOptionPrefix

public String getLongOptionPrefix()

Retrieves the long option prefix from the long option prefix property.

Specified by:

getLongOptionPrefix in interface LongOptionPrefixAccessor

Returns:

The long option prefix stored by the long option prefix property.

getMaxConsoleWidth

public int getMaxConsoleWidth()

Specified by:

getMaxConsoleWidth in interface MaxConsoleWidthAccessor

getName

public String getName()

Specified by:

getName in interface NameAccessor

getKeywordEscapeCode

public String getKeywordEscapeCode()

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

Specified by:

getKeywordEscapeCode in interface ArgsParser

Specified by:

getKeywordEscapeCode in interface KeywordEscapeCodeAccessor

Returns:

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

getResetEscapeCode

public String getResetEscapeCode()

Specified by:

getResetEscapeCode in interface ResetEscapeCodeAccessor

getSeparatorLnChar

public char getSeparatorLnChar()

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

Specified by:

getSeparatorLnChar in interface ArgsParser

Returns:

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

getShortOptionPrefix

public Character getShortOptionPrefix()

Retrieves the short option prefix from the short option prefix property.

Specified by:

getShortOptionPrefix in interface ShortOptionPrefixAccessor

Returns:

The short option prefix stored by the short option prefix property.

getSyntaxMetrics

public SyntaxMetrics getSyntaxMetrics()

Retrieves the SyntaxMetrics from the SyntaxMetrics property.

Specified by:

getSyntaxMetrics in interface SyntaxMetricsAccessor

Returns:

The SyntaxMetrics stored by the decorator (enabled) tags property.

getTextBoxGrid

public TextBoxGrid getTextBoxGrid()

Specified by:

getTextBoxGrid in interface TextBoxGridAccessor

getTitle

public String getTitle()

Specified by:

getTitle in interface TitleAccessor

isEscapeCodesEnabled

public boolean isEscapeCodesEnabled()

Specified by:

isEscapeCodesEnabled in interface EscapeCodesStatusAccessor

printBanner

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

Specified by:

printBanner in interface ArgsParser

printCopyright

public void printCopyright()

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

Specified by:

printCopyright in interface ArgsParser

printDescription

public void printDescription()

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

Specified by:

printDescription in interface ArgsParser

printExamples

public void printExamples()

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

Specified by:

printExamples in interface ArgsParser

printHeader

public void printHeader()

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

Specified by:

printHeader in interface ArgsParser

printLicense

public void printLicense()

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

Specified by:

printLicense in interface ArgsParser

printLn

public void printLn()

Prints an empty line / a line break.

Specified by:

printLn in interface ArgsParser

printLn

public void printLn(String aLine)

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

Specified by:

printLn in interface ArgsParser

Parameters:

aLine - The line to be printed.

printOptions

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

Specified by:

printOptions in interface ArgsParser

printSeparatorLn

public void printSeparatorLn()

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

Specified by:

printSeparatorLn in interface ArgsParser

printSynopsis

public 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 ArgsParser.withSyntaxMetrics(SyntaxMetrics) method.

Specified by:

printSynopsis in interface ArgsParser

reset

public void reset()

Specified by:

reset in interface Resetable

setArgsSyntax

public void setArgsSyntax(Term aArgsSyntax)

Sets the (root) Term for the (root) Term property.

Specified by:

setArgsSyntax in interface ArgsSyntaxAccessor.ArgsSyntaxMutator

Parameters:

aArgsSyntax - The (root) Term to be stored by the (root) Term property.

setArgumentEscapeCode

public void setArgumentEscapeCode(String aParamEscapeCode)

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

Specified by:

setArgumentEscapeCode in interface ArgumentEscapeCodeAccessor.ArgumentEscapeCodeMutator

Parameters:

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

setBannerBorderEscapeCode

public void setBannerBorderEscapeCode(String aBannerBorderEscapeCode)

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

Specified by:

setBannerBorderEscapeCode in interface BannerBorderEscapeCodeAccessor.BannerBorderEscapeCodeMutator

Parameters:

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

setBannerEscapeCode

public void setBannerEscapeCode(String aBannerEscapeCode)

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

Specified by:

setBannerEscapeCode in interface BannerEscapeCodeAccessor.BannerEscapeCodeMutator

Parameters:

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

setBannerFont

public void setBannerFont(Font aBannerFont)

Sets the banner Font for the banner Font property.

Specified by:

setBannerFont in interface BannerFontAccessor.BannerFontMutator

Parameters:

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

setBannerFontPalette

public void setBannerFontPalette(AsciiColorPalette aBannerFontPalette)

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

Specified by:

setBannerFontPalette in interface BannerFontPaletteAccessor.BannerFontPaletteMutator

Parameters:

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

setBannerFontPalette

public void setBannerFontPalette(char[] aColorPalette)

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

Specified by:

setBannerFontPalette in interface BannerFontPaletteAccessor.BannerFontPaletteMutator

Parameters:

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

setCommandEscapeCode

public void setCommandEscapeCode(String aCommandEscapeCode)

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

Specified by:

setCommandEscapeCode in interface CommandEscapeCodeAccessor.CommandEscapeCodeMutator

Parameters:

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

setConsoleWidth

public void setConsoleWidth(int aConsoleWidth)

Specified by:

setConsoleWidth in interface ConsoleWidthAccessor.ConsoleWidthMutator

setCopyright

public void setCopyright(String aCopyrightNote)

Sets the copyright for the copyright property.

Specified by:

setCopyright in interface CopyrightAccessor.CopyrightMutator

Parameters:

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

setDescription

public void setDescription(String aDescription)

Specified by:

setDescription in interface DescriptionAccessor.DescriptionMutator

setDescriptionEscapeCode

public void setDescriptionEscapeCode(String aDescriptionEscapeCode)

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

Specified by:

setDescriptionEscapeCode in interface DescriptionEscapeCodeAccessor.DescriptionEscapeCodeMutator

Parameters:

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

setErrorOut

public void setErrorOut(PrintStream aErrorOut)

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

Specified by:

setErrorOut in interface ArgsParser

Parameters:

aErrorOut - The error out PrintStream to set.

setEscapeCodesEnabled

public void setEscapeCodesEnabled(boolean isEscapeCodesEnabled)

Specified by:

setEscapeCodesEnabled in interface EscapeCodesStatusAccessor.EscapeCodeStatusMutator

setExamples

public void setExamples(Example[] aExamples)

Sets the Example instances for the Example instances property.

Specified by:

setExamples in interface ExamplesAccessor.ExamplesMutator

Parameters:

aExamples - The Example instances to be stored.

setLicense

public void setLicense(String aLicenseNote)

Sets the license for the license property.

Specified by:

setLicense in interface LicenseAccessor.LicenseMutator

Parameters:

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

setLineBreak

public void setLineBreak(String aLineBreak)

Specified by:

setLineBreak in interface LineBreakAccessor.LineBreakMutator

setLineSeparatorEscapeCode

public void setLineSeparatorEscapeCode(String aLineSeparatorEscapeCode)

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

Specified by:

setLineSeparatorEscapeCode in interface ArgsParser

Specified by:

setLineSeparatorEscapeCode in interface LineSeparatorEscapeCodeAccessor.LineSeparatorEscapeCodeMutator

Parameters:

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

setLongOptionPrefix

public void setLongOptionPrefix(String aLongOptionPrefix)

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

Specified by:

setLongOptionPrefix in interface LongOptionPrefixAccessor.LongOptionPrefixMutator

Parameters:

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

setMaxConsoleWidth

public void setMaxConsoleWidth(int aMaxConsoleWidth)

Specified by:

setMaxConsoleWidth in interface MaxConsoleWidthAccessor.MaxConsoleWidthMutator

setName

public void setName(String aName)

Specified by:

setName in interface NameAccessor.NameMutator

setKeywordEscapeCode

public void setKeywordEscapeCode(String aOptEscapeCode)

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

Specified by:

setKeywordEscapeCode in interface KeywordEscapeCodeAccessor.KeywordEscapeCodeMutator

Parameters:

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

setResetEscapeCode

public void setResetEscapeCode(String aResetEscapeCode)

Specified by:

setResetEscapeCode in interface ResetEscapeCodeAccessor.ResetEscapeCodeMutator

setSeparatorLnChar

public void setSeparatorLnChar(char aSeparatorLnChar)

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

Specified by:

setSeparatorLnChar in interface ArgsParser

Parameters:

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

setShortOptionPrefix

public void setShortOptionPrefix(Character aShortOptionPrefix)

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

Specified by:

setShortOptionPrefix in interface ShortOptionPrefixAccessor.ShortOptionPrefixMutator

Parameters:

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

setStandardOut

public void setStandardOut(PrintStream aStandardOut)

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

Specified by:

setStandardOut in interface ArgsParser

Parameters:

aStandardOut - The standard out PrintStream to set.

setSyntaxMetrics

public void setSyntaxMetrics(SyntaxMetrics aSyntaxMetrics)

Sets the SyntaxMetrics for the SyntaxMetrics property.

Specified by:

setSyntaxMetrics in interface ArgsParser

Specified by:

setSyntaxMetrics in interface SyntaxMetricsAccessor.SyntaxMetricsMutator

Parameters:

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

setTextBoxGrid

public void setTextBoxGrid(TextBoxGrid aTextBoxGrid)

Specified by:

setTextBoxGrid in interface TextBoxGridAccessor.TextBoxGridMutator

setTitle

public void setTitle(String aTitle)

Specified by:

setTitle in interface TitleAccessor.TitleMutator

withAddExample

public CliArgsParser withAddExample(Example aExamples)

Builder method adding an application's Example element.

Specified by:

withAddExample in interface ArgsParser

Specified by:

withAddExample in interface ArgsProcessorBuilder<ArgsParser>

Parameters:

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

Returns:

This builder as of the builder pattern.

withAddExample

public CliArgsParser withAddExample(String aDescription,
 Operand<?>... aOperands)

Builder method adding an application's Example element.

Specified by:

withAddExample in interface ArgsParser

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.

withArgsSyntax

public CliArgsParser withArgsSyntax(Term aArgsSyntax)

Sets the (root) Term for the (root) Term property.

Specified by:

withArgsSyntax in interface ArgsSyntaxAccessor.ArgsSyntaxBuilder<ArgsParser>

Parameters:

aArgsSyntax - The (root) Term to be stored by the (root) Term property.

Returns:

The builder for applying multiple build operations.

withArgumentEscapeCode

public CliArgsParser withArgumentEscapeCode(String aParamEscCode)

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

Specified by:

withArgumentEscapeCode in interface ArgsParser

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

public CliArgsParser withBannerBorderEscapeCode(String aBannerBorderEscCode)

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

Specified by:

withBannerBorderEscapeCode in interface ArgsParser

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

public CliArgsParser withBannerEscapeCode(String aBannerEscCode)

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

Specified by:

withBannerEscapeCode in interface ArgsParser

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

public CliArgsParser withBannerFont(Font aBannerFont)

Sets the banner Font for the banner Font property.

Specified by:

withBannerFont in interface ArgsParser

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

public CliArgsParser withBannerFontPalette(AsciiColorPalette aBannerFontPalette)

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

Specified by:

withBannerFontPalette in interface BannerFontPaletteAccessor.BannerFontPaletteBuilder<ArgsParser>

Parameters:

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

Returns:

The builder for applying multiple build operations.

withBannerFontPalette

public CliArgsParser withBannerFontPalette(char[] aColorPalette)

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

Specified by:

withBannerFontPalette in interface ArgsParser

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

public CliArgsParser withCommandEscapeCode(String aCommandEscCode)

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

Specified by:

withCommandEscapeCode in interface ArgsParser

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

public CliArgsParser withConsoleWidth(int aConsoleWidth)

Specified by:

withConsoleWidth in interface ArgsParser

Specified by:

withConsoleWidth in interface ConsoleWidthAccessor.ConsoleWidthBuilder<ArgsParser>

withCopyright

public CliArgsParser withCopyright(String aCopyright)

Sets the copyright for the copyright property.

Specified by:

withCopyright in interface ArgsParser

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

public CliArgsParser withDescription(String aDescription)

Specified by:

withDescription in interface ArgsParser

Specified by:

withDescription in interface DescriptionAccessor.DescriptionBuilder<ArgsParser>

withDescriptionEscapeCode

public CliArgsParser withDescriptionEscapeCode(String aDescriptionEscCode)

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

Specified by:

withDescriptionEscapeCode in interface ArgsParser

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

public CliArgsParser 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 ArgsParser

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

public CliArgsParser withEscapeCodesEnabled(boolean aIsEscCodeEnabled)

Specified by:

withEscapeCodesEnabled in interface ArgsParser

Specified by:

withEscapeCodesEnabled in interface EscapeCodesStatusAccessor.EscapeCodeStatusBuilder<ArgsParser>

withEvalArgs

public CliArgsParser withEvalArgs(List<String> aArgs)
                           throws ArgsSyntaxException

Evaluates the provided command line arguments .

Specified by:

withEvalArgs in interface ArgsParser

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

public CliArgsParser withEvalArgs(List<String> aArgs,
 ArgsFilter aArgsFilter)
                           throws ArgsSyntaxException

Evaluates the provided command line arguments, filtering (excluding) the arguments matching the provided ArgsFilter.

Specified by:

withEvalArgs in interface ArgsParserBuilder<ArgsParser>

Parameters:

aArgs - The command line arguments to be evaluated.

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

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

public CliArgsParser withEvalArgs(List<String> aArgs,
 Pattern aFilterExp)
                           throws ArgsSyntaxException

Evaluates the provided command line arguments, filtering (excluding) the arguments matching the provided Pattern.

Specified by:

withEvalArgs in interface ArgsParserBuilder<ArgsParser>

Parameters:

aArgs - The command line arguments to be evaluated.

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

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

public CliArgsParser withEvalArgs(String[] aArgs)
                           throws ArgsSyntaxException

Evaluates the provided command line arguments.

Specified by:

withEvalArgs in interface ArgsParser

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

public CliArgsParser withEvalArgs(String[] aArgs,
 ArgsFilter aArgsFilter)
                           throws ArgsSyntaxException

Evaluates the provided command line arguments, filtering (excluding) the arguments matching the provided ArgsFilter.

Specified by:

withEvalArgs in interface ArgsParserBuilder<ArgsParser>

Parameters:

aArgs - The command line arguments to be evaluated.

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

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

public CliArgsParser withEvalArgs(String[] aArgs,
 Pattern aFilterExp)
                           throws ArgsSyntaxException

Evaluates the provided command line arguments, filtering (excluding) the arguments matching the provided Pattern.

Specified by:

withEvalArgs in interface ArgsParserBuilder<ArgsParser>

Parameters:

aArgs - The command line arguments to be evaluated.

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

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

public CliArgsParser withExamples(Collection<Example> aExamples)

Builder method providing the application's Example elements.

Specified by:

withExamples in interface ArgsParser

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

public CliArgsParser withExamples(Example[] aExamples)

Sets the Example instances for the Example instances property.

Specified by:

withExamples in interface ArgsParser

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

public CliArgsParser withLicense(String aLicense)

Sets the license for the license property.

Specified by:

withLicense in interface ArgsParser

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

public CliArgsParser withLineBreak(String aLineBreak)

Specified by:

withLineBreak in interface ArgsParser

Specified by:

withLineBreak in interface LineBreakAccessor.LineBreakBuilder<ArgsParser>

withLineSeparatorEscapeCode

public CliArgsParser withLineSeparatorEscapeCode(String aLineSeparatorEscCode)

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

Specified by:

withLineSeparatorEscapeCode in interface ArgsParser

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

public CliArgsParser withLongOptionPrefix(String aLongOptionPrefix)

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

Specified by:

withLongOptionPrefix in interface ArgsParser

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

public CliArgsParser withMaxConsoleWidth(int aMaxConsoleWidth)

Specified by:

withMaxConsoleWidth in interface ArgsParser

Specified by:

withMaxConsoleWidth in interface MaxConsoleWidthAccessor.MaxConsoleWidthBuilder<ArgsParser>

withName

public CliArgsParser withName(String aName)

Specified by:

withName in interface ArgsParser

Specified by:

withName in interface NameAccessor.NameBuilder<ArgsParser>

withKeywordEscapeCode

public CliArgsParser 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 ArgsParser

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

public CliArgsParser withResetEscapeCode(String aResetEscCode)

Specified by:

withResetEscapeCode in interface ArgsParser

Specified by:

withResetEscapeCode in interface ResetEscapeCodeAccessor.ResetEscapeCodeBuilder<ArgsParser>

withSeparatorLnChar

public CliArgsParser withSeparatorLnChar(char aSeparatorLnChar)

Builder method adding an separator line char.

Specified by:

withSeparatorLnChar in interface ArgsParser

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

public CliArgsParser withShortOptionPrefix(Character aShortOptionPrefix)

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

Specified by:

withShortOptionPrefix in interface ArgsParser

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

public CliArgsParser 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 ArgsParser

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

public CliArgsParser withSyntaxMetrics(SyntaxMetrics aSyntaxMetrics)

Sets the SyntaxMetrics for the SyntaxMetrics property.

Specified by:

withSyntaxMetrics in interface ArgsParser

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.

withSyntaxMetrics

public CliArgsParser withSyntaxMetrics(SyntaxNotation aSyntaxNotation)

Sets the SyntaxNotation for the SyntaxNotation property.

Specified by:

withSyntaxMetrics in interface SyntaxMetricsAccessor.SyntaxMetricsBuilder<ArgsParser>

Parameters:

aSyntaxNotation - The SyntaxNotation to be stored by the SyntaxNotation property.

Returns:

The builder for applying multiple build operations.

withTextBoxGrid

public CliArgsParser withTextBoxGrid(TextBoxGrid aTextBoxGrid)

Specified by:

withTextBoxGrid in interface ArgsParser

Specified by:

withTextBoxGrid in interface TextBoxGridAccessor.TextBoxGridBuilder<ArgsParser>

withTextBoxGrid

public CliArgsParser withTextBoxGrid(TextBoxStyle aTextBoxStyle)

Specified by:

withTextBoxGrid in interface ArgsParser

Specified by:

withTextBoxGrid in interface TextBoxGridAccessor.TextBoxGridBuilder<ArgsParser>

withTitle

public CliArgsParser withTitle(String aTitle)

Specified by:

withTitle in interface ArgsParser

Specified by:

withTitle in interface TitleAccessor.TitleBuilder<ArgsParser>

getDelimiter

protected char getDelimiter()

The delimiter to be used for colliding command line args when creating non colliding arg's aliases (keys for key/value-pairs). Used when parsing args without any syntax definition.

Returns:

The according delimiter for solving colliding command line args.