Module org.refcodes.properties.ext.cli

Package org.refcodes.properties.ext.cli

Interface ArgsParserProperties

All Superinterfaces:

org.refcodes.mixin.AnnotatorAccessor, org.refcodes.cli.ArgsParser, org.refcodes.cli.ArgsParserMixin<org.refcodes.cli.ArgsParser>, org.refcodes.cli.ArgsSyntaxAccessor, org.refcodes.cli.ArgumentEscapeCodeAccessor, org.refcodes.cli.ArgumentEscapeCodeAccessor.ArgumentEscapeCodeBuilder<org.refcodes.cli.ArgsParser>, org.refcodes.cli.ArgumentEscapeCodeAccessor.ArgumentEscapeCodeMutator, org.refcodes.cli.ArgumentEscapeCodeAccessor.ArgumentEscapeCodeProperty, org.refcodes.struct.CanonicalMap, org.refcodes.cli.CliMetrics, org.refcodes.struct.Containable, org.refcodes.mixin.DelimiterAccessor, org.refcodes.mixin.DescriptionAccessor, org.refcodes.mixin.DescriptionAccessor.DescriptionBuilder<org.refcodes.cli.ArgsParser>, org.refcodes.mixin.DescriptionAccessor.DescriptionMutator, org.refcodes.mixin.DescriptionAccessor.DescriptionProperty, org.refcodes.struct.Dictionary<String,String>, org.refcodes.mixin.Dumpable, org.refcodes.mixin.EmptyAccessor, org.refcodes.mixin.EscapeCodesStatusAccessor, org.refcodes.mixin.EscapeCodesStatusAccessor.EscapeCodeStatusBuilder<org.refcodes.cli.ArgsParser>, org.refcodes.mixin.EscapeCodesStatusAccessor.EscapeCodeStatusMutator, org.refcodes.mixin.EscapeCodesStatusAccessor.EscapeCodeStatusProperty, org.refcodes.struct.InterOperableMap<String>, org.refcodes.struct.Keys<String,String>, org.refcodes.cli.LongOptionPrefixAccessor, org.refcodes.cli.LongOptionPrefixAccessor.LongOptionPrefixBuilder<org.refcodes.cli.ArgsParser>, org.refcodes.cli.LongOptionPrefixAccessor.LongOptionPrefixMutator, org.refcodes.cli.LongOptionPrefixAccessor.LongOptionPrefixProperty, org.refcodes.mixin.NameAccessor, org.refcodes.mixin.NameAccessor.NameBuilder<org.refcodes.cli.ArgsParser>, org.refcodes.mixin.NameAccessor.NameMutator, org.refcodes.mixin.NameAccessor.NameProperty, org.refcodes.cli.Optionable, org.refcodes.cli.OptionEscapeCodeAccessor, org.refcodes.cli.OptionEscapeCodeAccessor.OptionEscapeCodeBuilder<org.refcodes.cli.ArgsParser>, org.refcodes.cli.OptionEscapeCodeAccessor.OptionEscapeCodeMutator, org.refcodes.cli.OptionEscapeCodeAccessor.OptionEscapeCodeProperty, org.refcodes.struct.PathMap<String>, org.refcodes.properties.Properties, org.refcodes.mixin.Resetable, org.refcodes.mixin.ResetEscapeCodeAccessor, org.refcodes.mixin.ResetEscapeCodeAccessor.ResetEscapeCodeBuilder<org.refcodes.cli.ArgsParser>, org.refcodes.mixin.ResetEscapeCodeAccessor.ResetEscapeCodeMutator, org.refcodes.mixin.ResetEscapeCodeAccessor.ResetEscapeCodeProperty, org.refcodes.cli.ShortOptionPrefixAccessor, org.refcodes.cli.ShortOptionPrefixAccessor.ShortOptionPrefixBuilder<org.refcodes.cli.ArgsParser>, org.refcodes.cli.ShortOptionPrefixAccessor.ShortOptionPrefixMutator, org.refcodes.cli.ShortOptionPrefixAccessor.ShortOptionPrefixProperty, org.refcodes.cli.SyntaxMetricsAccessor, org.refcodes.cli.SyntaxMetricsAccessor.SyntaxMetricsBuilder<org.refcodes.cli.ArgsParser>, org.refcodes.cli.SyntaxMetricsAccessor.SyntaxMetricsMutator, org.refcodes.cli.SyntaxMetricsAccessor.SyntaxMetricsProperty, org.refcodes.textual.TextBoxGridAccessor, org.refcodes.textual.TextBoxGridAccessor.TextBoxGridBuilder<org.refcodes.cli.ArgsParser>, org.refcodes.textual.TextBoxGridAccessor.TextBoxGridMutator, org.refcodes.textual.TextBoxGridAccessor.TextBoxGridProperty, org.refcodes.mixin.TitleAccessor, org.refcodes.mixin.TitleAccessor.TitleBuilder<org.refcodes.cli.ArgsParser>, org.refcodes.mixin.TitleAccessor.TitleMutator, org.refcodes.mixin.TitleAccessor.TitleProperty, org.refcodes.mixin.TypeAccessor<String>

