Module org.refcodes.properties.ext.cli

Package org.refcodes.properties.ext.cli

Class ArgsParserProperties

java.lang.Object

org.refcodes.cli.ArgsParser

org.refcodes.properties.ext.cli.ArgsParserProperties

All Implemented Interfaces:

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

public class ArgsParserProperties
extends org.refcodes.cli.ArgsParser
implements ParseArgsProperties

The ArgsParserProperties class implements the ParseArgsProperties type to combine the ParseArgs type with the Properties type in a dedicated class.

Nested Class Summary

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

org.refcodes.mixin.AnnotatorAccessor.AnnotatorBuilder<B extends org.refcodes.mixin.AnnotatorAccessor.AnnotatorBuilder<B>>, org.refcodes.mixin.AnnotatorAccessor.AnnotatorMutator, org.refcodes.mixin.AnnotatorAccessor.AnnotatorProperty

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

org.refcodes.cli.ArgsSyntaxAccessor.ArgsSyntaxBuilder<B extends org.refcodes.cli.ArgsSyntaxAccessor.ArgsSyntaxBuilder<B>>, org.refcodes.cli.ArgsSyntaxAccessor.ArgsSyntaxMutator, org.refcodes.cli.ArgsSyntaxAccessor.ArgsSyntaxProperty

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

org.refcodes.cli.ArgumentEscapeCodeAccessor.ArgumentEscapeCodeBuilder<B extends org.refcodes.cli.ArgumentEscapeCodeAccessor.ArgumentEscapeCodeBuilder<B>>, org.refcodes.cli.ArgumentEscapeCodeAccessor.ArgumentEscapeCodeMutator, org.refcodes.cli.ArgumentEscapeCodeAccessor.ArgumentEscapeCodeProperty

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

org.refcodes.cli.BannerBorderEscapeCodeAccessor.BannerBorderEscapeCodeBuilder<B extends org.refcodes.cli.BannerBorderEscapeCodeAccessor.BannerBorderEscapeCodeBuilder<B>>, org.refcodes.cli.BannerBorderEscapeCodeAccessor.BannerBorderEscapeCodeMutator, org.refcodes.cli.BannerBorderEscapeCodeAccessor.BannerBorderEscapeCodeProperty

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

org.refcodes.cli.BannerEscapeCodeAccessor.BannerEscapeCodeBuilder<B extends org.refcodes.cli.BannerEscapeCodeAccessor.BannerEscapeCodeBuilder<B>>, org.refcodes.cli.BannerEscapeCodeAccessor.BannerEscapeCodeMutator, org.refcodes.cli.BannerEscapeCodeAccessor.BannerEscapeCodeProperty

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

org.refcodes.cli.BannerFontAccessor.BannerFontBuilder<B extends org.refcodes.cli.BannerFontAccessor.BannerFontBuilder<B>>, org.refcodes.cli.BannerFontAccessor.BannerFontMutator, org.refcodes.cli.BannerFontAccessor.BannerFontProperty

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

org.refcodes.cli.BannerFontPaletteAccessor.BannerFontPaletteBuilder<B extends org.refcodes.cli.BannerFontPaletteAccessor.BannerFontPaletteBuilder<B>>, org.refcodes.cli.BannerFontPaletteAccessor.BannerFontPaletteMutator, org.refcodes.cli.BannerFontPaletteAccessor.BannerFontPaletteProperty

Nested classes/interfaces inherited from interface org.refcodes.struct.CanonicalMap

org.refcodes.struct.CanonicalMap.CanonicalMapBuilder, org.refcodes.struct.CanonicalMap.MutableCanonicalMap

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

org.refcodes.cli.CommandEscapeCodeAccessor.CommandEscapeCodeBuilder<B extends org.refcodes.cli.CommandEscapeCodeAccessor.CommandEscapeCodeBuilder<B>>, org.refcodes.cli.CommandEscapeCodeAccessor.CommandEscapeCodeMutator, org.refcodes.cli.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

org.refcodes.cli.CopyrightAccessor.CopyrightBuilder<B extends org.refcodes.cli.CopyrightAccessor.CopyrightBuilder<B>>, org.refcodes.cli.CopyrightAccessor.CopyrightMutator, org.refcodes.cli.CopyrightAccessor.CopyrightProperty

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

org.refcodes.mixin.DelimiterAccessor.DelimiterBuilder<B extends org.refcodes.mixin.DelimiterAccessor.DelimiterBuilder<B>>, org.refcodes.mixin.DelimiterAccessor.DelimiterMutator, org.refcodes.mixin.DelimiterAccessor.DelimiterProperty

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

org.refcodes.cli.DescriptionEscapeCodeAccessor.DescriptionEscapeCodeBuilder<B extends org.refcodes.cli.DescriptionEscapeCodeAccessor.DescriptionEscapeCodeBuilder<B>>, org.refcodes.cli.DescriptionEscapeCodeAccessor.DescriptionEscapeCodeMutator, org.refcodes.cli.DescriptionEscapeCodeAccessor.DescriptionEscapeCodeProperty

Nested classes/interfaces inherited from interface org.refcodes.struct.Dictionary

org.refcodes.struct.Dictionary.MutableDictionary<K extends Object,V extends Object>

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

org.refcodes.mixin.EmptyAccessor.EmptyMutator, org.refcodes.mixin.EmptyAccessor.EmptyProperty

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

org.refcodes.cli.ExamplesAccessor.ExamplesBuilder<B extends org.refcodes.cli.ExamplesAccessor.ExamplesBuilder<B>>, org.refcodes.cli.ExamplesAccessor.ExamplesMutator, org.refcodes.cli.ExamplesAccessor.ExamplesProperty

Nested classes/interfaces inherited from interface org.refcodes.struct.InterOperableMap

org.refcodes.struct.InterOperableMap.InterOperableMapBuilder<T extends Object>, org.refcodes.struct.InterOperableMap.MutableInterOperableMap<T extends Object>

Nested classes/interfaces inherited from interface org.refcodes.struct.Keys

org.refcodes.struct.Keys.MutableKeys<K extends Object,V extends Object>, org.refcodes.struct.Keys.MutableValues<K extends Object,V extends Object>

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

org.refcodes.cli.LicenseAccessor.LicenseBuilder<B extends org.refcodes.cli.LicenseAccessor.LicenseBuilder<B>>, org.refcodes.cli.LicenseAccessor.LicenseMutator, org.refcodes.cli.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

org.refcodes.cli.LineSeparatorEscapeCodeAccessor.LineSeparatorEscapeCodeBuilder<B extends org.refcodes.cli.LineSeparatorEscapeCodeAccessor.LineSeparatorEscapeCodeBuilder<B>>, org.refcodes.cli.LineSeparatorEscapeCodeAccessor.LineSeparatorEscapeCodeMutator, org.refcodes.cli.LineSeparatorEscapeCodeAccessor.LineSeparatorEscapeCodeProperty

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

