Uses of Interface
org.refcodes.cli.ParseArgs
-
Uses of ParseArgs in org.refcodes.cli
Modifier and TypeClassDescriptionclass
A straightforward implementation of theParseArgs
interface.Modifier and TypeMethodDescriptionArgsParserAccessor.getArgsParser()
Retrieves the args-parser from theParseArgs
property.default ParseArgs
ArgsParserAccessor.ArgsParserProperty.letArgsParser
(ParseArgs aParseArgs) This method stores and passes through the given argument, which is very useful for builder APIs: Sets the givenParseArgs
(setter) as ofArgsParserAccessor.ArgsParserMutator.setArgsParser(ParseArgs)
and returns the very same value (getter).default ParseArgs
ParseArgs.withAddExample
(String aDescription, Operand<?>... aOperands) Builder method adding an application'sExample
element.default ParseArgs
ParseArgs.withAddExample
(Example aExample) Builder method adding an application'sExample
element.default ParseArgs
ParseArgs.withArgumentEscapeCode
(String aParamEscCode) Sets the argument Escape-Code for the argument Escape-Code property.default ParseArgs
ParseArgs.withBannerBorderEscapeCode
(String aBannerBorderEscCode) Sets the banner border Escape-Code for the banner border Escape-Code property.default ParseArgs
ParseArgs.withBannerEscapeCode
(String aBannerEscCode) Sets the banner Escape-Code for the banner Escape-Code property.default ParseArgs
ParseArgs.withBannerFont
(org.refcodes.textual.Font aBannerFont) Sets the bannerFont
for the bannerFont
property.default ParseArgs
ParseArgs.withBannerFontPalette
(char[] aColorPalette) Sets the banner font palette for the banner font palette property.default ParseArgs
ParseArgs.withCommandEscapeCode
(String aCommandEscCode) Sets the command Escape-Code for the command Escape-Code property.default ParseArgs
ParseArgs.withConsoleWidth
(int aConsoleWidth) default ParseArgs
ParseArgs.withCopyright
(String aCopyright) Sets the copyright for the copyright property.default ParseArgs
ParseArgs.withDescription
(String aDescription) default ParseArgs
ParseArgs.withDescriptionEscapeCode
(String aDescriptionEscCode) Sets the description Escape-Code for the description Escape-Code property.default ParseArgs
ParseArgs.withErrorOut
(PrintStream aErrorOut) Set the error outPrintStream
and make other adjustments with the result (with regards to the Builder-Pattern).default ParseArgs
ParseArgs.withEscapeCodesEnabled
(boolean isEscCodeEnabled) default ParseArgs
ParseArgs.withEvalArgs
(String[] aArgs) Evaluates the provided command line arguments.default ParseArgs
ParseArgs.withEvalArgs
(List<String> aArgs) Evaluates the provided command line arguments .default ParseArgs
ParseArgs.withExamples
(Collection<Example> aExamples) Builder method providing the application'sExample
elements.default ParseArgs
ParseArgs.withExamples
(Example[] aExamples) default ParseArgs
ParseArgs.withLicense
(String aLicense) Sets the license for the license property.default ParseArgs
ParseArgs.withLineBreak
(String aLineBreak) default ParseArgs
ParseArgs.withLineSeparatorEscapeCode
(String aLineSeparatorEscCode) Sets the line separator Escape-Code for the line separator Escape-Code property.default ParseArgs
ParseArgs.withLongOptionPrefix
(String aLongOptionPrefix) Sets the long option prefix for the long option prefix property.default ParseArgs
ParseArgs.withMaxConsoleWidth
(int aMaxConsoleWidth) default ParseArgs
default ParseArgs
ParseArgs.withOptionEscapeCode
(String aOptEscCode) Sets the option Escape-Code for the option Escape-Code property.default ParseArgs
ParseArgs.withResetEscapeCode
(String aResetEscCode) default ParseArgs
ParseArgs.withSeparatorLnChar
(char aSeparatorLnChar) Builder method adding an separator line char.default ParseArgs
ParseArgs.withShortOptionPrefix
(Character aShortOptionPrefix) Sets the short option prefix for the short option prefix property.default ParseArgs
ParseArgs.withStandardOut
(PrintStream aStandardOut) Set the standard outPrintStream
and make other adjustments with the result (with regards to the Builder-Pattern).default ParseArgs
ParseArgs.withSyntaxMetrics
(SyntaxMetrics aSyntaxMetrics) Sets theSyntaxMetrics
for theSyntaxMetrics
property.default ParseArgs
ParseArgs.withTextBoxGrid
(org.refcodes.textual.TextBoxGrid aTextBoxGrid) default ParseArgs
ParseArgs.withTextBoxGrid
(org.refcodes.textual.TextBoxStyle aTextBoxStyle) default ParseArgs
Modifier and TypeMethodDescriptiondefault ParseArgs
ArgsParserAccessor.ArgsParserProperty.letArgsParser
(ParseArgs aParseArgs) This method stores and passes through the given argument, which is very useful for builder APIs: Sets the givenParseArgs
(setter) as ofArgsParserAccessor.ArgsParserMutator.setArgsParser(ParseArgs)
and returns the very same value (getter).void
ArgsParserAccessor.ArgsParserMutator.setArgsParser
(ParseArgs aProperties) Sets the args-parser for theParseArgs
property.ArgsParserAccessor.ArgsParserBuilder.withArgsParser
(ParseArgs aProperties) Sets the args-parser for theParseArgs
property.