Module org.refcodes.cli

Package org.refcodes.cli

Interface ParseArgs

All Superinterfaces:

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

All Known Implementing Classes:

ArgsParser

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

The ParseArgs 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 org.refcodes.cli.ArgsSyntaxAccessor

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

Nested classes/interfaces inherited from interface org.refcodes.cli.ArgumentEscapeCodeAccessor

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

Nested classes/interfaces inherited from interface org.refcodes.cli.BannerBorderEscapeCodeAccessor

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

Nested classes/interfaces inherited from interface org.refcodes.cli.BannerEscapeCodeAccessor

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

Nested classes/interfaces inherited from interface org.refcodes.cli.BannerFontAccessor

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

Nested classes/interfaces inherited from interface org.refcodes.cli.BannerFontPaletteAccessor

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

Nested classes/interfaces inherited from interface org.refcodes.cli.CommandEscapeCodeAccessor

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

Nested classes/interfaces inherited from interface org.refcodes.mixin.ConsoleWidthAccessor

org.refcodes.mixin.ConsoleWidthAccessor.ConsoleWidthBuilder<B extends org.refcodes.mixin.ConsoleWidthAccessor.ConsoleWidthBuilder<B>>, org.refcodes.mixin.ConsoleWidthAccessor.ConsoleWidthMutator, org.refcodes.mixin.ConsoleWidthAccessor.ConsoleWidthProperty

Nested classes/interfaces inherited from interface org.refcodes.cli.CopyrightAccessor

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

Nested classes/interfaces inherited from interface org.refcodes.mixin.DescriptionAccessor

org.refcodes.mixin.DescriptionAccessor.DescriptionBuilder<B extends org.refcodes.mixin.DescriptionAccessor.DescriptionBuilder<B>>, org.refcodes.mixin.DescriptionAccessor.DescriptionMutator, org.refcodes.mixin.DescriptionAccessor.DescriptionProperty

Nested classes/interfaces inherited from interface org.refcodes.cli.DescriptionEscapeCodeAccessor

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

Nested classes/interfaces inherited from interface org.refcodes.mixin.EscapeCodesStatusAccessor

org.refcodes.mixin.EscapeCodesStatusAccessor.EscapeCodeStatusBuilder<B extends org.refcodes.mixin.EscapeCodesStatusAccessor.EscapeCodeStatusBuilder<B>>, org.refcodes.mixin.EscapeCodesStatusAccessor.EscapeCodeStatusMutator, org.refcodes.mixin.EscapeCodesStatusAccessor.EscapeCodeStatusProperty

Nested classes/interfaces inherited from interface org.refcodes.cli.ExamplesAccessor

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

Nested classes/interfaces inherited from interface org.refcodes.cli.LicenseAccessor

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

Nested classes/interfaces inherited from interface org.refcodes.mixin.LineBreakAccessor

org.refcodes.mixin.LineBreakAccessor.LineBreakBuilder<B extends org.refcodes.mixin.LineBreakAccessor.LineBreakBuilder<B>>, org.refcodes.mixin.LineBreakAccessor.LineBreakMutator, org.refcodes.mixin.LineBreakAccessor.LineBreakProperty

Nested classes/interfaces inherited from interface org.refcodes.cli.LineSeparatorEscapeCodeAccessor

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

Nested classes/interfaces inherited from interface org.refcodes.cli.LongOptionPrefixAccessor

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

Nested classes/interfaces inherited from interface org.refcodes.mixin.MaxConsoleWidthAccessor

org.refcodes.mixin.MaxConsoleWidthAccessor.MaxConsoleWidthBuilder<B extends org.refcodes.mixin.MaxConsoleWidthAccessor.MaxConsoleWidthBuilder<B>>, org.refcodes.mixin.MaxConsoleWidthAccessor.MaxConsoleWidthMutator, org.refcodes.mixin.MaxConsoleWidthAccessor.MaxConsoleWidthProperty

Nested classes/interfaces inherited from interface org.refcodes.mixin.NameAccessor