org.refcodes.cli.LongOptionPrefixAccessor.LongOptionPrefixBuilder<B extends org.refcodes.cli.LongOptionPrefixAccessor.LongOptionPrefixBuilder<B>>, org.refcodes.cli.LongOptionPrefixAccessor.LongOptionPrefixMutator, org.refcodes.cli.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

org.refcodes.cli.OptionEscapeCodeAccessor.OptionEscapeCodeBuilder<B extends org.refcodes.cli.OptionEscapeCodeAccessor.OptionEscapeCodeBuilder<B>>, org.refcodes.cli.OptionEscapeCodeAccessor.OptionEscapeCodeMutator, org.refcodes.cli.OptionEscapeCodeAccessor.OptionEscapeCodeProperty

Nested classes/interfaces inherited from interface org.refcodes.struct.PathMap

org.refcodes.struct.PathMap.MutablePathMap<T extends Object>, org.refcodes.struct.PathMap.PathMapBuilder<T extends Object>

Nested classes/interfaces inherited from interface org.refcodes.properties.Properties

org.refcodes.properties.Properties.MutableProperties, org.refcodes.properties.Properties.PropertiesBuilder

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

org.refcodes.cli.ShortOptionPrefixAccessor.ShortOptionPrefixBuilder<B extends org.refcodes.cli.ShortOptionPrefixAccessor.ShortOptionPrefixBuilder<B>>, org.refcodes.cli.ShortOptionPrefixAccessor.ShortOptionPrefixMutator, org.refcodes.cli.ShortOptionPrefixAccessor.ShortOptionPrefixProperty

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

org.refcodes.cli.SyntaxMetricsAccessor.SyntaxMetricsBuilder<B extends org.refcodes.cli.SyntaxMetricsAccessor.SyntaxMetricsBuilder<B>>, org.refcodes.cli.SyntaxMetricsAccessor.SyntaxMetricsMutator, org.refcodes.cli.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

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

org.refcodes.mixin.TypeAccessor.TypeBuilder<T extends Object,B extends org.refcodes.mixin.TypeAccessor.TypeBuilder<T,B>>, org.refcodes.mixin.TypeAccessor.TypeMutator<T extends Object>, org.refcodes.mixin.TypeAccessor.TypeProperty<T extends Object>

Field Summary

Fields inherited from class org.refcodes.cli.ArgsParser

_errStream, _stdStream

Fields inherited from interface org.refcodes.struct.PathMap

ANNOTATOR, DELIMITER

Fields inherited from interface org.refcodes.properties.Properties

DEFAULT_COMMENT

Constructor Summary

Constructors

Constructor	Description
ArgsParserProperties()	Constructs the ParseArgsProperties instance with no syntax notation (no root Condition).
ArgsParserProperties(String[] aArgs)	Constructs the ParseArgsProperties instance with the given arguments and the default SyntaxNotation.LOGICAL.
ArgsParserProperties(String[] aArgs, org.refcodes.cli.CliContext aCliCtx)	Constructs the ParseArgsProperties instance with the given arguments and the default SyntaxNotation.LOGICAL.
ArgsParserProperties(String[] aArgs, org.refcodes.cli.Condition aArgsSyntax)	Constructs the ParseArgsProperties instance with the given root Condition and the default SyntaxNotation.LOGICAL.
ArgsParserProperties(String[] aArgs, org.refcodes.cli.Condition aArgsSyntax, org.refcodes.cli.CliContext aCliCtx)	Constructs the ParseArgsProperties instance with the given root Condition and the default SyntaxNotation.LOGICAL.
ArgsParserProperties(String[] aArgs, org.refcodes.cli.Option<?> aArgsSyntax)	Constructs the ParseArgsProperties instance with the given root Option and the default SyntaxNotation.LOGICAL.
ArgsParserProperties(String[] aArgs, org.refcodes.cli.Option<?> aArgsSyntax, org.refcodes.cli.CliContext aCliCtx)	Constructs the ParseArgsProperties instance with the given root Option and the default SyntaxNotation.LOGICAL.
ArgsParserProperties(org.refcodes.cli.CliContext aCliCtx)	Constructs the ParseArgsProperties instance with no syntax notation (no root Condition).
ArgsParserProperties(org.refcodes.cli.Term aArgsSyntax)	Constructs the ParseArgsProperties instance with the given root Term and the default SyntaxNotation.LOGICAL.
ArgsParserProperties(org.refcodes.cli.Term aArgsSyntax, org.refcodes.cli.CliContext aCliCtx)	Constructs the ParseArgsProperties instance with the given root Term and the default SyntaxNotation.LOGICAL.

Method Summary

