Package org.refcodes.configuration.ext.console

Class ArgsParserPropertiesImpl

  • All Implemented Interfaces:
    org.refcodes.component.Resetable, ArgsParserProperties, org.refcodes.configuration.Properties, org.refcodes.console.ArgsParser, org.refcodes.console.ArgsParserMixin<String>, org.refcodes.console.RootConditionAccessor, org.refcodes.mixin.AnnotatorAccessor, org.refcodes.mixin.DelimiterAccessor, org.refcodes.mixin.DescriptionAccessor, org.refcodes.mixin.DescriptionAccessor.DescriptionBuilder<String>, org.refcodes.mixin.DescriptionAccessor.DescriptionMutator, org.refcodes.mixin.DescriptionAccessor.DescriptionProperty, org.refcodes.mixin.Dumpable, org.refcodes.mixin.EscapeCodesStatusAccessor, org.refcodes.mixin.EscapeCodesStatusAccessor.EscapeCodeStatusBuilder<String>, org.refcodes.mixin.EscapeCodesStatusAccessor.EscapeCodeStatusMutator, org.refcodes.mixin.EscapeCodesStatusAccessor.EscapeCodeStatusProperty, org.refcodes.mixin.NameAccessor, org.refcodes.mixin.NameAccessor.NameBuilder<String>, org.refcodes.mixin.NameAccessor.NameMutator, org.refcodes.mixin.NameAccessor.NameProperty, org.refcodes.mixin.ResetEscapeCodeAccessor, org.refcodes.mixin.ResetEscapeCodeAccessor.ResetEscapeCodeBuilder<String>, org.refcodes.mixin.ResetEscapeCodeAccessor.ResetEscapeCodeMutator, org.refcodes.mixin.ResetEscapeCodeAccessor.ResetEscapeCodeProperty, org.refcodes.mixin.TitleAccessor, org.refcodes.mixin.TitleAccessor.TitleBuilder<String>, org.refcodes.mixin.TitleAccessor.TitleMutator, org.refcodes.mixin.TitleAccessor.TitleProperty, org.refcodes.mixin.TypeAccessor<String>, org.refcodes.structure.CanonicalMap, org.refcodes.structure.Containable, org.refcodes.structure.Dictionary<String,T>, org.refcodes.structure.Keys<String,T>, org.refcodes.structure.PathMap<String>, org.refcodes.structure.PropertiesAccessorMixin, org.refcodes.textual.TextBoxGridAccessor, org.refcodes.textual.TextBoxGridAccessor.TextBoxGridBuilder<String>, org.refcodes.textual.TextBoxGridAccessor.TextBoxGridMutator, org.refcodes.textual.TextBoxGridAccessor.TextBoxGridProperty

    public class ArgsParserPropertiesImpl
