Interface ArgsParserProperties
-
- All Superinterfaces:
org.refcodes.mixin.AnnotatorAccessor
,org.refcodes.console.ArgsParser
,org.refcodes.console.ArgsParserMixin<java.lang.String>
,org.refcodes.structure.CanonicalMap
,org.refcodes.structure.Containable
,org.refcodes.mixin.DelimiterAccessor
,org.refcodes.mixin.DescriptionAccessor
,org.refcodes.mixin.DescriptionAccessor.DescriptionBuilder<java.lang.String>
,org.refcodes.mixin.DescriptionAccessor.DescriptionMutator
,org.refcodes.mixin.DescriptionAccessor.DescriptionProperty
,org.refcodes.structure.Dictionary<java.lang.String,T>
,org.refcodes.mixin.Dumpable
,org.refcodes.mixin.EscapeCodesStatusAccessor
,org.refcodes.mixin.EscapeCodesStatusAccessor.EscapeCodeStatusBuilder<java.lang.String>
,org.refcodes.mixin.EscapeCodesStatusAccessor.EscapeCodeStatusMutator
,org.refcodes.mixin.EscapeCodesStatusAccessor.EscapeCodeStatusProperty
,org.refcodes.structure.Keys<java.lang.String,T>
,org.refcodes.mixin.NameAccessor
,org.refcodes.mixin.NameAccessor.NameBuilder<java.lang.String>
,org.refcodes.mixin.NameAccessor.NameMutator
,org.refcodes.mixin.NameAccessor.NameProperty
,org.refcodes.structure.PathMap<java.lang.String>
,org.refcodes.configuration.Properties
,org.refcodes.structure.PropertiesAccessorMixin
,org.refcodes.component.Resetable
,org.refcodes.mixin.ResetEscapeCodeAccessor
,org.refcodes.mixin.ResetEscapeCodeAccessor.ResetEscapeCodeBuilder<java.lang.String>
,org.refcodes.mixin.ResetEscapeCodeAccessor.ResetEscapeCodeMutator
,org.refcodes.mixin.ResetEscapeCodeAccessor.ResetEscapeCodeProperty
,org.refcodes.console.RootConditionAccessor
,org.refcodes.mixin.TitleAccessor
,org.refcodes.mixin.TitleAccessor.TitleBuilder<java.lang.String>
,org.refcodes.mixin.TitleAccessor.TitleMutator
,org.refcodes.mixin.TitleAccessor.TitleProperty
,org.refcodes.mixin.TypeAccessor<java.lang.String>
- All Known Implementing Classes:
ArgsParserPropertiesImpl
public interface ArgsParserProperties extends org.refcodes.configuration.Properties, org.refcodes.console.ArgsParser
TheArgsParserProperties
representProperties
generated from command line arguments being parsed by a command line syntax as of the definition for theArgsParser
.
-
-
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.structure.CanonicalMap
org.refcodes.structure.CanonicalMap.CanonicalMapBuilder, org.refcodes.structure.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.structure.Dictionary
org.refcodes.structure.Dictionary.MutableDictionary<K extends java.lang.Object,V extends java.lang.Object>
-
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.structure.Keys
org.refcodes.structure.Keys.MutableKeys<K extends java.lang.Object,V extends java.lang.Object>, org.refcodes.structure.Keys.MutableValues<K extends java.lang.Object,V extends java.lang.Object>
-
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.structure.PathMap
org.refcodes.structure.PathMap.MutablePathMap<T extends java.lang.Object>, org.refcodes.structure.PathMap.PathMapBuilder<T extends java.lang.Object>
-
Nested classes/interfaces inherited from interface org.refcodes.configuration.Properties
org.refcodes.configuration.Properties.MutableProperties, org.refcodes.configuration.Properties.PropertiesBuilder
-
Nested classes/interfaces inherited from interface org.refcodes.structure.PropertiesAccessorMixin
org.refcodes.structure.PropertiesAccessorMixin.PropertiesBuilderMixin<T extends java.lang.Object>, org.refcodes.structure.PropertiesAccessorMixin.PropertiesMixin, org.refcodes.structure.PropertiesAccessorMixin.PropertiesMutatorMixin
-
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.console.RootConditionAccessor
org.refcodes.console.RootConditionAccessor.RootConditionBuilder<B extends org.refcodes.console.RootConditionAccessor.RootConditionBuilder<B>>, org.refcodes.console.RootConditionAccessor.RootConditionMutator, org.refcodes.console.RootConditionAccessor.RootConditionProperty
-
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description java.util.List<? extends org.refcodes.console.Operand<?>>
evalArgs(java.lang.String[] aArgs)
Evaluates the command line arguments and sets the identified properties in thisProperties
instance.java.util.List<? extends org.refcodes.console.Operand<?>>
evalArgs(java.lang.String aToPath, java.lang.String[] aArgs)
Same asevalArgs(String[])
with the difference that the identified properties are inserted below the provided path.java.util.List<? extends org.refcodes.console.Operand<?>>
evalArgs(java.lang.String aToPath, java.util.List<java.lang.String> aArgs)
Same asevalArgs(String[])
with the difference that the identified properties are inserted below the provided path.java.util.List<? extends org.refcodes.console.Operand<?>>
evalArgs(java.util.List<java.lang.String> aArgs)
Evaluates the command line arguments and sets the identified properties in thisProperties
instance.default ArgsParserProperties
withEvalArgs(java.lang.String[] aArgs)
Same asevalArgs(String[])
with the difference that this class's instance being invoked is returned as of the builder pattern.default ArgsParserProperties
withEvalArgs(java.lang.String aToPath, java.lang.String[] aArgs)
Same asevalArgs(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(java.lang.String aToPath, java.util.List<java.lang.String> aArgs)
Same asevalArgs(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(java.util.List<java.lang.String> aArgs)
Same asevalArgs(List)
with the difference that this class's instance being invoked is returned as of the builder pattern.-
Methods inherited from interface org.refcodes.console.ArgsParser
errorLn, getBannerBorderEscapeCode, getBannerEscapeCode, getCopyrightNote, getDescription, getLicenseNote, getLineSeparatorEscapeCode, getParameterDescriptionEscapeCode, getParameterEscapeCode, getRootCondition, printBanner, printBody, printCopyrightNote, printDescription, printHelp, printLicenseNote, printLn, printLn, printOptions, printSeparatorLn, printUsage, setBannerBorderEscapeCode, setBannerEscapeCode, setBannerFont, setBannerFontPalette, setConsoleWidth, setCopyrightNote, setErrorOut, setLicenseNote, setLineBreak, setLineSeparatorEscapeCode, setMaxConsoleWidth, setParameterDescriptionEscapeCode, setParameterEscapeCode, setSeparatorChar, setStandardOut, setSyntaxNotation, setUsageLabel, withBannerBorderEscapeCode, withBannerEscapeCode, withBannerFont, withBannerFontPalette, withConsoleWidth, withCopyrightNote, withDescription, withErrorOut, withEscapeCodesEnabled, withLicenseNote, withLineBreak, withLineSeparatorEscapeCode, withMaxConsoleWidth, withName, withParameterDescriptionEscapeCode, withParameterEscapeCode, withParseArgs, withResetEscapeCode, withSeparatorChar, withStandardOut, withSyntaxNotation, withTitle, withUsageLabel
-
Methods inherited from interface org.refcodes.structure.CanonicalMap
getBoolean, getBoolean, getBooleanOr, getBooleanOr, getByte, getByte, getByteOr, getByteOr, getCharacter, getCharacter, getCharacterOr, getCharacterOr, getDouble, getDouble, getDoubleOr, getDoubleOr, getFloat, getFloat, getFloatOr, getFloatOr, getInteger, getInteger, getIntegerOr, getIntegerOr, getLong, getLong, getLongOr, getLongOr, getShort, getShort, getShortOr, getShortOr, toInstance, toInstance, toMap, toProperties, toType, toType
-
Methods inherited from interface org.refcodes.mixin.DescriptionAccessor.DescriptionMutator
setDescription
-
Methods inherited from interface org.refcodes.mixin.EscapeCodesStatusAccessor.EscapeCodeStatusMutator
setEscapeCodesEnabled
-
Methods inherited from interface org.refcodes.structure.Keys
containsKey, get, getOr, keySet, use, values
-
Methods inherited from interface org.refcodes.structure.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, getArrayIndexes, getArrayIndexes, getArrayIndexes, getArrayIndexes, getArrayIndexes, getDirAt, getDirAt, getDirAt, getDirAt, 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, hasValueAt, hasValueAt, hasValueAt, hasValueAt, hasValueAt, hasValueAt, hasValueAt, hasValueAt, isArray, isArray, isArray, isArray, isArray, isArray, isArrayIndex, isArrayIndex, isArrayIndex, isArrayIndex, isArrayIndex, isArrayIndex, isChild, isChild, isChild, isChild, isDir, isDir, isDir, isDir, isDir, isDirIndex, isDirIndex, isDirIndex, isDirIndex, isDirIndex, isEqualTo, isLeaf, isLeaf, isLeaf, isLeaf, isLeaf, isRootPath, 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, sortedKeys, toDataStructure, toDataStructure, toExternalPath, toLeaf, toMap, toNormalizedPath, toParentPath, toPath, toPath, toPath, toPathElements, toPathList, toPathStack, toPropertyPath
-
Methods inherited from interface org.refcodes.configuration.Properties
containsValue, getAnnotator, getDelimiter, getDirAt, getDirAt, getType, query, query, query, query, queryBetween, queryBetween, queryBetween, queryBetween, queryBetween, queryFrom, queryFrom, queryFrom, queryFrom, queryFrom, 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.structure.PropertiesAccessorMixin
asArray, asArray, asArray, asArray, asBooleanArray, asBooleanArray, asBooleanArray, asBooleanArray, asByteArray, asByteArray, asByteArray, asByteArray, asCharacterArray, asCharacterArray, asCharacterArray, asCharacterArray, asDoubleArray, asDoubleArray, asDoubleArray, asDoubleArray, asFloatArray, asFloatArray, asFloatArray, asFloatArray, asIntegerArray, asIntegerArray, asIntegerArray, asIntegerArray, asLongArray, asLongArray, asLongArray, asLongArray, asShortArray, asShortArray, asShortArray, asShortArray, getBoolean, getBoolean, getBooleanOr, getBooleanOr, getByte, getByte, getByteOr, getByteOr, getCharacter, getCharacter, getCharacterOr, getCharacterOr, getDouble, getDouble, getDoubleOr, getDoubleOr, getFloat, getFloat, getFloatOr, getFloatOr, getInteger, getInteger, getIntegerOr, getIntegerOr, getLong, getLong, getLongOr, getLongOr, getShort, getShort, getShortOr, getShortOr
-
-
-
-
Method Detail
-
evalArgs
java.util.List<? extends org.refcodes.console.Operand<?>> evalArgs(java.lang.String[] aArgs) throws org.refcodes.console.UnknownArgsException, org.refcodes.console.AmbiguousArgsException, org.refcodes.console.SuperfluousArgsException, org.refcodes.console.ParseArgsException
Evaluates the command line arguments and sets the identified properties in thisProperties
instance. Previously identified properties are reset upon invocation of this method. When provided, then anOperand
's alias is used as property name, else as fall back, the operand's (when being of sub-typeOption
) long-option or short-option is used. Make sure, to provide an alias to make theProperties
work and feel as intended!- Specified by:
evalArgs
in interfaceorg.refcodes.console.ArgsParser
- Throws:
org.refcodes.console.UnknownArgsException
org.refcodes.console.AmbiguousArgsException
org.refcodes.console.SuperfluousArgsException
org.refcodes.console.ParseArgsException
-
evalArgs
java.util.List<? extends org.refcodes.console.Operand<?>> evalArgs(java.util.List<java.lang.String> aArgs) throws org.refcodes.console.UnknownArgsException, org.refcodes.console.AmbiguousArgsException, org.refcodes.console.SuperfluousArgsException, org.refcodes.console.ParseArgsException
Evaluates the command line arguments and sets the identified properties in thisProperties
instance. Previously identified properties are reset upon invocation of this method. When provided, then anOperand
's alias is used as property name, else as fall back, the operand's (when being of sub-typeOption
) long-option or short-option is used. Make sure, to provide an alias to make theProperties
work and feel as intended!- Specified by:
evalArgs
in interfaceorg.refcodes.console.ArgsParser
- Throws:
org.refcodes.console.UnknownArgsException
org.refcodes.console.AmbiguousArgsException
org.refcodes.console.SuperfluousArgsException
org.refcodes.console.ParseArgsException
-
evalArgs
java.util.List<? extends org.refcodes.console.Operand<?>> evalArgs(java.lang.String aToPath, java.util.List<java.lang.String> aArgs) throws org.refcodes.console.UnknownArgsException, org.refcodes.console.AmbiguousArgsException, org.refcodes.console.SuperfluousArgsException, org.refcodes.console.ParseArgsException
Same asevalArgs(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.console.UnknownArgsException
- Thrown in case not one command line argument matched regarding the provided args vs. the expected args.org.refcodes.console.AmbiguousArgsException
- Thrown in case at least one command line argument is ambiguous regarding expected args vs. provided args.org.refcodes.console.SuperfluousArgsException
- Thrown in case there were arguments found not being used (superfluous arguments).org.refcodes.console.ParseArgsException
- Thrown in case the provided command line arguments do not respect the required syntax or cannot be converted to the required type
-
evalArgs
java.util.List<? extends org.refcodes.console.Operand<?>> evalArgs(java.lang.String aToPath, java.lang.String[] aArgs) throws org.refcodes.console.UnknownArgsException, org.refcodes.console.AmbiguousArgsException, org.refcodes.console.SuperfluousArgsException, org.refcodes.console.ParseArgsException
Same asevalArgs(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.console.UnknownArgsException
- Thrown in case not one command line argument matched regarding the provided args vs. the expected args.org.refcodes.console.AmbiguousArgsException
- Thrown in case at least one command line argument is ambiguous regarding expected args vs. provided args.org.refcodes.console.SuperfluousArgsException
- Thrown in case there were arguments found not being used (superfluous arguments).org.refcodes.console.ParseArgsException
- Thrown in case the provided command line arguments do not respect the required syntax or cannot be converted to the required type
-
withEvalArgs
default ArgsParserProperties withEvalArgs(java.lang.String[] aArgs) throws org.refcodes.console.UnknownArgsException, org.refcodes.console.AmbiguousArgsException, org.refcodes.console.SuperfluousArgsException, org.refcodes.console.ParseArgsException
Same asevalArgs(String[])
with the difference that this class's instance being invoked is returned as of the builder pattern.- Specified by:
withEvalArgs
in interfaceorg.refcodes.console.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.console.UnknownArgsException
- Thrown in case not one command line argument matched regarding the provided args vs. the expected args.org.refcodes.console.AmbiguousArgsException
- Thrown in case at least one command line argument is ambiguous regarding expected args vs. provided args.org.refcodes.console.SuperfluousArgsException
- Thrown in case there were arguments found not being used (superfluous arguments).org.refcodes.console.ParseArgsException
- Thrown in case the provided command line arguments do not respect the required syntax or cannot be converted to the required type
-
withEvalArgs
default ArgsParserProperties withEvalArgs(java.util.List<java.lang.String> aArgs) throws org.refcodes.console.UnknownArgsException, org.refcodes.console.AmbiguousArgsException, org.refcodes.console.SuperfluousArgsException, org.refcodes.console.ParseArgsException
Same asevalArgs(List)
with the difference that this class's instance being invoked is returned as of the builder pattern.- Specified by:
withEvalArgs
in interfaceorg.refcodes.console.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.console.UnknownArgsException
- Thrown in case not one command line argument matched regarding the provided args vs. the expected args.org.refcodes.console.AmbiguousArgsException
- Thrown in case at least one command line argument is ambiguous regarding expected args vs. provided args.org.refcodes.console.SuperfluousArgsException
- Thrown in case there were arguments found not being used (superfluous arguments).org.refcodes.console.ParseArgsException
- Thrown in case the provided command line arguments do not respect the required syntax or cannot be converted to the required type
-
withEvalArgs
default ArgsParserProperties withEvalArgs(java.lang.String aToPath, java.util.List<java.lang.String> aArgs) throws org.refcodes.console.UnknownArgsException, org.refcodes.console.AmbiguousArgsException, org.refcodes.console.SuperfluousArgsException, org.refcodes.console.ParseArgsException
Same asevalArgs(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.console.UnknownArgsException
- Thrown in case not one command line argument matched regarding the provided args vs. the expected args.org.refcodes.console.AmbiguousArgsException
- Thrown in case at least one command line argument is ambiguous regarding expected args vs. provided args.org.refcodes.console.SuperfluousArgsException
- Thrown in case there were arguments found not being used (superfluous arguments).org.refcodes.console.ParseArgsException
- Thrown in case the provided command line arguments do not respect the required syntax or cannot be converted to the required type
-
withEvalArgs
default ArgsParserProperties withEvalArgs(java.lang.String aToPath, java.lang.String[] aArgs) throws org.refcodes.console.UnknownArgsException, org.refcodes.console.AmbiguousArgsException, org.refcodes.console.SuperfluousArgsException, org.refcodes.console.ParseArgsException
Same asevalArgs(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.console.UnknownArgsException
- Thrown in case not one command line argument matched regarding the provided args vs. the expected args.org.refcodes.console.AmbiguousArgsException
- Thrown in case at least one command line argument is ambiguous regarding expected args vs. provided args.org.refcodes.console.SuperfluousArgsException
- Thrown in case there were arguments found not being used (superfluous arguments).org.refcodes.console.ParseArgsException
- Thrown in case the provided command line arguments do not respect the required syntax or cannot be converted to the required type
-
-