Modifier and Type	Method	Description
boolean	containsKey(Object aKey)
org.refcodes.cli.Operand<?>[]	evalArgs(String[] aArgs)	Evaluates the command line arguments and sets the identified properties in this Properties instance.
org.refcodes.cli.Operand<?>[]	evalArgs(String aToPath, String[] aArgs)	Same as ParseArgsProperties.evalArgs(String[]) with the difference that the identified properties are inserted below the provided path.
org.refcodes.cli.Operand<?>[]	evalArgs(String aToPath, List<String> aArgs)	Same as ParseArgsProperties.evalArgs(String[]) with the difference that the identified properties are inserted below the provided path.
org.refcodes.cli.Operand<?>[]	evalArgs(List<String> aArgs)	Evaluates the command line arguments and sets the identified properties in this Properties instance.
String	get(Object aKey)
char	getAnnotator()
char	getDelimiter()
boolean	isEmpty()
Set<String>	keySet()
org.refcodes.properties.Properties	retrieveFrom(String aFromPath)
org.refcodes.properties.Properties	retrieveTo(String aToPath)
int	size()
Object	toDataStructure(String aPath)
Collection<String>	values()
ArgsParserProperties	withAddExample(String aDescription, org.refcodes.cli.Operand<?>... aOperands)
ArgsParserProperties	withAddExample(org.refcodes.cli.Example aExamples)
ArgsParserProperties	withArgsSyntax(org.refcodes.cli.Term aArgsSyntax)
ArgsParserProperties	withArgumentEscapeCode(String aParamEscCode)
ArgsParserProperties	withBannerBorderEscapeCode(String aBannerBorderEscCode)
ArgsParserProperties	withBannerEscapeCode(String aBannerEscCode)
ArgsParserProperties	withBannerFont(org.refcodes.textual.Font aBannerFont)
ArgsParserProperties	withBannerFontPalette(char[] aColorPalette)
ArgsParserProperties	withBannerFontPalette(org.refcodes.data.AsciiColorPalette aBannerFontPalette)
ArgsParserProperties	withCommandEscapeCode(String aCommandEscCode)
ArgsParserProperties	withConsoleWidth(int aConsoleWidth)
ArgsParserProperties	withCopyright(String aCopyright)
ArgsParserProperties	withDescription(String aDescription)
ArgsParserProperties	withDescriptionEscapeCode(String aDescriptionEscCode)
ArgsParserProperties	withErrorOut(PrintStream aErrorOut)
ArgsParserProperties	withEscapeCodesEnabled(boolean aIsEscCodeEnabled)
ArgsParserProperties	withEvalArgs(String[] aArgs)	Same as ParseArgsProperties.evalArgs(String[]) with the difference that this class's instance being invoked is returned as of the builder pattern.
ArgsParserProperties	withEvalArgs(String[] aArgs, Pattern aFilterExp)
ArgsParserProperties	withEvalArgs(String[] aArgs, org.refcodes.cli.ArgsFilter aArgsFilter)
ParseArgsProperties	withEvalArgs(String aToPath, String[] aArgs)	Same as ParseArgsProperties.evalArgs(String[]) with the difference that the identified properties are inserted below the provided path and that this class's instance being invoked is returned as of the builder pattern.
ParseArgsProperties	withEvalArgs(String aToPath, List<String> aArgs)	Same as ParseArgsProperties.evalArgs(String[]) with the difference that the identified properties are inserted below the provided path and that this class's instance being invoked is returned as of the builder pattern.
ArgsParserProperties	withEvalArgs(List<String> aArgs)	Same as ParseArgsProperties.evalArgs(List) with the difference that this class's instance being invoked is returned as of the builder pattern.
ArgsParserProperties	withEvalArgs(List<String> aArgs, Pattern aFilterExp)
ArgsParserProperties	withEvalArgs(List<String> aArgs, org.refcodes.cli.ArgsFilter aArgsFilter)
ArgsParserProperties	withExamples(Collection<org.refcodes.cli.Example> aExamples)
ArgsParserProperties	withExamples(org.refcodes.cli.Example[] aExamples)
ArgsParserProperties	withLicense(String aLicense)
ArgsParserProperties	withLineBreak(String aLineBreak)
ArgsParserProperties	withLineSeparatorEscapeCode(String aLineSeparatorEscCode)
ArgsParserProperties	withLongOptionPrefix(String aLongOptionPrefix)
ArgsParserProperties	withMaxConsoleWidth(int aMaxConsoleWidth)
ArgsParserProperties	withName(String aName)
ArgsParserProperties	withOptionEscapeCode(String aOptEscCode)
ArgsParserProperties	withResetEscapeCode(String aResetEscCode)
ArgsParserProperties	withSeparatorLnChar(char aSeparatorLnChar)
ArgsParserProperties	withShortOptionPrefix(Character aShortOptionPrefix)
ArgsParserProperties	withStandardOut(PrintStream aStandardOut)
ArgsParserProperties	withSyntaxMetrics(org.refcodes.cli.SyntaxMetrics aSyntaxMetrics)
ArgsParserProperties	withSyntaxMetrics(org.refcodes.cli.SyntaxNotation aSyntaxNotation)
ArgsParserProperties	withTextBoxGrid(org.refcodes.textual.TextBoxGrid aTextBoxGrid)
ArgsParserProperties	withTextBoxGrid(org.refcodes.textual.TextBoxStyle aTextBoxStyle)
ArgsParserProperties	withTitle(String aTitle)

Methods inherited from class org.refcodes.cli.ArgsParser

addExample, errorLn, getArgsSyntax, getArgumentEscapeCode, getBannerBorderEscapeCode, getBannerEscapeCode, getBannerFont, getBannerFontPalette, getCommandEscapeCode, getConsoleWidth, getCopyright, getDescription, getDescriptionEscapeCode, getExamples, getLicense, getLineBreak, getLineSeparatorEscapeCode, getLongOptionPrefix, getMaxConsoleWidth, getName, getOptionEscapeCode, getResetEscapeCode, getSeparatorLnChar, getShortOptionPrefix, getSyntaxMetrics, getTextBoxGrid, getTitle, isEscapeCodesEnabled, printBanner, printCopyright, printDescription, printExamples, printHeader, printLicense, printLn, printLn, printOptions, printSeparatorLn, printSynopsis, reset, setArgsSyntax, setArgumentEscapeCode, setBannerBorderEscapeCode, setBannerEscapeCode, setBannerFont, setBannerFontPalette, setBannerFontPalette, setCommandEscapeCode, setConsoleWidth, setCopyright, setDescription, setDescriptionEscapeCode, setErrorOut, setEscapeCodesEnabled, setExamples, setLicense, setLineBreak, setLineSeparatorEscapeCode, setLongOptionPrefix, setMaxConsoleWidth, setName, setOptionEscapeCode, setResetEscapeCode, setSeparatorLnChar, setShortOptionPrefix, setStandardOut, setSyntaxMetrics, setTextBoxGrid, setTitle

Methods inherited from class java.lang.Object

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

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

setBannerFontPalette, setBannerFontPalette

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

letBannerFontPalette

Methods inherited from interface org.refcodes.struct.CanonicalMap

asArray, asArray, asArray, asArray, asBooleanArray, asBooleanArray, asBooleanArray, asBooleanArray, asByteArray, asByteArray, asByteArray, asByteArray, asCharArray, asCharArray, asCharArray, asCharArray, asDoubleArray, asDoubleArray, asDoubleArray, asDoubleArray, asFloatArray, asFloatArray, asFloatArray, asFloatArray, asIntArray, asIntArray, asIntArray, asIntArray, asLongArray, asLongArray, asLongArray, asLongArray, asShortArray, asShortArray, asShortArray, asShortArray, queryBetween, toMap, toProperties

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

toDump, toDump

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.struct.InterOperableMap