org.refcodes.mixin.NameAccessor.NameBuilder<B extends org.refcodes.mixin.NameAccessor.NameBuilder<B>>, org.refcodes.mixin.NameAccessor.NameMutator, org.refcodes.mixin.NameAccessor.NameProperty

Nested classes/interfaces inherited from interface org.refcodes.cli.OptionEscapeCodeAccessor

OptionEscapeCodeAccessor.OptionEscapeCodeBuilder<B extends OptionEscapeCodeAccessor.OptionEscapeCodeBuilder<B>>, OptionEscapeCodeAccessor.OptionEscapeCodeMutator, OptionEscapeCodeAccessor.OptionEscapeCodeProperty

Nested classes/interfaces inherited from interface org.refcodes.mixin.ResetEscapeCodeAccessor

org.refcodes.mixin.ResetEscapeCodeAccessor.ResetEscapeCodeBuilder<B extends org.refcodes.mixin.ResetEscapeCodeAccessor.ResetEscapeCodeBuilder<B>>, org.refcodes.mixin.ResetEscapeCodeAccessor.ResetEscapeCodeMutator, org.refcodes.mixin.ResetEscapeCodeAccessor.ResetEscapeCodeProperty

Nested classes/interfaces inherited from interface org.refcodes.cli.ShortOptionPrefixAccessor

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

Nested classes/interfaces inherited from interface org.refcodes.cli.SyntaxMetricsAccessor

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

Nested classes/interfaces inherited from interface org.refcodes.textual.TextBoxGridAccessor

org.refcodes.textual.TextBoxGridAccessor.TextBoxGridBuilder<B extends org.refcodes.textual.TextBoxGridAccessor.TextBoxGridBuilder<?>>, org.refcodes.textual.TextBoxGridAccessor.TextBoxGridMutator, org.refcodes.textual.TextBoxGridAccessor.TextBoxGridProperty

Nested classes/interfaces inherited from interface org.refcodes.mixin.TitleAccessor

org.refcodes.mixin.TitleAccessor.TitleBuilder<B extends org.refcodes.mixin.TitleAccessor.TitleBuilder<B>>, org.refcodes.mixin.TitleAccessor.TitleMutator, org.refcodes.mixin.TitleAccessor.TitleProperty

Method Summary