extends org.refcodes.console.ArgsParserImpl
implements ArgsParserProperties

    • 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 Object,V extends 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 Object,V extends Object>, org.refcodes.structure.Keys.MutableValues<K extends Object,V extends 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 Object>, org.refcodes.structure.PathMap.PathMapBuilder<T extends 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 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

      • 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.TypeMutator<T extends Object>, org.refcodes.mixin.TypeAccessor.TypeProperty<T extends Object>

    • Field Summary

      • Fields inherited from class org.refcodes.console.ArgsParserImpl

        _errStream, _stdStream

      • Fields inherited from interface org.refcodes.structure.PathMap

        ANNOTATOR, DELIMITER

      • Fields inherited from interface org.refcodes.configuration.Properties

        DEFAULT_COMMENT

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean containsKey​(Object aKey)
      List<? extends org.refcodes.console.Operand<?>> evalArgs​(String[] aArgs)
      Evaluates the command line arguments and sets the identified properties in this Properties instance.
      List<? extends org.refcodes.console.Operand<?>> evalArgs​(String aToPath, String[] aArgs)
      Same as ArgsParserProperties.evalArgs(String[]) with the difference that the identified properties are inserted below the provided path.
      List<? extends org.refcodes.console.Operand<?>> evalArgs​(String aToPath, List<String> aArgs)
      Same as ArgsParserProperties.evalArgs(String[]) with the difference that the identified properties are inserted below the provided path.
      List<? extends org.refcodes.console.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.configuration.Properties retrieveFrom​(String aFromPath)
      org.refcodes.configuration.Properties retrieveTo​(String aToPath)
      int size​()
      Object toDataStructure​(String aPath)
      Collection<String> values​()

      • Methods inherited from interface org.refcodes.console.ArgsParser

        errorLn, getBannerBorderEscapeCode, getBannerEscapeCode, getCopyrightNote, getDescription, getLicenseNote, getLineSeparatorEscapeCode, getParameterDescriptionEscapeCode, getParameterEscapeCode, getRootCondition, getSeparatorLnChar, printBanner, printBody, printCopyrightNote, printDescription, printHelp, printLicenseNote, printLn, printLn, printOptions, printSeparatorLn, printUsage, setBannerBorderEscapeCode, setBannerEscapeCode, setBannerFont, setBannerFontPalette, setConsoleWidth, setCopyrightNote, setErrorOut, setLicenseNote, setLineBreak, setLineSeparatorEscapeCode, setMaxConsoleWidth, setParameterDescriptionEscapeCode, setParameterEscapeCode, setSeparatorLnChar, setStandardOut, setSyntaxNotation, setUsageLabel, withBannerBorderEscapeCode, withBannerEscapeCode, withBannerFont, withBannerFontPalette, withConsoleWidth, withCopyrightNote, withDescription, withErrorOut, withEscapeCodesEnabled, withLicenseNote, withLineBreak, withLineSeparatorEscapeCode, withMaxConsoleWidth, withName, withParameterDescriptionEscapeCode, withParameterEscapeCode, withParseArgs, withResetEscapeCode, withSeparatorLnChar, withStandardOut, withSyntaxNotation, withTextBoxGrid, withTitle, withUsageLabel

      • Methods inherited from class org.refcodes.console.ArgsParserImpl

        errorLn, fromArgs, getBannerBorderEscapeCode, getBannerEscapeCode, getCopyrightNote, getDescription, getLicenseNote, getLineSeparatorEscapeCode, getName, getParameterDescriptionEscapeCode, getParameterEscapeCode, getResetEscapeCode, getRootCondition, getSeparatorLnChar, getTextBoxGrid, getTitle, isEscapeCodesEnabled, printBanner, printCopyrightNote, printDescription, printLicenseNote, printLn, printLn, printOptions, printSeparatorLn, printUsage, reset, setBannerBorderEscapeCode, setBannerEscapeCode, setBannerFont, setBannerFontPalette, setConsoleWidth, setCopyrightNote, setDescription, setErrorOut, setEscapeCodesEnabled, setLicenseNote, setLineBreak, setLineSeparatorEscapeCode, setMaxConsoleWidth, setName, setParameterDescriptionEscapeCode, setParameterEscapeCode, setResetEscapeCode, setSeparatorLnChar, setStandardOut, setSyntaxNotation, setTextBoxGrid, setTitle, setUsageLabel

      • Methods inherited from interface org.refcodes.console.ArgsParserMixin

        withParseArgs

      • 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, queryBetween, toInstance, toInstance, toMap, toProperties, toType, toType

      • Methods inherited from interface org.refcodes.mixin.DescriptionAccessor.DescriptionMutator

        setDescription

      • Methods inherited from interface org.refcodes.mixin.Dumpable

        toDump, toDump, toPrintable

      • 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.structure.Keys

        getOr, use

      • 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.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, queryPaths, sortedKeys, toDataStructure, toExternalPath, toLeaf, toMap, toNormalizedPath, toParentPath, toPath, toPath, toPath, toPathElements, toPathList, toPathStack, toPropertyPath

      • Methods inherited from interface org.refcodes.configuration.Properties

        containsValue, getDirAt, getDirAt, 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.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

      • Methods inherited from interface org.refcodes.component.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.textual.TextBoxGridAccessor

        getTextBoxGrid

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

        setTextBoxGrid

      • Methods inherited from interface org.refcodes.mixin.TitleAccessor

        getTitle

      • Methods inherited from interface org.refcodes.mixin.TitleAccessor.TitleMutator

        setTitle

    • Constructor Detail

      • ArgsParserPropertiesImpl

        public ArgsParserPropertiesImpl​()
        Constructs the ArgsParserProperties 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 ArgsParserPropertiesImpl(String[]).

      • ArgsParserPropertiesImpl

        public ArgsParserPropertiesImpl​(org.refcodes.console.Condition aRootCondition)
        Constructs the ArgsParserProperties instance with the given root Condition and the default SyntaxNotation.REFCODES.
        Parameters:
        aRootCondition - The root condition being the node from which parsing the command line arguments starts.

      • ArgsParserPropertiesImpl

        public ArgsParserPropertiesImpl​(org.refcodes.console.Option<?> aRootOption)
        Constructs the ArgsParserProperties instance with the given root Option and the default SyntaxNotation.REFCODES.
        Parameters:
        aRootOption - The root option being the node from which parsing the command line arguments starts.

      • ArgsParserPropertiesImpl

        public ArgsParserPropertiesImpl​(String[] aArgs)
        Constructs the ArgsParserProperties instance with the given arguments and the default SyntaxNotation.REFCODES. 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.

      • ArgsParserPropertiesImpl

        public ArgsParserPropertiesImpl​(String[] aArgs,
                                org.refcodes.console.Condition aRootCondition)
                         throws org.refcodes.console.UnknownArgsException,
                                org.refcodes.console.AmbiguousArgsException,
                                org.refcodes.console.SuperfluousArgsException,
                                org.refcodes.console.ParseArgsException
        Constructs the ArgsParserProperties instance with the given root Condition and the default SyntaxNotation.REFCODES.
        Parameters:
        aArgs - The command line arguments to be evaluated.
        aRootCondition - The root condition being the node from which parsing the command line arguments starts.
        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

      • ArgsParserPropertiesImpl

        public ArgsParserPropertiesImpl​(String[] aArgs,
                                org.refcodes.console.Option<?> aRootOption)
                         throws org.refcodes.console.UnknownArgsException,
                                org.refcodes.console.AmbiguousArgsException,
                                org.refcodes.console.SuperfluousArgsException,
                                org.refcodes.console.ParseArgsException
        Constructs the ArgsParserProperties instance with the given root Option and the default SyntaxNotation.REFCODES.
        Parameters:
        aArgs - The command line arguments to be evaluated.
        aRootOption - The root option being the node from which parsing the command line arguments starts.
        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

    • Method Detail

      • evalArgs

        public List<? extends org.refcodes.console.Operand<?>> evalArgs​(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 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.console.ArgsParser
        Specified by:
        evalArgs in interface ArgsParserProperties
        Overrides:
        evalArgs in class org.refcodes.console.ArgsParserImpl
        Throws:
        org.refcodes.console.UnknownArgsException
        org.refcodes.console.AmbiguousArgsException
        org.refcodes.console.SuperfluousArgsException
        org.refcodes.console.ParseArgsException

      • evalArgs

        public List<? extends org.refcodes.console.Operand<?>> evalArgs​(List<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 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.console.ArgsParser
        Specified by:
        evalArgs in interface ArgsParserProperties
        Throws:
        org.refcodes.console.UnknownArgsException
        org.refcodes.console.AmbiguousArgsException
        org.refcodes.console.SuperfluousArgsException
        org.refcodes.console.ParseArgsException

      • evalArgs

        public List<? extends org.refcodes.console.Operand<?>> evalArgs​(String aToPath,
                                                                List<String> aArgs)
                                                         throws org.refcodes.console.UnknownArgsException,
                                                                org.refcodes.console.AmbiguousArgsException,
                                                                org.refcodes.console.SuperfluousArgsException,
                                                                org.refcodes.console.ParseArgsException
        Same as ArgsParserProperties.evalArgs(String[]) with the difference that the identified properties are inserted below the provided path.
        Specified by:
        evalArgs in interface ArgsParserProperties
        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

      • getAnnotator

        public char getAnnotator​()
        Specified by:
        getAnnotator in interface org.refcodes.mixin.AnnotatorAccessor
        Specified by:
        getAnnotator in interface org.refcodes.configuration.Properties

      • getDelimiter

        public char getDelimiter​()
        Specified by:
        getDelimiter in interface org.refcodes.mixin.DelimiterAccessor
        Specified by:
        getDelimiter in interface org.refcodes.configuration.Properties
        Overrides:
        getDelimiter in class org.refcodes.console.ArgsParserImpl

      • size

        public int size​()
        Specified by:
        size in interface org.refcodes.structure.Containable

      • containsKey

        public boolean containsKey​(Object aKey)
        Specified by:
        containsKey in interface org.refcodes.structure.Keys<String,T extends Object>

      • isEmpty

        public boolean isEmpty​()
        Specified by:
        isEmpty in interface org.refcodes.structure.Containable

      • get

        public String get​(Object aKey)
        Specified by:
        get in interface org.refcodes.structure.Keys<String,T extends Object>

      • keySet

        public Set<String> keySet​()
        Specified by:
        keySet in interface org.refcodes.structure.Keys<String,T extends Object>

      • retrieveFrom

        public org.refcodes.configuration.Properties retrieveFrom​(String aFromPath)
        Specified by:
        retrieveFrom in interface org.refcodes.structure.CanonicalMap
        Specified by:
        retrieveFrom in interface org.refcodes.structure.PathMap<String>
        Specified by:
        retrieveFrom in interface org.refcodes.configuration.Properties

      • retrieveTo

        public org.refcodes.configuration.Properties retrieveTo​(String aToPath)
        Specified by:
        retrieveTo in interface org.refcodes.structure.CanonicalMap
        Specified by:
        retrieveTo in interface org.refcodes.structure.PathMap<String>
        Specified by:
        retrieveTo in interface org.refcodes.configuration.Properties

      • toDataStructure

        public Object toDataStructure​(String aPath)
        Specified by:
        toDataStructure in interface org.refcodes.structure.PathMap<String>

      • evalArgs

        public List<? extends org.refcodes.console.Operand<?>> evalArgs​(String aToPath,
                                                                String[] aArgs)
                                                         throws org.refcodes.console.UnknownArgsException,
                                                                org.refcodes.console.AmbiguousArgsException,
                                                                org.refcodes.console.SuperfluousArgsException,
                                                                org.refcodes.console.ParseArgsException
        Same as ArgsParserProperties.evalArgs(String[]) with the difference that the identified properties are inserted below the provided path.
        Specified by:
        evalArgs in interface ArgsParserProperties
        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