getBoolean, getBoolean, getBoolean, getBoolean, getBoolean, getBooleanOr, getBooleanOr, getBooleanOr, getBooleanOr, getBooleanOr, getByte, getByte, getByte, getByte, getByte, getByteOr, getByteOr, getByteOr, getByteOr, getByteOr, getChar, getChar, getChar, getChar, getChar, getCharOr, getCharOr, getCharOr, getCharOr, getCharOr, getClass, getClass, getClass, getClass, getClass, getClassOr, getClassOr, getClassOr, getClassOr, getClassOr, getDouble, getDouble, getDouble, getDouble, getDouble, getDoubleOr, getDoubleOr, getDoubleOr, getDoubleOr, getDoubleOr, getEnum, getEnum, getEnum, getEnum, getEnum, getEnumOr, getEnumOr, getEnumOr, getEnumOr, getEnumOr, getEnumOr, getEnumOr, getEnumOr, getEnumOr, getEnumOr, getFloat, getFloat, getFloat, getFloat, getFloat, getFloatOr, getFloatOr, getFloatOr, getFloatOr, getFloatOr, getInt, getInt, getInt, getInt, getInt, getIntOr, getIntOr, getIntOr, getIntOr, getIntOr, getLong, getLong, getLong, getLong, getLong, getLongOr, getLongOr, getLongOr, getLongOr, getLongOr, getShort, getShort, getShort, getShort, getShort, getShortOr, getShortOr, getShortOr, getShortOr, getShortOr, getString, getString, getString, getString, getString, getStringOr, getStringOr, getStringOr, getStringOr, getStringOr

Methods inherited from interface org.refcodes.struct.Keys

getOr, use

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

addExample, addExample, errorLn, evalArgs, evalArgs, evalArgs, evalArgs, getArgsSyntax, getArgumentEscapeCode, getBannerBorderEscapeCode, getBannerEscapeCode, getCommandEscapeCode, getCopyright, getDescription, getDescriptionEscapeCode, getExamples, getLicense, getLineSeparatorEscapeCode, getOptionEscapeCode, getSeparatorLnChar, printBanner, printBody, printCopyright, printDescription, printExamples, printHeader, printHelp, printLicense, printLn, printLn, printOptions, printSeparatorLn, printSynopsis, setErrorOut, setLineSeparatorEscapeCode, setSeparatorLnChar, setStandardOut, setSyntaxMetrics, toOptions, toSchema

Methods inherited from interface org.refcodes.struct.PathMap

children, children, children, children, children, children, containsKey, containsKey, containsKey, dirs, dirs, dirs, dirs, dirs, dirs, findPaths, fromExternalPath, get, get, get, getArray, getArray, getArray, getArray, getArray, getArray, getArrayIndexes, getArrayIndexes, getArrayIndexes, getArrayIndexes, getArrayIndexes, getArrayOr, getArrayOr, getArrayOr, getArrayOr, getArrayOr, getArrayOr, getDirIndexes, getDirIndexes, getDirIndexes, getDirIndexes, getDirIndexes, getDirIndexes, getRootPath, getValueAt, getValueAt, getValueAt, getValueAt, getValueAt, getValueAt, hasChildren, hasChildren, hasChildren, hasChildren, hasChildren, hasDirAt, hasDirAt, hasDirAt, hasDirAt, hasDirAt, hasDirAt, hasDirAt, hasDirAt, hasDirAt, hasDirAt, hasDirAt, hasParentPath, hasPath, hasPath, hasPath, hasPath, hasPath, hasSubDirs, hasSubDirs, hasSubDirs, hasSubDirs, hasValue, hasValue, hasValue, hasValue, hasValue, hasValueAt, hasValueAt, hasValueAt, hasValueAt, hasValueAt, hasValueAt, hasValueAt, hasValueAt, isArray, isArray, isArray, isArray, isArray, isArray, isChild, isChild, isChild, isChild, isDir, isDir, isDir, isDir, isDir, isEqualTo, isIndexDir, isIndexDir, isIndexDir, isIndexDir, isIndexDir, isLeaf, isLeaf, isLeaf, isLeaf, isLeaf, isRootPath, keySet, keySet, keySet, keySet, keySet, lastArrayIndex, lastArrayIndex, lastArrayIndex, lastArrayIndex, lastArrayIndex, lastArrayIndex, lastDirIndex, lastDirIndex, lastDirIndex, lastDirIndex, lastDirIndex, lastDirIndex, leaves, leaves, leaves, leaves, leaves, leaves, nextArrayIndex, nextArrayIndex, nextArrayIndex, nextArrayIndex, nextArrayIndex, nextArrayIndex, nextDirIndex, nextDirIndex, nextDirIndex, nextDirIndex, nextDirIndex, nextDirIndex, paths, paths, paths, paths, paths, paths, queryPaths, queryPaths, queryPaths, queryPaths, queryPaths, queryPaths, sortedKeys, sortedKeys, sortedKeys, sortedKeys, sortedKeys, sortedKeys, sortedKeys, sortedKeys, sortedKeys, sortedKeys, sortedKeys, sortedKeys, sortedKeys, sortedKeys, sortedKeys, sortedKeys, sortedKeys, sortedKeys, toDataStructure, toExternalPath, toInstance, toInstance, toLeaf, toMap, toNormalizedPath, toParentPath, toPath, toPath, toPath, toPath, toPathElements, toPathList, toPathStack, toPrintable, toPropertyPath, toType, toType, toType, toType, toType, toType, toType, toType

Methods inherited from interface org.refcodes.properties.Properties

containsValue, getDir, getDir, getDir, getDir, getDir, getDirAt, getDirAt, getDirAt, getDirAt, getDirAt, getDirAt, getDirs, getDirs, getDirs, getDirs, getDirs, getType, query, query, query, query, query, queryBetween, queryBetween, queryBetween, queryBetween, queryBetween, queryFrom, queryFrom, queryFrom, queryFrom, queryFrom, queryFrom, queryTo, queryTo, queryTo, queryTo, queryTo, queryTo, retrieveBetween, retrieveBetween, retrieveBetween, retrieveBetween, retrieveBetween, retrieveFrom, retrieveFrom, retrieveFrom, retrieveFrom, retrieveTo, retrieveTo, retrieveTo, retrieveTo

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

Constructor Details

ArgsParserProperties

public ArgsParserProperties()

Constructs the ParseArgsProperties instance with no syntax notation (no root Condition). As no syntax notation is required by the constructor (no root Condition), no syntax validation is done by evalArgs(String[]) and the like methods. When no syntax validation is fine for you, you can directly go for the constructor ArgsParserProperties(String[]).

ArgsParserProperties

public ArgsParserProperties(org.refcodes.cli.Term aArgsSyntax)

Constructs the ParseArgsProperties instance with the given root Term and the default SyntaxNotation.LOGICAL.

Parameters:

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

ArgsParserProperties

public ArgsParserProperties(String[] aArgs)

Constructs the ParseArgsProperties instance with the given arguments and the default SyntaxNotation.LOGICAL. As no syntax notation is required by the constructor (no root Condition), no syntax validation is done. Therefore the properties are heuristically determined from the provided command line arguments.

Parameters:

aArgs - The command line arguments to be evaluated.

ArgsParserProperties

public ArgsParserProperties(String[] aArgs,
 org.refcodes.cli.Condition aArgsSyntax)
                     throws org.refcodes.cli.ArgsSyntaxException