Modifier and Type	Method	Description
default void	addExample(String aDescription, Operand<?>... aOperands)	Adds a usage example by providing a description of the example and the command line arguments required by the example.
void	addExample(Example aExample)	Adds a 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	getLicense()	Retrieves the license from the license property.
String	getLineSeparatorEscapeCode()	Retrieves the line separator Escape-Code from the line separator Escape-Code property.
String	getOptionEscapeCode()	Retrieves the option Escape-Code from the option 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 CliSchema	toSchema()
default ParseArgs	withAddExample(String aDescription, Operand<?>... aOperands)	Builder method adding an application's Example element.
default ParseArgs	withAddExample(Example aExample)	Builder method adding an application's Example element.
default ParseArgs	withArgumentEscapeCode(String aParamEscCode)	Sets the argument Escape-Code for the argument Escape-Code property.
default ParseArgs	withBannerBorderEscapeCode(String aBannerBorderEscCode)	Sets the banner border Escape-Code for the banner border Escape-Code property.
default ParseArgs	withBannerEscapeCode(String aBannerEscCode)	Sets the banner Escape-Code for the banner Escape-Code property.
default ParseArgs	withBannerFont(org.refcodes.textual.Font aBannerFont)	Sets the banner Font for the banner Font property.
default ParseArgs	withBannerFontPalette(char[] aColorPalette)	Sets the banner font palette for the banner font palette property.
default ParseArgs	withCommandEscapeCode(String aCommandEscCode)	Sets the command Escape-Code for the command Escape-Code property.
default ParseArgs	withConsoleWidth(int aConsoleWidth)
default ParseArgs	withCopyright(String aCopyright)	Sets the copyright for the copyright property.
default ParseArgs	withDescription(String aDescription)
default ParseArgs	withDescriptionEscapeCode(String aDescriptionEscCode)	Sets the description Escape-Code for the description Escape-Code property.
default ParseArgs	withErrorOut(PrintStream aErrorOut)	Set the error out PrintStream and make other adjustments with the result (with regards to the Builder-Pattern).
default ParseArgs	withEscapeCodesEnabled(boolean isEscCodeEnabled)
default ParseArgs	withEvalArgs(String[] aArgs)	Evaluates the provided command line arguments.
default ParseArgs	withEvalArgs(List<String> aArgs)	Evaluates the provided command line arguments .
default ParseArgs	withExamples(Collection<Example> aExamples)	Builder method providing the application's Example elements.
default ParseArgs	withExamples(Example[] aExamples)	Sets the Example instances for the Example instances property.
default ParseArgs	withLicense(String aLicense)	Sets the license for the license property.
default ParseArgs	withLineBreak(String aLineBreak)
default ParseArgs	withLineSeparatorEscapeCode(String aLineSeparatorEscCode)	Sets the line separator Escape-Code for the line separator Escape-Code property.
default ParseArgs	withLongOptionPrefix(String aLongOptionPrefix)	Sets the long option prefix for the long option prefix property.
default ParseArgs	withMaxConsoleWidth(int aMaxConsoleWidth)
default ParseArgs	withName(String aName)
default ParseArgs	withOptionEscapeCode(String aOptEscCode)	Sets the option Escape-Code for the option Escape-Code property.
default ParseArgs	withResetEscapeCode(String aResetEscCode)
default ParseArgs	withSeparatorLnChar(char aSeparatorLnChar)	Builder method adding an separator line char.
default ParseArgs	withShortOptionPrefix(Character aShortOptionPrefix)	Sets the short option prefix for the short option prefix property.
default ParseArgs	withStandardOut(PrintStream aStandardOut)	Set the standard out PrintStream and make other adjustments with the result (with regards to the Builder-Pattern).
default ParseArgs	withSyntaxMetrics(SyntaxMetrics aSyntaxMetrics)	Sets the SyntaxMetrics for the SyntaxMetrics property.
default ParseArgs	withTextBoxGrid(org.refcodes.textual.TextBoxGrid aTextBoxGrid)
default ParseArgs	withTextBoxGrid(org.refcodes.textual.TextBoxStyle aTextBoxStyle)
default ParseArgs	withTitle(String aTitle)

Methods inherited from interface org.refcodes.cli.ArgsParserBuilder

withEvalArgs, withEvalArgs, withEvalArgs, withEvalArgs

Methods inherited from interface org.refcodes.cli.ArgsSyntaxAccessor.ArgsSyntaxBuilder

withArgsSyntax

Methods inherited from interface org.refcodes.cli.ArgsSyntaxAccessor.ArgsSyntaxMutator

setArgsSyntax

Methods inherited from interface org.refcodes.cli.ArgsSyntaxAccessor.ArgsSyntaxProperty

letArgsSyntax

Methods inherited from interface org.refcodes.cli.ArgumentEscapeCodeAccessor.ArgumentEscapeCodeMutator

setArgumentEscapeCode

Methods inherited from interface org.refcodes.cli.ArgumentEscapeCodeAccessor.ArgumentEscapeCodeProperty

letArgumentEscapeCode

Methods inherited from interface org.refcodes.cli.BannerBorderEscapeCodeAccessor.BannerBorderEscapeCodeMutator

setBannerBorderEscapeCode

Methods inherited from interface org.refcodes.cli.BannerBorderEscapeCodeAccessor.BannerBorderEscapeCodeProperty

letBannerBorderEscapeCode

Methods inherited from interface org.refcodes.cli.BannerEscapeCodeAccessor.BannerEscapeCodeMutator

setBannerEscapeCode

Methods inherited from interface org.refcodes.cli.BannerEscapeCodeAccessor.BannerEscapeCodeProperty

letBannerEscapeCode

Methods inherited from interface org.refcodes.cli.BannerFontAccessor

