Interface ArgsParserProperties

  • All Superinterfaces:
    org.refcodes.console.ArgsParser, org.refcodes.console.ArgsParserMixin<org.refcodes.console.ArgsParser>, org.refcodes.structure.CanonicalMap, org.refcodes.structure.Containable, org.refcodes.mixin.DelimiterAccessor, org.refcodes.mixin.DescriptionAccessor.DescriptionBuilder<org.refcodes.console.ArgsParser>, org.refcodes.mixin.DescriptionAccessor.DescriptionMutator, org.refcodes.structure.Dictionary<java.lang.String,java.lang.String>, org.refcodes.mixin.Dumpable, org.refcodes.structure.Keys<java.lang.String,java.lang.String>, org.refcodes.mixin.NameAccessor.NameBuilder<org.refcodes.console.ArgsParser>, org.refcodes.mixin.NameAccessor.NameMutator, org.refcodes.structure.PathMap<java.lang.String>, org.refcodes.configuration.Properties, org.refcodes.structure.PropertiesAccessorMixin, org.refcodes.component.Resetable, org.refcodes.console.RootConditionAccessor, org.refcodes.mixin.TitleAccessor.TitleBuilder<org.refcodes.console.ArgsParser>, org.refcodes.mixin.TitleAccessor.TitleMutator, org.refcodes.mixin.TypeAccessor<java.lang.String>
    All Known Implementing Classes:
    ArgsParserPropertiesImpl

    public interface ArgsParserProperties
    extends org.refcodes.configuration.Properties, org.refcodes.console.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.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.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.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.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.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.mixin.TypeAccessor

        org.refcodes.mixin.TypeAccessor.TypeMutator<T extends java.lang.Object>, org.refcodes.mixin.TypeAccessor.TypeProperty<T extends java.lang.Object>
    • Field Summary

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

        DEFAULT_COMMENT
    • 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 this Properties instance.
      java.util.List<? extends org.refcodes.console.Operand<?>> evalArgs​(java.lang.String aToPath, java.lang.String[] aArgs)
      Same as evalArgs(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 as evalArgs(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 this Properties instance.
      default ArgsParserProperties withEvalArgs​(java.lang.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​(java.lang.String aToPath, java.lang.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​(java.lang.String aToPath, java.util.List<java.lang.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​(java.util.List<java.lang.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.console.ArgsParser

        errorLn, getRootCondition, printBanner, printCopyrightNote, printDescription, printHelp, printLicenseNote, printLn, printLn, printOptions, printSeparatorLn, printUsage, setBannerFont, setBannerFontPalette, setConsoleWidth, setCopyrightNote, setErrorOut, setLicenseNote, setLineBreak, setMaxConsoleWidth, setSeparatorChar, setStandardOut, setSyntaxNotation, setUsageLabel, withBannerFont, withBannerFontPalette, withConsoleWidth, withCopyrightNote, withDescription, withErrorOut, withLicenseNote, withLineBreak, withMaxConsoleWidth, withName, withParseArgs, withSeparatorChar, withStandardOut, withSyntaxNotation, withTitle, withUsageLabel
      • Methods inherited from interface org.refcodes.console.ArgsParserMixin

        withParseArgs
      • Methods inherited from interface org.refcodes.structure.CanonicalMap

        toInstance, toInstance, toType, toType
      • Methods inherited from interface org.refcodes.structure.Containable

        isEmpty, size
      • Methods inherited from interface org.refcodes.mixin.DescriptionAccessor.DescriptionMutator

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

        toDump, toDump
      • Methods inherited from interface org.refcodes.structure.Keys

        containsKey, get, keySet, use, values
      • Methods inherited from interface org.refcodes.mixin.NameAccessor.NameMutator

        setName
      • Methods inherited from interface org.refcodes.structure.PathMap

        directories, directories, entries, entries, fromExternalKey, get, get, getArray, getArray, getBoolean, getBoolean, getByte, getByte, getCharacter, getCharacter, getDouble, getDouble, getFloat, getFloat, getIndexes, getIndexes, getInteger, getInteger, getLong, getLong, getRootPath, getShort, getShort, hasIndexed, hasIndexed, hasParentPath, isArray, isArray, isDirectory, isEntry, isIndexed, isIndexed, isPath, isRecord, isRootPath, keySet, paths, paths, queryPaths, records, records, toDataStructure, toDataStructure, toExternalKey, toMap, toNormalizedPath, toNormalizedPath, toParentPath, toPath, toPath
      • Methods inherited from interface org.refcodes.configuration.Properties

        childrenOf, containsValue, getDelimiter, getIndexed, getIndexed, getType, query, query, queryFrom, queryTo, retrieve, retrieveFrom, retrieveTo, toMap, toProperties, toPropertyPath
      • Methods inherited from interface org.refcodes.structure.PropertiesAccessorMixin

        containsKey, get, getBoolean, getBoolean, getByte, getByte, getCharacter, getCharacter, getDouble, getDouble, getFloat, getFloat, getInteger, getInteger, getLong, getLong, getShort, getShort, use, useBoolean, useBoolean, useByte, useByte, useDouble, useDouble, useFloat, useFloat, useInteger, useInteger, useLong, useLong, useShort, useShort
      • Methods inherited from interface org.refcodes.component.Resetable

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

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