Constructs the ParseArgsProperties instance with the given root Condition and the default SyntaxNotation.LOGICAL.

Parameters:

aArgs - The command line arguments to be evaluated.

aArgsSyntax - The root condition being the node from which parsing the command line arguments starts.

Throws:

org.refcodes.cli.ArgsSyntaxException - thrown in case of a command line arguments mismatch regarding provided and expected args.

ArgsParserProperties

public ArgsParserProperties(String[] aArgs,
 org.refcodes.cli.Option<?> aArgsSyntax)
                     throws org.refcodes.cli.ArgsSyntaxException

Constructs the ParseArgsProperties instance with the given root Option and the default SyntaxNotation.LOGICAL.

Parameters:

aArgs - The command line arguments to be evaluated.

aArgsSyntax - The root option being the node from which parsing the command line arguments starts.

Throws:

org.refcodes.cli.ArgsSyntaxException - thrown in case of a command line arguments mismatch regarding provided and expected args.

ArgsParserProperties

public ArgsParserProperties(org.refcodes.cli.CliContext aCliCtx)

Constructs the ParseArgsProperties instance with no syntax notation (no root Condition). As no syntax notation is required by the constructor (no root Condition), no syntax validation is done by evalArgs(String[]) and the like methods. When no syntax validation is fine for you, you can directly go for the constructor ArgsParserProperties(String[]).

Parameters:

aCliCtx - The CliContext to be used for initializing.

ArgsParserProperties

public ArgsParserProperties(org.refcodes.cli.Term aArgsSyntax,
 org.refcodes.cli.CliContext aCliCtx)

Constructs the ParseArgsProperties instance with the given root Term and the default SyntaxNotation.LOGICAL.

Parameters:

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

aCliCtx - The CliContext to be used for initializing.

ArgsParserProperties

public ArgsParserProperties(String[] aArgs,
 org.refcodes.cli.CliContext aCliCtx)

Constructs the ParseArgsProperties instance with the given arguments and the default SyntaxNotation.LOGICAL. As no syntax notation is required by the constructor (no root Condition), no syntax validation is done. Therefore the properties are heuristically determined from the provided command line arguments.

Parameters:

aArgs - The command line arguments to be evaluated.

aCliCtx - The CliContext to be used for initializing.

ArgsParserProperties

public ArgsParserProperties(String[] aArgs,
 org.refcodes.cli.Condition aArgsSyntax,
 org.refcodes.cli.CliContext aCliCtx)
                     throws org.refcodes.cli.ArgsSyntaxException

Constructs the ParseArgsProperties instance with the given root Condition and the default SyntaxNotation.LOGICAL.

Parameters:

aArgs - The command line arguments to be evaluated.

aArgsSyntax - The root condition being the node from which parsing the command line arguments starts.

aCliCtx - The CliContext to be used for initializing.

Throws:

org.refcodes.cli.ArgsSyntaxException - thrown in case of a command line arguments mismatch regarding provided and expected args.

ArgsParserProperties

public ArgsParserProperties(String[] aArgs,
 org.refcodes.cli.Option<?> aArgsSyntax,
 org.refcodes.cli.CliContext aCliCtx)
                     throws org.refcodes.cli.ArgsSyntaxException

Constructs the ParseArgsProperties instance with the given root Option and the default SyntaxNotation.LOGICAL.

Parameters:

aArgs - The command line arguments to be evaluated.

aArgsSyntax - The root option being the node from which parsing the command line arguments starts.

aCliCtx - The CliContext to be used for initializing.

Throws:

org.refcodes.cli.ArgsSyntaxException - thrown in case of a command line arguments mismatch regarding provided and expected args.

Method Details

evalArgs

public org.refcodes.cli.Operand<?>[] evalArgs(String[] aArgs)
                                       throws org.refcodes.cli.ArgsSyntaxException

Evaluates the command line arguments and sets the identified properties in this Properties instance. Previously identified properties are reset upon invocation of this method. When provided, then an Operand's alias is used as property name, else as fall back, the operand's (when being of sub-type Option) long-option or short-option is used. Make sure, to provide an alias to make the Properties work and feel as intended!

Specified by:

evalArgs in interface org.refcodes.cli.ParseArgs

Specified by:

evalArgs in interface ParseArgsProperties

Overrides:

evalArgs in class org.refcodes.cli.ArgsParser

Throws:

org.refcodes.cli.ArgsSyntaxException

evalArgs

public org.refcodes.cli.Operand<?>[] evalArgs(List<String> aArgs)
                                       throws org.refcodes.cli.ArgsSyntaxException

Evaluates the command line arguments and sets the identified properties in this Properties instance. Previously identified properties are reset upon invocation of this method. When provided, then an Operand's alias is used as property name, else as fall back, the operand's (when being of sub-type Option) long-option or short-option is used. Make sure, to provide an alias to make the Properties work and feel as intended!

Specified by:

evalArgs in interface org.refcodes.cli.ParseArgs

Specified by:

evalArgs in interface ParseArgsProperties

Throws:

org.refcodes.cli.ArgsSyntaxException

evalArgs

public org.refcodes.cli.Operand<?>[] evalArgs(String aToPath,
 List<String> aArgs)
                                       throws org.refcodes.cli.ArgsSyntaxException

Same as ParseArgsProperties.evalArgs(String[]) with the difference that the identified properties are inserted below the provided path.

Specified by:

evalArgs in interface ParseArgsProperties

Parameters:

aToPath - The path below which to insert the identified properties.

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.

Throws:

org.refcodes.cli.ArgsSyntaxException - thrown in case of a command line arguments mismatch regarding provided and expected args.

getAnnotator

public char getAnnotator()

Specified by:

getAnnotator in interface org.refcodes.mixin.AnnotatorAccessor

Specified by:

getAnnotator in interface org.refcodes.properties.Properties

getDelimiter

public char getDelimiter()

Specified by:

getDelimiter in interface org.refcodes.mixin.DelimiterAccessor

Specified by:

getDelimiter in interface org.refcodes.properties.Properties

Overrides:

getDelimiter in class org.refcodes.cli.ArgsParser

size

public int size()

Specified by:

size in interface org.refcodes.struct.Containable

containsKey

public boolean containsKey(Object aKey)

Specified by:

containsKey in interface org.refcodes.struct.Keys<String,String>

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface org.refcodes.mixin.EmptyAccessor

get

public String get(Object aKey)

Specified by:

get in interface org.refcodes.struct.Keys<String,String>

keySet

public Set<String> keySet()

Specified by:

keySet in interface org.refcodes.struct.Keys<String,String>

values

public Collection<String> values()

Specified by:

values in interface org.refcodes.struct.Keys<String,String>