getBannerFont

Methods inherited from interface org.refcodes.cli.BannerFontAccessor.BannerFontMutator

setBannerFont

Methods inherited from interface org.refcodes.cli.BannerFontAccessor.BannerFontProperty

letBannerFont

Methods inherited from interface org.refcodes.cli.BannerFontPaletteAccessor

getBannerFontPalette

Methods inherited from interface org.refcodes.cli.BannerFontPaletteAccessor.BannerFontPaletteBuilder

withBannerFontPalette

Methods inherited from interface org.refcodes.cli.BannerFontPaletteAccessor.BannerFontPaletteMutator

setBannerFontPalette, setBannerFontPalette

Methods inherited from interface org.refcodes.cli.BannerFontPaletteAccessor.BannerFontPaletteProperty

letBannerFontPalette

Methods inherited from interface org.refcodes.cli.CommandEscapeCodeAccessor.CommandEscapeCodeMutator

setCommandEscapeCode

Methods inherited from interface org.refcodes.cli.CommandEscapeCodeAccessor.CommandEscapeCodeProperty

letCommandEscapeCode

Methods inherited from interface org.refcodes.mixin.ConsoleWidthAccessor

getConsoleWidth

Methods inherited from interface org.refcodes.mixin.ConsoleWidthAccessor.ConsoleWidthMutator

setConsoleWidth

Methods inherited from interface org.refcodes.mixin.ConsoleWidthAccessor.ConsoleWidthProperty

letConsoleWidth

Methods inherited from interface org.refcodes.cli.CopyrightAccessor.CopyrightMutator

setCopyright

Methods inherited from interface org.refcodes.cli.CopyrightAccessor.CopyrightProperty

letCopyright

Methods inherited from interface org.refcodes.mixin.DescriptionAccessor.DescriptionMutator

setDescription

Methods inherited from interface org.refcodes.mixin.DescriptionAccessor.DescriptionProperty

letDescription

Methods inherited from interface org.refcodes.cli.DescriptionEscapeCodeAccessor.DescriptionEscapeCodeMutator

setDescriptionEscapeCode

Methods inherited from interface org.refcodes.cli.DescriptionEscapeCodeAccessor.DescriptionEscapeCodeProperty

letDescriptionEscapeCode

Methods inherited from interface org.refcodes.mixin.EscapeCodesStatusAccessor

isEscapeCodesEnabled

Methods inherited from interface org.refcodes.mixin.EscapeCodesStatusAccessor.EscapeCodeStatusMutator

setEscapeCodesEnabled

Methods inherited from interface org.refcodes.mixin.EscapeCodesStatusAccessor.EscapeCodeStatusProperty

letEscapeCodesEnabled

Methods inherited from interface org.refcodes.cli.ExamplesAccessor.ExamplesMutator

setExamples, setExamples

Methods inherited from interface org.refcodes.cli.ExamplesAccessor.ExamplesProperty

letExamples

Methods inherited from interface org.refcodes.cli.LicenseAccessor.LicenseMutator

setLicense

Methods inherited from interface org.refcodes.cli.LicenseAccessor.LicenseProperty

letLicense

Methods inherited from interface org.refcodes.mixin.LineBreakAccessor

getLineBreak

Methods inherited from interface org.refcodes.mixin.LineBreakAccessor.LineBreakMutator

setLineBreak

Methods inherited from interface org.refcodes.mixin.LineBreakAccessor.LineBreakProperty

letLineBreak

Methods inherited from interface org.refcodes.cli.LineSeparatorEscapeCodeAccessor.LineSeparatorEscapeCodeProperty

letLineSeparatorEscapeCode

Methods inherited from interface org.refcodes.cli.LongOptionPrefixAccessor

getLongOptionPrefix

Methods inherited from interface org.refcodes.cli.LongOptionPrefixAccessor.LongOptionPrefixMutator

setLongOptionPrefix

Methods inherited from interface org.refcodes.cli.LongOptionPrefixAccessor.LongOptionPrefixProperty

