- 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.mixin.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.mixin.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 TypeMethodDescriptiondefault 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
Prints the given line to standard error with regards to the console width as specified by thewithConsoleWidth(int)
method.Operand<?>[]
Evaluates the provided command line arguments and determines the according values by evaluating the rootCondition
.default Operand<?>[]
Evaluates the provided command line arguments as ofevalArgs(String[])
, additionally filtering (excluding) the arguments matching the providedPattern
.default Operand<?>[]
evalArgs
(String[] aArgs, ArgsFilter aArgsFilter) Evaluates the provided command line arguments as ofevalArgs(String[])
, additionally filtering (excluding) the arguments matching the providedArgsFilter
.default Operand<?>[]
Same asevalArgs(String[])
with the difference that the elements representing the arguments are passed as a list instead of an array.default Operand<?>[]
Evaluates the provided command line arguments as ofevalArgs(String[])
, additionally filtering (excluding) the arguments matching the providedPattern
.default Operand<?>[]
evalArgs
(List<String> aArgs, ArgsFilter aArgsFilter) Evaluates the provided command line arguments as ofevalArgs(String[])
, additionally filtering (excluding) the arguments matching the providedArgsFilter
.Retrieves the argument Escape-Code from the argument Escape-Code property.Retrieves the banner border Escape-Code from the banner border Escape-Code property.Retrieves the banner Escape-Code from the banner Escape-Code property.Retrieves the command Escape-Code from the command Escape-Code property.Retrieves the copyright from the copyright property.Retrieves the description Escape-Code from the description Escape-Code property.Example[]
Retrieves the license from the license property.Retrieves the line separator Escape-Code from the line separator Escape-Code property.Retrieves the option Escape-Code from the option Escape-Code property.char
Gets the character to be used when printing a separator line with theprintSeparatorLn()
method.void
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
Prints the help as ofprintHelp()
without the banner.void
Prints the copyright note as specified by thewithCopyright(String)
method; with regards to the console width as specified by thewithConsoleWidth(int)
method.void
Prints the description as set by thewithDescription(String)
method with regards to the console width as specified by thewithConsoleWidth(int)
method.void
Prints example usages as as added by theaddExample(String, Operand...)
method with regards to the console width as specified by thewithConsoleWidth(int)
method.void
Prints the header, which might be a simplified banner: Can be used when overriding methods such asprintHelp()
orprintBanner()
.default void
Prints the help to the standard output specified by thewithStandardOut(PrintStream)
method.void
Prints the license note as specified by thewithLicense(String)
method; with regards to the console width as specified by thewithConsoleWidth(int)
method.void
printLn()
Prints an empty line / a line break.void
Prints the given line to standard out with regards to the console width as specified by thewithConsoleWidth(int)
method.void
Prints theOption
s (short- and the long-options), theFlag
es and theOperand
and their description with regards to the console width as specified by thewithConsoleWidth(int)
method.void
Prints a separator line using the separator character as specified by thewithSeparatorLnChar(char)
method; with regards to the console width as specified by thewithConsoleWidth(int)
method.void
Prints the syntax as retrieved by the rootCondition
element as ofSynopsisable.toSynopsis(SyntaxNotation)
with regards to theSyntaxNotation
set by thewithSyntaxMetrics(SyntaxMetrics)
method.void
setErrorOut
(PrintStream aErrorOut) Set the error outPrintStream
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 theprintSeparatorLn()
method.void
setStandardOut
(PrintStream aStandardOut) Set the standard outPrintStream
and make other adjustments with the result (with regards to the Builder-Pattern).void
setSyntaxMetrics
(SyntaxMetrics aSyntaxMetrics) Sets theSyntaxMetrics
for theSyntaxMetrics
property.default String[]
Retrieves an array of the context specific options being configured for the givenOption
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'sExample
element.default ParseArgs
withAddExample
(Example aExample) Builder method adding an application'sExample
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 bannerFont
for the bannerFont
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 outPrintStream
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'sExample
elements.default ParseArgs
withExamples
(Example[] aExamples) 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
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 outPrintStream
and make other adjustments with the result (with regards to the Builder-Pattern).default ParseArgs
withSyntaxMetrics
(SyntaxMetrics aSyntaxMetrics) Sets theSyntaxMetrics
for theSyntaxMetrics
property.default ParseArgs
withTextBoxGrid
(org.refcodes.textual.TextBoxGrid aTextBoxGrid) default ParseArgs
withTextBoxGrid
(org.refcodes.textual.TextBoxStyle aTextBoxStyle) default ParseArgs
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
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
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
Prints the given line to standard error with regards to the console width as specified by thewithConsoleWidth(int)
method.- Parameters:
aLine
- The line to be printed.
-
evalArgs
Same asevalArgs(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 anOperand
implements theApprovable
interface or inherits from theAbstractOperand
type, then theOperand
is also approved by invokingApprovable.approve()
orAbstractOperand.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 ofevalArgs(String[])
, additionally filtering (excluding) the arguments matching the providedArgsFilter
.- Parameters:
aArgs
- The command line arguments to be evaluated.aArgsFilter
- TheArgsFilter
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 anOperand
implements theApprovable
interface or inherits from theAbstractOperand
type, then theOperand
is also approved by invokingApprovable.approve()
orAbstractOperand.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
Evaluates the provided command line arguments as ofevalArgs(String[])
, additionally filtering (excluding) the arguments matching the providedPattern
.- Parameters:
aArgs
- The command line arguments to be evaluated.aFilterExp
- ThePattern
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 anOperand
implements theApprovable
interface or inherits from theAbstractOperand
type, then theOperand
is also approved by invokingApprovable.approve()
orAbstractOperand.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
Evaluates the provided command line arguments and determines the according values by evaluating the rootCondition
. 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 theTerm
instance being traversed starting at the rootCondition
will be reported. Business logic therefore should invoke this root node'sevalArgs(String[])
method instead of aCondition
'sTerm.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 anOperand
implements theApprovable
interface or inherits from theAbstractOperand
type, then theOperand
is also approved by invokingApprovable.approve()
orAbstractOperand.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
Evaluates the provided command line arguments as ofevalArgs(String[])
, additionally filtering (excluding) the arguments matching the providedArgsFilter
.- Parameters:
aArgs
- The command line arguments to be evaluated.aArgsFilter
- TheArgsFilter
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 anOperand
implements theApprovable
interface or inherits from theAbstractOperand
type, then theOperand
is also approved by invokingApprovable.approve()
orAbstractOperand.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
Evaluates the provided command line arguments as ofevalArgs(String[])
, additionally filtering (excluding) the arguments matching the providedPattern
.- Parameters:
aArgs
- The command line arguments to be evaluated.aFilterExp
- ThePattern
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 anOperand
implements theApprovable
interface or inherits from theAbstractOperand
type, then theOperand
is also approved by invokingApprovable.approve()
orAbstractOperand.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()- Specified by:
getArgsSyntax
in interfaceArgsSyntaxAccessor
- 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 interfaceArgumentEscapeCodeAccessor
- 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 interfaceBannerBorderEscapeCodeAccessor
- 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 interfaceBannerEscapeCodeAccessor
- 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 interfaceCommandEscapeCodeAccessor
- 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 interfaceCopyrightAccessor
- Returns:
- The copyright stored by the copyright property.
-
getDescription
String getDescription()- Specified by:
getDescription
in interfaceorg.refcodes.mixin.DescriptionAccessor
-
getDescriptionEscapeCode
String getDescriptionEscapeCode()Retrieves the description Escape-Code from the description Escape-Code property.- Specified by:
getDescriptionEscapeCode
in interfaceDescriptionEscapeCodeAccessor
- Returns:
- The description Escape-Code stored by the description Escape-Code property.
-
getExamples
Example[] getExamples()- Specified by:
getExamples
in interfaceExamplesAccessor
- Returns:
- The
Example
instances stored by theExample
instances property.
-
getLicense
String getLicense()Retrieves the license from the license property.- Specified by:
getLicense
in interfaceLicenseAccessor
- 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 interfaceLineSeparatorEscapeCodeAccessor
- 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 interfaceOptionEscapeCodeAccessor
- 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 theprintSeparatorLn()
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 ofprintHelp()
without the banner. -
printCopyright
void printCopyright()Prints the copyright note as specified by thewithCopyright(String)
method; with regards to the console width as specified by thewithConsoleWidth(int)
method. -
printDescription
void printDescription()Prints the description as set by thewithDescription(String)
method with regards to the console width as specified by thewithConsoleWidth(int)
method. -
printExamples
void printExamples()Prints example usages as as added by theaddExample(String, Operand...)
method with regards to the console width as specified by thewithConsoleWidth(int)
method. -
printHeader
void printHeader()Prints the header, which might be a simplified banner: Can be used when overriding methods such asprintHelp()
orprintBanner()
. -
printHelp
default void printHelp()Prints the help to the standard output specified by thewithStandardOut(PrintStream)
method. This method can make use of the more atomic methodsprintBanner()
,printSynopsis()
,printDescription()
,printOptions()
orprintSeparatorLn()
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 asprintBanner()
,printSynopsis()
,printDescription()
,printOptions()
orprintSeparatorLn()
-
printLicense
void printLicense()Prints the license note as specified by thewithLicense(String)
method; with regards to the console width as specified by thewithConsoleWidth(int)
method. -
printLn
void printLn()Prints an empty line / a line break. -
printLn
Prints the given line to standard out with regards to the console width as specified by thewithConsoleWidth(int)
method.- Parameters:
aLine
- The line to be printed.
-
printOptions
void printOptions()Prints theOption
s (short- and the long-options), theFlag
es and theOperand
and their description with regards to the console width as specified by thewithConsoleWidth(int)
method. -
printSeparatorLn
void printSeparatorLn()Prints a separator line using the separator character as specified by thewithSeparatorLnChar(char)
method; with regards to the console width as specified by thewithConsoleWidth(int)
method. -
printSynopsis
void printSynopsis()Prints the syntax as retrieved by the rootCondition
element as ofSynopsisable.toSynopsis(SyntaxNotation)
with regards to theSyntaxNotation
set by thewithSyntaxMetrics(SyntaxMetrics)
method. -
setErrorOut
Set the error outPrintStream
and make other adjustments with the result (with regards to the Builder-Pattern).- Parameters:
aErrorOut
- The error outPrintStream
to set.
-
setLineSeparatorEscapeCode
Sets the line separator Escape-Code for the line separator Escape-Code property.- Specified by:
setLineSeparatorEscapeCode
in interfaceLineSeparatorEscapeCodeAccessor.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 theprintSeparatorLn()
method.- Parameters:
aSeparatorLnChar
- The character used by theprintSeparatorLn()
method when printing out the line of characters..
-
setStandardOut
Set the standard outPrintStream
and make other adjustments with the result (with regards to the Builder-Pattern).- Parameters:
aStandardOut
- The standard outPrintStream
to set.
-
setSyntaxMetrics
Sets theSyntaxMetrics
for theSyntaxMetrics
property.- Specified by:
setSyntaxMetrics
in interfaceSyntaxMetricsAccessor.SyntaxMetricsMutator
- Parameters:
aSyntaxMetrics
- TheSyntaxMetrics
to be stored by theSyntaxMetrics
property.
-
toOptions
Retrieves an array of the context specific options being configured for the givenOption
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 interfaceOptionable
- Parameters:
aOption
- TheOption
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
- Specified by:
toSchema
in interfaceorg.refcodes.mixin.Schemable
-
withAddExample
Builder method adding an application'sExample
element.- Specified by:
withAddExample
in interfaceArgsProcessorBuilder<ParseArgs>
- Parameters:
aExample
- The application'sExample
element to be added.- Returns:
- This builder as of the builder pattern.
-
withAddExample
Builder method adding an application'sExample
element.- Specified by:
withAddExample
in interfaceArgsProcessorBuilder<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
Sets the argument Escape-Code for the argument Escape-Code property.- Specified by:
withArgumentEscapeCode
in interfaceArgumentEscapeCodeAccessor.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
Sets the banner border Escape-Code for the banner border Escape-Code property.- Specified by:
withBannerBorderEscapeCode
in interfaceBannerBorderEscapeCodeAccessor.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
Sets the banner Escape-Code for the banner Escape-Code property.- Specified by:
withBannerEscapeCode
in interfaceBannerEscapeCodeAccessor.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
Sets the bannerFont
for the bannerFont
property.- Specified by:
withBannerFont
in interfaceBannerFontAccessor.BannerFontBuilder<ParseArgs>
- Parameters:
aBannerFont
- The bannerFont
to be stored by the bannerFont
property.- Returns:
- The builder for applying multiple build operations.
-
withBannerFontPalette
Sets the banner font palette for the banner font palette property.- Specified by:
withBannerFontPalette
in interfaceBannerFontPaletteAccessor.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
Sets the command Escape-Code for the command Escape-Code property.- Specified by:
withCommandEscapeCode
in interfaceCommandEscapeCodeAccessor.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
- Specified by:
withConsoleWidth
in interfaceorg.refcodes.mixin.ConsoleWidthAccessor.ConsoleWidthBuilder<ParseArgs>
-
withCopyright
Sets the copyright for the copyright property.- Specified by:
withCopyright
in interfaceCopyrightAccessor.CopyrightBuilder<ParseArgs>
- Parameters:
aCopyright
- The copyright to be stored by the console width property.- Returns:
- The builder for applying multiple build operations.
-
withDescription
- Specified by:
withDescription
in interfaceorg.refcodes.mixin.DescriptionAccessor.DescriptionBuilder<ParseArgs>
-
withDescriptionEscapeCode
Sets the description Escape-Code for the description Escape-Code property.- Specified by:
withDescriptionEscapeCode
in interfaceDescriptionEscapeCodeAccessor.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
Set the error outPrintStream
and make other adjustments with the result (with regards to the Builder-Pattern).- Specified by:
withErrorOut
in interfaceArgsProcessorBuilder<ParseArgs>
- Parameters:
aErrorOut
- The error outPrintStream
to set.- Returns:
- This instance with regard to the builder pattern.
-
withEscapeCodesEnabled
- Specified by:
withEscapeCodesEnabled
in interfaceorg.refcodes.mixin.EscapeCodesStatusAccessor.EscapeCodeStatusBuilder<ParseArgs>
-
withEvalArgs
Evaluates the provided command line arguments .- Specified by:
withEvalArgs
in interfaceArgsParserBuilder<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
Evaluates the provided command line arguments.- Specified by:
withEvalArgs
in interfaceArgsParserBuilder<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
Builder method providing the application'sExample
elements.- Specified by:
withExamples
in interfaceExamplesAccessor.ExamplesBuilder<ParseArgs>
- Parameters:
aExamples
- The application'sExample
elements to use.- Returns:
- This builder as of the builder pattern.
-
withExamples
- Specified by:
withExamples
in interfaceExamplesAccessor.ExamplesBuilder<ParseArgs>
- Parameters:
aExamples
- TheExample
instances to be stored.- Returns:
- The builder for applying multiple build operations.
-
withLicense
Sets the license for the license property.- Specified by:
withLicense
in interfaceLicenseAccessor.LicenseBuilder<ParseArgs>
- Parameters:
aLicense
- The license to be stored by the console width property.- Returns:
- The builder for applying multiple build operations.
-
withLineBreak
- Specified by:
withLineBreak
in interfaceorg.refcodes.mixin.LineBreakAccessor.LineBreakBuilder<ParseArgs>
-
withLineSeparatorEscapeCode
Sets the line separator Escape-Code for the line separator Escape-Code property.- Specified by:
withLineSeparatorEscapeCode
in interfaceLineSeparatorEscapeCodeAccessor.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
Sets the long option prefix for the long option prefix property.- Specified by:
withLongOptionPrefix
in interfaceLongOptionPrefixAccessor.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
- Specified by:
withMaxConsoleWidth
in interfaceorg.refcodes.mixin.MaxConsoleWidthAccessor.MaxConsoleWidthBuilder<ParseArgs>
-
withName
- Specified by:
withName
in interfaceorg.refcodes.mixin.NameAccessor.NameBuilder<ParseArgs>
-
withOptionEscapeCode
Sets the option Escape-Code for the option Escape-Code property.- Specified by:
withOptionEscapeCode
in interfaceOptionEscapeCodeAccessor.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
- Specified by:
withResetEscapeCode
in interfaceorg.refcodes.mixin.ResetEscapeCodeAccessor.ResetEscapeCodeBuilder<ParseArgs>
-
withSeparatorLnChar
Builder method adding an separator line char.- Specified by:
withSeparatorLnChar
in interfaceArgsProcessorBuilder<ParseArgs>
- Parameters:
aSeparatorLnChar
- THe according separator line char to use.- Returns:
- This builder as of the builder pattern.
-
withShortOptionPrefix
Sets the short option prefix for the short option prefix property.- Specified by:
withShortOptionPrefix
in interfaceShortOptionPrefixAccessor.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
Set the standard outPrintStream
and make other adjustments with the result (with regards to the Builder-Pattern).- Specified by:
withStandardOut
in interfaceArgsProcessorBuilder<ParseArgs>
- Parameters:
aStandardOut
- The standard outPrintStream
to set.- Returns:
- This instance with regard to the builder pattern.
-
withSyntaxMetrics
Sets theSyntaxMetrics
for theSyntaxMetrics
property.- Specified by:
withSyntaxMetrics
in interfaceSyntaxMetricsAccessor.SyntaxMetricsBuilder<ParseArgs>
- Parameters:
aSyntaxMetrics
- TheSyntaxMetrics
to be stored by theSyntaxMetrics
property.- Returns:
- The builder for applying multiple build operations.
-
withTextBoxGrid
- Specified by:
withTextBoxGrid
in interfaceorg.refcodes.textual.TextBoxGridAccessor.TextBoxGridBuilder<ParseArgs>
-
withTextBoxGrid
- Specified by:
withTextBoxGrid
in interfaceorg.refcodes.textual.TextBoxGridAccessor.TextBoxGridBuilder<ParseArgs>
-
withTitle
- Specified by:
withTitle
in interfaceorg.refcodes.mixin.TitleAccessor.TitleBuilder<ParseArgs>
-