retrieveFrom

public org.refcodes.properties.Properties retrieveFrom(String aFromPath)

Specified by:

retrieveFrom in interface org.refcodes.struct.CanonicalMap

Specified by:

retrieveFrom in interface org.refcodes.struct.PathMap<String>

Specified by:

retrieveFrom in interface org.refcodes.properties.Properties

retrieveTo

public org.refcodes.properties.Properties retrieveTo(String aToPath)

Specified by:

retrieveTo in interface org.refcodes.struct.CanonicalMap

Specified by:

retrieveTo in interface org.refcodes.struct.PathMap<String>

Specified by:

retrieveTo in interface org.refcodes.properties.Properties

toDataStructure

public Object toDataStructure(String aPath)

Specified by:

toDataStructure in interface org.refcodes.struct.PathMap<String>

withAddExample

public ArgsParserProperties withAddExample(org.refcodes.cli.Example aExamples)

Specified by:

withAddExample in interface org.refcodes.cli.ArgsProcessorBuilder<org.refcodes.cli.ParseArgs>

Specified by:

withAddExample in interface org.refcodes.cli.ParseArgs

Overrides:

withAddExample in class org.refcodes.cli.ArgsParser

withAddExample

public ArgsParserProperties withAddExample(String aDescription,
 org.refcodes.cli.Operand<?>... aOperands)

Specified by:

withAddExample in interface org.refcodes.cli.ArgsProcessorBuilder<org.refcodes.cli.ParseArgs>

Specified by:

withAddExample in interface org.refcodes.cli.ParseArgs

Overrides:

withAddExample in class org.refcodes.cli.ArgsParser

withArgsSyntax

public ArgsParserProperties withArgsSyntax(org.refcodes.cli.Term aArgsSyntax)

Specified by:

withArgsSyntax in interface org.refcodes.cli.ArgsSyntaxAccessor.ArgsSyntaxBuilder<org.refcodes.cli.ParseArgs>

Overrides:

withArgsSyntax in class org.refcodes.cli.ArgsParser

withBannerFontPalette

public ArgsParserProperties withBannerFontPalette(org.refcodes.data.AsciiColorPalette aBannerFontPalette)

Specified by:

withBannerFontPalette in interface org.refcodes.cli.BannerFontPaletteAccessor.BannerFontPaletteBuilder<org.refcodes.cli.ParseArgs>

Overrides:

withBannerFontPalette in class org.refcodes.cli.ArgsParser

withSyntaxMetrics

public ArgsParserProperties withSyntaxMetrics(org.refcodes.cli.SyntaxNotation aSyntaxNotation)

Specified by:

withSyntaxMetrics in interface org.refcodes.cli.SyntaxMetricsAccessor.SyntaxMetricsBuilder<org.refcodes.cli.ParseArgs>

Overrides:

withSyntaxMetrics in class org.refcodes.cli.ArgsParser

withEvalArgs

public ArgsParserProperties withEvalArgs(String[] aArgs,
 Pattern aFilterExp)
                                  throws org.refcodes.cli.ArgsSyntaxException

Specified by:

withEvalArgs in interface org.refcodes.cli.ArgsParserBuilder<org.refcodes.cli.ParseArgs>

Overrides:

withEvalArgs in class org.refcodes.cli.ArgsParser

Throws:

org.refcodes.cli.ArgsSyntaxException

withEvalArgs

public ArgsParserProperties withEvalArgs(List<String> aArgs,
 Pattern aFilterExp)
                                  throws org.refcodes.cli.ArgsSyntaxException

Specified by:

withEvalArgs in interface org.refcodes.cli.ArgsParserBuilder<org.refcodes.cli.ParseArgs>

Overrides:

withEvalArgs in class org.refcodes.cli.ArgsParser

Throws:

org.refcodes.cli.ArgsSyntaxException

withEvalArgs

public ArgsParserProperties withEvalArgs(String[] aArgs,
 org.refcodes.cli.ArgsFilter aArgsFilter)
                                  throws org.refcodes.cli.ArgsSyntaxException

Specified by:

withEvalArgs in interface org.refcodes.cli.ArgsParserBuilder<org.refcodes.cli.ParseArgs>

Overrides:

withEvalArgs in class org.refcodes.cli.ArgsParser

Throws:

org.refcodes.cli.ArgsSyntaxException

withEvalArgs

public ArgsParserProperties withEvalArgs(List<String> aArgs,
 org.refcodes.cli.ArgsFilter aArgsFilter)
                                  throws org.refcodes.cli.ArgsSyntaxException

Specified by:

withEvalArgs in interface org.refcodes.cli.ArgsParserBuilder<org.refcodes.cli.ParseArgs>

Overrides:

withEvalArgs in class org.refcodes.cli.ArgsParser

Throws:

org.refcodes.cli.ArgsSyntaxException

withArgumentEscapeCode

public ArgsParserProperties withArgumentEscapeCode(String aParamEscCode)

Specified by:

withArgumentEscapeCode in interface org.refcodes.cli.ArgumentEscapeCodeAccessor.ArgumentEscapeCodeBuilder<org.refcodes.cli.ParseArgs>

Specified by:

withArgumentEscapeCode in interface org.refcodes.cli.ParseArgs

Overrides:

withArgumentEscapeCode in class org.refcodes.cli.ArgsParser

withBannerBorderEscapeCode

public ArgsParserProperties withBannerBorderEscapeCode(String aBannerBorderEscCode)

Specified by:

withBannerBorderEscapeCode in interface org.refcodes.cli.BannerBorderEscapeCodeAccessor.BannerBorderEscapeCodeBuilder<org.refcodes.cli.ParseArgs>

Specified by:

withBannerBorderEscapeCode in interface org.refcodes.cli.ParseArgs

Overrides:

withBannerBorderEscapeCode in class org.refcodes.cli.ArgsParser

withBannerEscapeCode

public ArgsParserProperties withBannerEscapeCode(String aBannerEscCode)

Specified by:

withBannerEscapeCode in interface org.refcodes.cli.BannerEscapeCodeAccessor.BannerEscapeCodeBuilder<org.refcodes.cli.ParseArgs>

Specified by:

withBannerEscapeCode in interface org.refcodes.cli.ParseArgs

Overrides:

withBannerEscapeCode in class org.refcodes.cli.ArgsParser

withBannerFont

public ArgsParserProperties withBannerFont(org.refcodes.textual.Font aBannerFont)

Specified by:

withBannerFont in interface org.refcodes.cli.BannerFontAccessor.BannerFontBuilder<org.refcodes.cli.ParseArgs>

Specified by:

withBannerFont in interface org.refcodes.cli.ParseArgs

Overrides:

withBannerFont in class org.refcodes.cli.ArgsParser