letLongOptionPrefix

Methods inherited from interface org.refcodes.mixin.MaxConsoleWidthAccessor

getMaxConsoleWidth

Methods inherited from interface org.refcodes.mixin.MaxConsoleWidthAccessor.MaxConsoleWidthMutator

setMaxConsoleWidth

Methods inherited from interface org.refcodes.mixin.MaxConsoleWidthAccessor.MaxConsoleWidthProperty

letMaxConsoleWidth

Methods inherited from interface org.refcodes.mixin.NameAccessor

getName

Methods inherited from interface org.refcodes.mixin.NameAccessor.NameMutator

setName

Methods inherited from interface org.refcodes.mixin.NameAccessor.NameProperty

letName

Methods inherited from interface org.refcodes.cli.OptionEscapeCodeAccessor.OptionEscapeCodeMutator

setOptionEscapeCode

Methods inherited from interface org.refcodes.cli.OptionEscapeCodeAccessor.OptionEscapeCodeProperty

letOptionEscapeCode

Methods inherited from interface org.refcodes.mixin.Resetable

reset

Methods inherited from interface org.refcodes.mixin.ResetEscapeCodeAccessor

getResetEscapeCode

Methods inherited from interface org.refcodes.mixin.ResetEscapeCodeAccessor.ResetEscapeCodeMutator

setResetEscapeCode

Methods inherited from interface org.refcodes.mixin.ResetEscapeCodeAccessor.ResetEscapeCodeProperty

letResetEscapeCode

Methods inherited from interface org.refcodes.cli.ShortOptionPrefixAccessor

getShortOptionPrefix

Methods inherited from interface org.refcodes.cli.ShortOptionPrefixAccessor.ShortOptionPrefixMutator

setShortOptionPrefix

Methods inherited from interface org.refcodes.cli.ShortOptionPrefixAccessor.ShortOptionPrefixProperty

letShortOptionPrefix

Methods inherited from interface org.refcodes.cli.SyntaxMetricsAccessor

getSyntaxMetrics

Methods inherited from interface org.refcodes.cli.SyntaxMetricsAccessor.SyntaxMetricsBuilder

withSyntaxMetrics

Methods inherited from interface org.refcodes.cli.SyntaxMetricsAccessor.SyntaxMetricsMutator

setSyntaxMetrics

Methods inherited from interface org.refcodes.cli.SyntaxMetricsAccessor.SyntaxMetricsProperty

letSyntaxMetrics, letSyntaxMetrics

Methods inherited from interface org.refcodes.textual.TextBoxGridAccessor

getTextBoxGrid

Methods inherited from interface org.refcodes.textual.TextBoxGridAccessor.TextBoxGridMutator

setTextBoxGrid, setTextBoxGrid

Methods inherited from interface org.refcodes.textual.TextBoxGridAccessor.TextBoxGridProperty

letTextBoxGrid, letTextBoxGrid

Methods inherited from interface org.refcodes.mixin.TitleAccessor

getTitle

Methods inherited from interface org.refcodes.mixin.TitleAccessor.TitleMutator

setTitle

Methods inherited from interface org.refcodes.mixin.TitleAccessor.TitleProperty

letTitle

Method Details

addExample

void addExample(Example aExample)

Adds a 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 a 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 org.refcodes.mixin.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.

getOptionEscapeCode

String getOptionEscapeCode()

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

Specified by:

getOptionEscapeCode in interface OptionEscapeCodeAccessor

Returns:

The option 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 CliSchema toSchema()

Specified by:

toSchema in interface org.refcodes.schema.Schemable

withAddExample

default ParseArgs withAddExample(Example aExample)

Builder method adding an application's Example element.

Specified by:

withAddExample in interface ArgsProcessorBuilder<ParseArgs>

Parameters:

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

Returns:

This builder as of the builder pattern.

withAddExample

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

Builder method adding an application's Example element.

Specified by:

withAddExample in interface ArgsProcessorBuilder<ParseArgs>

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 ParseArgs withArgumentEscapeCode(String aParamEscCode)

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

