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<String,String>
, org.refcodes.mixin.Dumpable
, org.refcodes.structure.Keys<String,String>
, org.refcodes.mixin.NameAccessor.NameBuilder<org.refcodes.console.ArgsParser>
, org.refcodes.mixin.NameAccessor.NameMutator
, org.refcodes.structure.PathMap<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<String>
ArgsParserPropertiesImpl
public interface ArgsParserProperties
extends org.refcodes.configuration.Properties, org.refcodes.console.ArgsParser
ArgsParserProperties
represent Properties
generated from
command line arguments being parsed by a command line syntax as of the
definition for the ArgsParser
.org.refcodes.structure.CanonicalMap.CanonicalMapBuilder, org.refcodes.structure.CanonicalMap.MutableCanonicalMap
org.refcodes.mixin.DelimiterAccessor.DelimiterBuilder<B extends org.refcodes.mixin.DelimiterAccessor.DelimiterBuilder<B>>, org.refcodes.mixin.DelimiterAccessor.DelimiterMutator, org.refcodes.mixin.DelimiterAccessor.DelimiterProperty
org.refcodes.structure.Dictionary.MutableDictionary<K extends Object,V extends Object>
org.refcodes.structure.Keys.MutableKeys<K extends Object,V extends Object>, org.refcodes.structure.Keys.MutableValues<K extends Object,V extends Object>
org.refcodes.structure.PathMap.MutablePathMap<T extends Object>, org.refcodes.structure.PathMap.PathMapBuilder<T extends Object>
org.refcodes.configuration.Properties.MutableProperties, org.refcodes.configuration.Properties.PropertiesBuilder
org.refcodes.structure.PropertiesAccessorMixin.PropertiesBuilderMixin<T extends Object>, org.refcodes.structure.PropertiesAccessorMixin.PropertiesMixin, org.refcodes.structure.PropertiesAccessorMixin.PropertiesMutatorMixin
org.refcodes.console.RootConditionAccessor.RootConditionBuilder<B extends org.refcodes.console.RootConditionAccessor.RootConditionBuilder<B>>, org.refcodes.console.RootConditionAccessor.RootConditionMutator, org.refcodes.console.RootConditionAccessor.RootConditionProperty
Modifier and Type | Method | Description |
---|---|---|
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
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
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. |
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. |
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
toInstance, toInstance, toType, toType
setDescription
containsKey, get, get, keySet, use, values
directories, directories, entries, entries, fromExternalKey, getArray, getArray, getRootPath, hasParentPath, isArray, isArray, isDirectory, isEntry, isRecord, isRootPath, keySet, paths, paths, records, records, toDataStructure, toDataStructure, toExternalKey, toMap, toNormalizedPath, toNormalizedPath, toParentPath, toPath
childrenOf, containsValue, getDelimiter, getType, retrieve, retrieveFrom, retrieveTo, toMap, toProperties, toPropertyPath
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
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
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!
evalArgs
in interface org.refcodes.console.ArgsParser
org.refcodes.console.UnknownArgsException
org.refcodes.console.AmbiguousArgsException
org.refcodes.console.SuperfluousArgsException
org.refcodes.console.ParseArgsException
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
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!
evalArgs
in interface org.refcodes.console.ArgsParser
org.refcodes.console.UnknownArgsException
org.refcodes.console.AmbiguousArgsException
org.refcodes.console.SuperfluousArgsException
org.refcodes.console.ParseArgsException
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
evalArgs(String[])
with the difference that the
identified properties are inserted below the provided path.aToPath
- The path below which to insert the identified properties.aArgs
- The command line arguments to be evaluated.Operand
interfaces or its sub-types.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 typeList<? 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
evalArgs(String[])
with the difference that the
identified properties are inserted below the provided path.aToPath
- The path below which to insert the identified properties.aArgs
- The command line arguments to be evaluated.Operand
interfaces or its sub-types.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 typedefault ArgsParserProperties withEvalArgs(String[] aArgs) throws org.refcodes.console.UnknownArgsException, org.refcodes.console.AmbiguousArgsException, org.refcodes.console.SuperfluousArgsException, org.refcodes.console.ParseArgsException
evalArgs(String[])
with the difference that this class's
instance being invoked is returned as of the builder pattern.withEvalArgs
in interface org.refcodes.console.ArgsParser
aArgs
- The command line arguments to be evaluated.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 typedefault ArgsParserProperties withEvalArgs(List<String> aArgs) throws org.refcodes.console.UnknownArgsException, org.refcodes.console.AmbiguousArgsException, org.refcodes.console.SuperfluousArgsException, org.refcodes.console.ParseArgsException
evalArgs(List)
with the difference that this class's
instance being invoked is returned as of the builder pattern.withEvalArgs
in interface org.refcodes.console.ArgsParser
aArgs
- The command line arguments to be evaluated.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 typedefault ArgsParserProperties withEvalArgs(String aToPath, List<String> aArgs) throws org.refcodes.console.UnknownArgsException, org.refcodes.console.AmbiguousArgsException, org.refcodes.console.SuperfluousArgsException, org.refcodes.console.ParseArgsException
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.aToPath
- The path below which to insert the identified properties.aArgs
- The command line arguments to be evaluated.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 typedefault ArgsParserProperties withEvalArgs(String aToPath, String[] aArgs) throws org.refcodes.console.UnknownArgsException, org.refcodes.console.AmbiguousArgsException, org.refcodes.console.SuperfluousArgsException, org.refcodes.console.ParseArgsException
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.aToPath
- The path below which to insert the identified properties.aArgs
- The command line arguments to be evaluated.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 typeCopyright © 2018. All rights reserved.