All Known Implementing Classes:

ArgsParserPropertiesImpl

public interface ArgsParserProperties
extends org.refcodes.properties.Properties, org.refcodes.cli.ArgsParser

The ArgsParserProperties represent Properties generated from command line arguments being parsed by a command line syntax as of the definition for the ArgsParser.

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

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

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.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.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.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.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 interface org.refcodes.struct.PathMap

ANNOTATOR, DELIMITER

Fields inherited from interface org.refcodes.properties.Properties

DEFAULT_COMMENT

Method Summary

Modifier and Type	Method	Description
List<? extends org.refcodes.cli.Operand<?>>	evalArgs(String[] aArgs)	Evaluates the command line arguments and sets the identified properties in this Properties instance.
List<? extends org.refcodes.cli.Operand<?>>	evalArgs(String aToPath, String[] aArgs)	Same as evalArgs(String[]) with the difference that the identified properties are inserted below the provided path.
List<? extends org.refcodes.cli.Operand<?>>	evalArgs(String aToPath, List<String> aArgs)	Same as evalArgs(String[]) with the difference that the identified properties are inserted below the provided path.
List<? extends org.refcodes.cli.Operand<?>>	evalArgs(List<String> aArgs)	Evaluates the command line arguments and sets the identified properties in this Properties instance.
default ArgsParserProperties	withEvalArgs(String[] aArgs)	Same as evalArgs(String[]) with the difference that this class's instance being invoked is returned as of the builder pattern.
default ArgsParserProperties	withEvalArgs(String aToPath, String[] aArgs)	Same as 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.
default ArgsParserProperties	withEvalArgs(String aToPath, List<String> aArgs)	Same as 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.
default ArgsParserProperties	withEvalArgs(List<String> aArgs)	Same as evalArgs(List) with the difference that this class's instance being invoked is returned as of the builder pattern.

Methods inherited from interface org.refcodes.cli.ArgsParser

addExample, addExample, errorLn, evalArgs, evalArgs, evalArgs, evalArgs, getArgsSyntax, getArgumentEscapeCode, getBannerBorderEscapeCode, getBannerEscapeCode, getCommandEscapeCode, getCopyrightNote, getDescription, getDescriptionEscapeCode, getExamples, getLicenseNote, getLineSeparatorEscapeCode, getOptionEscapeCode, getSeparatorLnChar, printBanner, printBody, printCopyrightNote, printDescription, printExamples, printHeader, printHelp, printLicenseNote, printLn, printLn, printOptions, printSeparatorLn, printSynopsis, setArgumentEscapeCode, setBannerBorderEscapeCode, setBannerEscapeCode, setBannerFont, setBannerFontPalette, setCommandEscapeCode, setConsoleWidth, setCopyrightNote, setDescriptionEscapeCode, setErrorOut, setLicenseNote, setLineBreak, setLineSeparatorEscapeCode, setMaxConsoleWidth, setOptionEscapeCode, setSeparatorLnChar, setStandardOut, setSyntaxMetrics, toOptions, withArgumentEscapeCode, withBannerBorderEscapeCode, withBannerEscapeCode, withBannerFont, withBannerFontPalette, withCommandEscapeCode, withConsoleWidth, withCopyrightNote, withDescription, withDescriptionEscapeCode, withErrorOut, withEscapeCodesEnabled, withExample, withExample, withExamples, withExamples, withLicenseNote, withLineBreak, withLineSeparatorEscapeCode, withLongOptionPrefix, withMaxConsoleWidth, withName, withOptionEscapeCode, withResetEscapeCode, withSeparatorLnChar, withShortOptionPrefix, withStandardOut, withSyntaxMetrics, withTextBoxGrid, withTitle

Methods inherited from interface org.refcodes.cli.ArgsParserMixin

withEvalArgs, withEvalArgs, withEvalArgs, withEvalArgs

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

letArgumentEscapeCode

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

size

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

toDump, toDump

Methods inherited from interface org.refcodes.mixin.EmptyAccessor

isEmpty

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

containsKey, get, getOr, keySet, use, values

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

letOptionEscapeCode

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, 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, getAnnotator, getDelimiter, 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, retrieveFrom, retrieveTo, 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.SyntaxMetricsProperty

letSyntaxMetrics

Methods inherited from interface org.refcodes.textual.TextBoxGridAccessor

getTextBoxGrid

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

setTextBoxGrid

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

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

evalArgs

List<? extends 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.ArgsParser

Throws:

org.refcodes.cli.ArgsSyntaxException

evalArgs

List<? extends 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.ArgsParser

Throws:

org.refcodes.cli.ArgsSyntaxException

evalArgs

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

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

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.

evalArgs

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

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

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.

withEvalArgs

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

Same as 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.ArgsParser

Specified by:

withEvalArgs in interface org.refcodes.cli.ArgsParserMixin<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

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

Same as 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.ArgsParser

Specified by:

withEvalArgs in interface org.refcodes.cli.ArgsParserMixin<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

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

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

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

default ArgsParserProperties withEvalArgs(String aToPath,
 String[] aArgs)
                                   throws org.refcodes.cli.ArgsSyntaxException

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

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.