Specified by:

withArgumentEscapeCode in interface ArgumentEscapeCodeAccessor.ArgumentEscapeCodeBuilder<ParseArgs>

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 ParseArgs withBannerBorderEscapeCode(String aBannerBorderEscCode)

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

Specified by:

withBannerBorderEscapeCode in interface BannerBorderEscapeCodeAccessor.BannerBorderEscapeCodeBuilder<ParseArgs>

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 ParseArgs withBannerEscapeCode(String aBannerEscCode)

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

Specified by:

withBannerEscapeCode in interface BannerEscapeCodeAccessor.BannerEscapeCodeBuilder<ParseArgs>

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 ParseArgs withBannerFont(org.refcodes.textual.Font aBannerFont)

Sets the banner Font for the banner Font property.

Specified by:

withBannerFont in interface BannerFontAccessor.BannerFontBuilder<ParseArgs>

Parameters:

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

Returns:

The builder for applying multiple build operations.

withBannerFontPalette

default ParseArgs withBannerFontPalette(char[] aColorPalette)

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

Specified by:

withBannerFontPalette in interface BannerFontPaletteAccessor.BannerFontPaletteBuilder<ParseArgs>

Parameters:

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

Returns:

The builder for applying multiple build operations.

withCommandEscapeCode

default ParseArgs withCommandEscapeCode(String aCommandEscCode)

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

Specified by:

withCommandEscapeCode in interface CommandEscapeCodeAccessor.CommandEscapeCodeBuilder<ParseArgs>

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 ParseArgs withConsoleWidth(int aConsoleWidth)

Specified by:

withConsoleWidth in interface org.refcodes.mixin.ConsoleWidthAccessor.ConsoleWidthBuilder<ParseArgs>

withCopyright

default ParseArgs withCopyright(String aCopyright)

Sets the copyright for the copyright property.

Specified by:

withCopyright in interface CopyrightAccessor.CopyrightBuilder<ParseArgs>

Parameters:

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

Returns:

The builder for applying multiple build operations.

withDescription

default ParseArgs withDescription(String aDescription)

Specified by:

withDescription in interface org.refcodes.mixin.DescriptionAccessor.DescriptionBuilder<ParseArgs>

withDescriptionEscapeCode

default ParseArgs withDescriptionEscapeCode(String aDescriptionEscCode)

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

Specified by:

withDescriptionEscapeCode in interface DescriptionEscapeCodeAccessor.DescriptionEscapeCodeBuilder<ParseArgs>

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 ParseArgs 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<ParseArgs>

Parameters:

aErrorOut - The error out PrintStream to set.

Returns:

This instance with regard to the builder pattern.

withEscapeCodesEnabled

default ParseArgs withEscapeCodesEnabled(boolean isEscCodeEnabled)

Specified by:

withEscapeCodesEnabled in interface org.refcodes.mixin.EscapeCodesStatusAccessor.EscapeCodeStatusBuilder<ParseArgs>

withEvalArgs

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

Evaluates the provided command line arguments .

Specified by:

withEvalArgs in interface ArgsParserBuilder<ParseArgs>

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 ParseArgs withEvalArgs(String[] aArgs)
                        throws ArgsSyntaxException

Evaluates the provided command line arguments.

Specified by:

withEvalArgs in interface ArgsParserBuilder<ParseArgs>

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 ParseArgs withExamples(Collection<Example> aExamples)

Builder method providing the application's Example elements.

Specified by:

withExamples in interface ExamplesAccessor.ExamplesBuilder<ParseArgs>

Parameters:

aExamples - The application's Example elements to use.

Returns:

This builder as of the builder pattern.

withExamples

default ParseArgs withExamples(Example[] aExamples)

Sets the Example instances for the Example instances property.

Specified by:

withExamples in interface ExamplesAccessor.ExamplesBuilder<ParseArgs>

Parameters:

aExamples - The Example instances to be stored.

Returns:

The builder for applying multiple build operations.