withBannerFontPalette

public ArgsParserProperties withBannerFontPalette(char[] aColorPalette)

Specified by:

withBannerFontPalette in interface org.refcodes.cli.BannerFontPaletteAccessor.BannerFontPaletteBuilder<org.refcodes.cli.ParseArgs>

Specified by:

withBannerFontPalette in interface org.refcodes.cli.ParseArgs

Overrides:

withBannerFontPalette in class org.refcodes.cli.ArgsParser

withCommandEscapeCode

public ArgsParserProperties withCommandEscapeCode(String aCommandEscCode)

Specified by:

withCommandEscapeCode in interface org.refcodes.cli.CommandEscapeCodeAccessor.CommandEscapeCodeBuilder<org.refcodes.cli.ParseArgs>

Specified by:

withCommandEscapeCode in interface org.refcodes.cli.ParseArgs

Overrides:

withCommandEscapeCode in class org.refcodes.cli.ArgsParser

withConsoleWidth

public ArgsParserProperties withConsoleWidth(int aConsoleWidth)

Specified by:

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

Specified by:

withConsoleWidth in interface org.refcodes.cli.ParseArgs

Overrides:

withConsoleWidth in class org.refcodes.cli.ArgsParser

withCopyright

public ArgsParserProperties withCopyright(String aCopyright)

Specified by:

withCopyright in interface org.refcodes.cli.CopyrightAccessor.CopyrightBuilder<org.refcodes.cli.ParseArgs>

Specified by:

withCopyright in interface org.refcodes.cli.ParseArgs

Overrides:

withCopyright in class org.refcodes.cli.ArgsParser

withDescription

public ArgsParserProperties withDescription(String aDescription)

Specified by:

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

Specified by:

withDescription in interface org.refcodes.cli.ParseArgs

Overrides:

withDescription in class org.refcodes.cli.ArgsParser

withDescriptionEscapeCode

public ArgsParserProperties withDescriptionEscapeCode(String aDescriptionEscCode)

Specified by:

withDescriptionEscapeCode in interface org.refcodes.cli.DescriptionEscapeCodeAccessor.DescriptionEscapeCodeBuilder<org.refcodes.cli.ParseArgs>

Specified by:

withDescriptionEscapeCode in interface org.refcodes.cli.ParseArgs

Overrides:

withDescriptionEscapeCode in class org.refcodes.cli.ArgsParser

withEscapeCodesEnabled

public ArgsParserProperties withEscapeCodesEnabled(boolean aIsEscCodeEnabled)

Specified by:

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

Specified by:

withEscapeCodesEnabled in interface org.refcodes.cli.ParseArgs

Overrides:

withEscapeCodesEnabled in class org.refcodes.cli.ArgsParser

withEvalArgs

public ArgsParserProperties withEvalArgs(List<String> aArgs)
                                  throws org.refcodes.cli.ArgsSyntaxException

Same as ParseArgsProperties.evalArgs(List) with the difference that this class's instance being invoked is returned as of the builder pattern.

Specified by:

withEvalArgs in interface org.refcodes.cli.ArgsParserBuilder<org.refcodes.cli.ParseArgs>

Specified by:

withEvalArgs in interface org.refcodes.cli.ParseArgs

Specified by:

withEvalArgs in interface ParseArgsProperties

Overrides:

withEvalArgs in class org.refcodes.cli.ArgsParser

Parameters:

aArgs - The command line arguments to be evaluated.

Returns:

This invoked instance as of the builder pattern to chain method calls.

Throws:

org.refcodes.cli.ArgsSyntaxException - thrown in case of a command line arguments mismatch regarding provided and expected args.

withEvalArgs

public ArgsParserProperties withEvalArgs(String[] aArgs)
                                  throws org.refcodes.cli.ArgsSyntaxException

Same as ParseArgsProperties.evalArgs(String[]) with the difference that this class's instance being invoked is returned as of the builder pattern.

Specified by:

withEvalArgs in interface org.refcodes.cli.ArgsParserBuilder<org.refcodes.cli.ParseArgs>

Specified by:

withEvalArgs in interface org.refcodes.cli.ParseArgs

Specified by:

withEvalArgs in interface ParseArgsProperties

Overrides:

withEvalArgs in class org.refcodes.cli.ArgsParser

Parameters:

aArgs - The command line arguments to be evaluated.

Returns:

This invoked instance as of the builder pattern to chain method calls.

Throws:

org.refcodes.cli.ArgsSyntaxException - thrown in case of a command line arguments mismatch regarding provided and expected args.

withExamples

public ArgsParserProperties withExamples(Collection<org.refcodes.cli.Example> aExamples)

Specified by:

withExamples in interface org.refcodes.cli.ExamplesAccessor.ExamplesBuilder<org.refcodes.cli.ParseArgs>

Specified by:

withExamples in interface org.refcodes.cli.ParseArgs

Overrides:

withExamples in class org.refcodes.cli.ArgsParser

withExamples

public ArgsParserProperties withExamples(org.refcodes.cli.Example[] aExamples)

Specified by:

withExamples in interface org.refcodes.cli.ExamplesAccessor.ExamplesBuilder<org.refcodes.cli.ParseArgs>

Specified by:

withExamples in interface org.refcodes.cli.ParseArgs

Overrides:

withExamples in class org.refcodes.cli.ArgsParser

withLicense

public ArgsParserProperties withLicense(String aLicense)

Specified by:

withLicense in interface org.refcodes.cli.LicenseAccessor.LicenseBuilder<org.refcodes.cli.ParseArgs>

Specified by:

withLicense in interface org.refcodes.cli.ParseArgs

Overrides:

withLicense in class org.refcodes.cli.ArgsParser

withLineBreak

public ArgsParserProperties withLineBreak(String aLineBreak)

Specified by:

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

Specified by:

withLineBreak in interface org.refcodes.cli.ParseArgs

Overrides:

withLineBreak in class org.refcodes.cli.ArgsParser

withLineSeparatorEscapeCode

public ArgsParserProperties withLineSeparatorEscapeCode(String aLineSeparatorEscCode)

Specified by:

withLineSeparatorEscapeCode in interface org.refcodes.cli.LineSeparatorEscapeCodeAccessor.LineSeparatorEscapeCodeBuilder<org.refcodes.cli.ParseArgs>

Specified by:

withLineSeparatorEscapeCode in interface org.refcodes.cli.ParseArgs

Overrides:

withLineSeparatorEscapeCode in class org.refcodes.cli.ArgsParser

withLongOptionPrefix

public ArgsParserProperties withLongOptionPrefix(String aLongOptionPrefix)

Specified by:

