Uses of Interface
org.refcodes.cli.ArgsParser

Uses of ArgsParser in org.refcodes.cli

Classes in org.refcodes.cli that implement ArgsParser

Modifier and Type	Class	Description
class	CliArgsParser	A straightforward implementation of the ArgsParser interface.

Subinterfaces with type arguments of type ArgsParser in org.refcodes.cli

Modifier and Type	Interface	Description
interface	ArgsParser	The ArgsParser provides means for parsing command line arguments and constructing a command line utility's help output.
interface	ArgsParser	The ArgsParser provides means for parsing command line arguments and constructing a command line utility's help output.

Methods in org.refcodes.cli that return ArgsParser

Modifier and Type	Method	Description
ArgsParser	ArgsParserAccessor.getArgsParser()	Retrieves the args-parser from the ArgsParser property.
default ArgsParser	ArgsParserAccessor.ArgsParserProperty.letArgsParser(ArgsParser aArgsParser)	This method stores and passes through the given argument, which is very useful for builder APIs: Sets the given ArgsParser (setter) as of ArgsParserAccessor.ArgsParserMutator.setArgsParser(ArgsParser) and returns the very same value (getter).
default ArgsParser	ArgsParser.withAddExample(String aDescription, Operand<?>... aOperands)	Builder method adding an application's Example element.
default ArgsParser	ArgsParser.withAddExample(Example aExample)	Builder method adding an application's Example element.
default ArgsParser	ArgsParser.withArgumentEscapeCode(String aParamEscCode)	Sets the argument Escape-Code for the argument Escape-Code property.
default ArgsParser	ArgsParser.withBannerBorderEscapeCode(String aBannerBorderEscCode)	Sets the banner border Escape-Code for the banner border Escape-Code property.
default ArgsParser	ArgsParser.withBannerEscapeCode(String aBannerEscCode)	Sets the banner Escape-Code for the banner Escape-Code property.
default ArgsParser	ArgsParser.withBannerFont(org.refcodes.textual.Font aBannerFont)	Sets the banner Font for the banner Font property.
default ArgsParser	ArgsParser.withBannerFontPalette(char[] aColorPalette)	Sets the banner font palette for the banner font palette property.
default ArgsParser	ArgsParser.withCommandEscapeCode(String aCommandEscCode)	Sets the command Escape-Code for the command Escape-Code property.
default ArgsParser	ArgsParser.withConsoleWidth(int aConsoleWidth)
default ArgsParser	ArgsParser.withCopyright(String aCopyright)	Sets the copyright for the copyright property.
default ArgsParser	ArgsParser.withDescription(String aDescription)
default ArgsParser	ArgsParser.withDescriptionEscapeCode(String aDescriptionEscCode)	Sets the description Escape-Code for the description Escape-Code property.
default ArgsParser	ArgsParser.withErrorOut(PrintStream aErrorOut)	Set the error out PrintStream and make other adjustments with the result (with regards to the Builder-Pattern).
default ArgsParser	ArgsParser.withEscapeCodesEnabled(boolean isEscCodeEnabled)
default ArgsParser	ArgsParser.withEvalArgs(String[] aArgs)	Evaluates the provided command line arguments.
default ArgsParser	ArgsParser.withEvalArgs(List<String> aArgs)	Evaluates the provided command line arguments .
default ArgsParser	ArgsParser.withExamples(Collection<Example> aExamples)	Builder method providing the application's Example elements.
default ArgsParser	ArgsParser.withExamples(Example[] aExamples)	Sets the Example instances for the Example instances property.
default ArgsParser	ArgsParser.withKeywordEscapeCode(String aOptEscCode)	Sets the keyword (e.g. short- and long-options) Escape-Code for the keyword Escape-Code property.
default ArgsParser	ArgsParser.withLicense(String aLicense)	Sets the license for the license property.
default ArgsParser	ArgsParser.withLineBreak(String aLineBreak)
default ArgsParser	ArgsParser.withLineSeparatorEscapeCode(String aLineSeparatorEscCode)	Sets the line separator Escape-Code for the line separator Escape-Code property.
default ArgsParser	ArgsParser.withLongOptionPrefix(String aLongOptionPrefix)	Sets the long option prefix for the long option prefix property.
default ArgsParser	ArgsParser.withMaxConsoleWidth(int aMaxConsoleWidth)
default ArgsParser	ArgsParser.withName(String aName)
default ArgsParser	ArgsParser.withResetEscapeCode(String aResetEscCode)
default ArgsParser	ArgsParser.withSeparatorLnChar(char aSeparatorLnChar)	Builder method adding an separator line char.
default ArgsParser	ArgsParser.withShortOptionPrefix(Character aShortOptionPrefix)	Sets the short option prefix for the short option prefix property.
default ArgsParser	ArgsParser.withStandardOut(PrintStream aStandardOut)	Set the standard out PrintStream and make other adjustments with the result (with regards to the Builder-Pattern).
default ArgsParser	ArgsParser.withSyntaxMetrics(SyntaxMetrics aSyntaxMetrics)	Sets the SyntaxMetrics for the SyntaxMetrics property.
default ArgsParser	ArgsParser.withTextBoxGrid(org.refcodes.textual.TextBoxGrid aTextBoxGrid)
default ArgsParser	ArgsParser.withTextBoxGrid(org.refcodes.textual.TextBoxStyle aTextBoxStyle)
default ArgsParser	ArgsParser.withTitle(String aTitle)

Methods in org.refcodes.cli with parameters of type ArgsParser

Modifier and Type	Method	Description
default ArgsParser	ArgsParserAccessor.ArgsParserProperty.letArgsParser(ArgsParser aArgsParser)	This method stores and passes through the given argument, which is very useful for builder APIs: Sets the given ArgsParser (setter) as of ArgsParserAccessor.ArgsParserMutator.setArgsParser(ArgsParser) and returns the very same value (getter).
void	ArgsParserAccessor.ArgsParserMutator.setArgsParser(ArgsParser aArgsParser)	Sets the args-parser for the ArgsParser property.
B	ArgsParserAccessor.ArgsParserBuilder.withArgsParser(ArgsParser aArgsParser)	Sets the args-parser for the ArgsParser property.