withLicense

default ParseArgs withLicense(String aLicense)

Sets the license for the license property.

Specified by:

withLicense in interface LicenseAccessor.LicenseBuilder<ParseArgs>

Parameters:

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

Returns:

The builder for applying multiple build operations.

withLineBreak

default ParseArgs withLineBreak(String aLineBreak)

Specified by:

withLineBreak in interface org.refcodes.mixin.LineBreakAccessor.LineBreakBuilder<ParseArgs>

withLineSeparatorEscapeCode

default ParseArgs withLineSeparatorEscapeCode(String aLineSeparatorEscCode)

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

Specified by:

withLineSeparatorEscapeCode in interface LineSeparatorEscapeCodeAccessor.LineSeparatorEscapeCodeBuilder<ParseArgs>

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 ParseArgs withLongOptionPrefix(String aLongOptionPrefix)

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

Specified by:

withLongOptionPrefix in interface LongOptionPrefixAccessor.LongOptionPrefixBuilder<ParseArgs>

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 ParseArgs withMaxConsoleWidth(int aMaxConsoleWidth)

Specified by:

withMaxConsoleWidth in interface org.refcodes.mixin.MaxConsoleWidthAccessor.MaxConsoleWidthBuilder<ParseArgs>

withName

default ParseArgs withName(String aName)

Specified by:

withName in interface org.refcodes.mixin.NameAccessor.NameBuilder<ParseArgs>

withOptionEscapeCode

default ParseArgs withOptionEscapeCode(String aOptEscCode)

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

Specified by:

withOptionEscapeCode in interface OptionEscapeCodeAccessor.OptionEscapeCodeBuilder<ParseArgs>

Parameters:

aOptEscCode - The option Escape-Code to be stored by the option Escape-Code property.

Returns:

The builder for applying multiple build operations.

withResetEscapeCode

default ParseArgs withResetEscapeCode(String aResetEscCode)

Specified by:

withResetEscapeCode in interface org.refcodes.mixin.ResetEscapeCodeAccessor.ResetEscapeCodeBuilder<ParseArgs>

withSeparatorLnChar

default ParseArgs withSeparatorLnChar(char aSeparatorLnChar)

Builder method adding an separator line char.

Specified by:

withSeparatorLnChar in interface ArgsProcessorBuilder<ParseArgs>

Parameters:

aSeparatorLnChar - THe according separator line char to use.

Returns:

This builder as of the builder pattern.

withShortOptionPrefix

default ParseArgs withShortOptionPrefix(Character aShortOptionPrefix)

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

Specified by:

withShortOptionPrefix in interface ShortOptionPrefixAccessor.ShortOptionPrefixBuilder<ParseArgs>

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 ParseArgs 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<ParseArgs>

Parameters:

aStandardOut - The standard out PrintStream to set.

Returns:

This instance with regard to the builder pattern.

withSyntaxMetrics

default ParseArgs withSyntaxMetrics(SyntaxMetrics aSyntaxMetrics)

Sets the SyntaxMetrics for the SyntaxMetrics property.

Specified by:

withSyntaxMetrics in interface SyntaxMetricsAccessor.SyntaxMetricsBuilder<ParseArgs>

Parameters:

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

Returns:

The builder for applying multiple build operations.

withTextBoxGrid

default ParseArgs withTextBoxGrid(org.refcodes.textual.TextBoxGrid aTextBoxGrid)

Specified by:

withTextBoxGrid in interface org.refcodes.textual.TextBoxGridAccessor.TextBoxGridBuilder<ParseArgs>

withTextBoxGrid

default ParseArgs withTextBoxGrid(org.refcodes.textual.TextBoxStyle aTextBoxStyle)

Specified by:

withTextBoxGrid in interface org.refcodes.textual.TextBoxGridAccessor.TextBoxGridBuilder<ParseArgs>

withTitle

default ParseArgs withTitle(String aTitle)

Specified by:

withTitle in interface org.refcodes.mixin.TitleAccessor.TitleBuilder<ParseArgs>