withLongOptionPrefix in interface org.refcodes.cli.LongOptionPrefixAccessor.LongOptionPrefixBuilder<org.refcodes.cli.ParseArgs>

Specified by:

withLongOptionPrefix in interface org.refcodes.cli.ParseArgs

Overrides:

withLongOptionPrefix in class org.refcodes.cli.ArgsParser

withMaxConsoleWidth

public ArgsParserProperties withMaxConsoleWidth(int aMaxConsoleWidth)

Specified by:

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

Specified by:

withMaxConsoleWidth in interface org.refcodes.cli.ParseArgs

Overrides:

withMaxConsoleWidth in class org.refcodes.cli.ArgsParser

withName

public ArgsParserProperties withName(String aName)

Specified by:

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

Specified by:

withName in interface org.refcodes.cli.ParseArgs

Overrides:

withName in class org.refcodes.cli.ArgsParser

withOptionEscapeCode

public ArgsParserProperties withOptionEscapeCode(String aOptEscCode)

Specified by:

withOptionEscapeCode in interface org.refcodes.cli.OptionEscapeCodeAccessor.OptionEscapeCodeBuilder<org.refcodes.cli.ParseArgs>

Specified by:

withOptionEscapeCode in interface org.refcodes.cli.ParseArgs

Overrides:

withOptionEscapeCode in class org.refcodes.cli.ArgsParser

withResetEscapeCode

public ArgsParserProperties withResetEscapeCode(String aResetEscCode)

Specified by:

withResetEscapeCode in interface org.refcodes.cli.ParseArgs

Specified by:

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

Overrides:

withResetEscapeCode in class org.refcodes.cli.ArgsParser

withShortOptionPrefix

public ArgsParserProperties withShortOptionPrefix(Character aShortOptionPrefix)

Specified by:

withShortOptionPrefix in interface org.refcodes.cli.ParseArgs

Specified by:

withShortOptionPrefix in interface org.refcodes.cli.ShortOptionPrefixAccessor.ShortOptionPrefixBuilder<org.refcodes.cli.ParseArgs>

Overrides:

withShortOptionPrefix in class org.refcodes.cli.ArgsParser

withSyntaxMetrics

public ArgsParserProperties withSyntaxMetrics(org.refcodes.cli.SyntaxMetrics aSyntaxMetrics)

Specified by:

withSyntaxMetrics in interface org.refcodes.cli.ParseArgs

Specified by:

withSyntaxMetrics in interface org.refcodes.cli.SyntaxMetricsAccessor.SyntaxMetricsBuilder<org.refcodes.cli.ParseArgs>

Overrides:

withSyntaxMetrics in class org.refcodes.cli.ArgsParser

withTextBoxGrid

public ArgsParserProperties withTextBoxGrid(org.refcodes.textual.TextBoxGrid aTextBoxGrid)

Specified by:

withTextBoxGrid in interface org.refcodes.cli.ParseArgs

Specified by:

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

Overrides:

withTextBoxGrid in class org.refcodes.cli.ArgsParser

withTextBoxGrid

public ArgsParserProperties withTextBoxGrid(org.refcodes.textual.TextBoxStyle aTextBoxStyle)

Specified by:

withTextBoxGrid in interface org.refcodes.cli.ParseArgs

Specified by:

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

Overrides:

withTextBoxGrid in class org.refcodes.cli.ArgsParser

withTitle

public ArgsParserProperties withTitle(String aTitle)

Specified by:

withTitle in interface org.refcodes.cli.ParseArgs

Specified by:

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

Overrides:

withTitle in class org.refcodes.cli.ArgsParser

withSeparatorLnChar

public ArgsParserProperties withSeparatorLnChar(char aSeparatorLnChar)

Specified by:

withSeparatorLnChar in interface org.refcodes.cli.ArgsProcessorBuilder<org.refcodes.cli.ParseArgs>

Specified by:

withSeparatorLnChar in interface org.refcodes.cli.ParseArgs

Overrides:

withSeparatorLnChar in class org.refcodes.cli.ArgsParser

withStandardOut

public ArgsParserProperties withStandardOut(PrintStream aStandardOut)

Specified by:

withStandardOut in interface org.refcodes.cli.ArgsProcessorBuilder<org.refcodes.cli.ParseArgs>

Specified by:

withStandardOut in interface org.refcodes.cli.ParseArgs

Overrides:

withStandardOut in class org.refcodes.cli.ArgsParser

withErrorOut

public ArgsParserProperties withErrorOut(PrintStream aErrorOut)

Specified by:

withErrorOut in interface org.refcodes.cli.ArgsProcessorBuilder<org.refcodes.cli.ParseArgs>

Specified by:

withErrorOut in interface org.refcodes.cli.ParseArgs

Overrides:

withErrorOut in class org.refcodes.cli.ArgsParser

withEvalArgs

public ParseArgsProperties withEvalArgs(String aToPath,
 List<String> aArgs)
                                 throws org.refcodes.cli.ArgsSyntaxException

Same as ParseArgsProperties.evalArgs(String[]) with the difference that the identified properties are inserted below the provided path and that this class's instance being invoked is returned as of the builder pattern.

Specified by:

withEvalArgs in interface ParseArgsProperties

Parameters:

aToPath - The path below which to insert the identified properties.

aArgs - The command line arguments to be evaluated.

Returns:

This invoked instance as of the builder pattern to chain method calls.

Throws:

org.refcodes.cli.ArgsSyntaxException - thrown in case of a command line arguments mismatch regarding provided and expected args.

withEvalArgs

public ParseArgsProperties withEvalArgs(String aToPath,
 String[] aArgs)
                                 throws org.refcodes.cli.ArgsSyntaxException

Same as ParseArgsProperties.evalArgs(String[]) with the difference that the identified properties are inserted below the provided path and that this class's instance being invoked is returned as of the builder pattern.

Specified by:

withEvalArgs in interface ParseArgsProperties

Parameters:

aToPath - The path below which to insert the identified properties.

aArgs - The command line arguments to be evaluated.

Returns:

This invoked instance as of the builder pattern to chain method calls.

Throws:

org.refcodes.cli.ArgsSyntaxException - thrown in case of a command line arguments mismatch regarding provided and expected args.

evalArgs

public org.refcodes.cli.Operand<?>[] evalArgs(String aToPath,
 String[] aArgs)
                                       throws org.refcodes.cli.ArgsSyntaxException

Same as ParseArgsProperties.evalArgs(String[]) with the difference that the identified properties are inserted below the provided path.

Specified by:

evalArgs in interface ParseArgsProperties

Parameters:

aToPath - The path below which to insert the identified properties.

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.

Throws:

org.refcodes.cli.ArgsSyntaxException - thrown in case of a command line arguments mismatch regarding provided and expected args.