org.refcodes.configuration

Class ArgsProperties

java.lang.Object

org.refcodes.configuration.PropertiesImpl

org.refcodes.configuration.ArgsProperties

All Implemented Interfaces:

Properties, org.refcodes.mixin.DelimiterAccessor, org.refcodes.mixin.Dumpable, org.refcodes.mixin.TypeAccessor<String>, org.refcodes.structure.CanonicalMap, org.refcodes.structure.Containable, org.refcodes.structure.Dictionary<String,String>, org.refcodes.structure.Keys<String,String>, org.refcodes.structure.PathMap<String>, org.refcodes.structure.PropertiesAccessorMixin

public class ArgsProperties
extends PropertiesImpl
implements Properties

The ArgsProperties takes them command line arguments "as is" and converts them into key/value pairs as of the Properties semantics. Keys for the key/value-pairs are identified by prefixes, usually as defined by the CommandArgPrefix enumeration. Such a key is without the prefix called option and used used as key in the Properties instance. If the succeeding argument is not an option, then the succeeding argument is used as the option's value, else the current option is treated as boolean property with a value of "true".

Nested Class Summary

Nested classes/interfaces inherited from interface org.refcodes.configuration.Properties

Properties.MutableProperties, Properties.PropertiesBuilder

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

org.refcodes.structure.PathMap.MutablePathMap<T>, org.refcodes.structure.PathMap.PathMapBuilder<T>

Nested classes/interfaces inherited from interface org.refcodes.structure.Dictionary

org.refcodes.structure.Dictionary.MutableDictionary<K,V>

Nested classes/interfaces inherited from interface org.refcodes.structure.Keys

org.refcodes.structure.Keys.MutableKeys<K,V>, org.refcodes.structure.Keys.MutableValues<K,V>

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

org.refcodes.mixin.TypeAccessor.TypeMutator<T>, org.refcodes.mixin.TypeAccessor.TypeProperty<T>

Nested classes/interfaces inherited from interface org.refcodes.structure.PropertiesAccessorMixin

org.refcodes.structure.PropertiesAccessorMixin.PropertiesBuilderMixin<T>, org.refcodes.structure.PropertiesAccessorMixin.PropertiesMixin, org.refcodes.structure.PropertiesAccessorMixin.PropertiesMutatorMixin

Field Summary

Fields inherited from class org.refcodes.configuration.PropertiesImpl

_properties

Fields inherited from interface org.refcodes.configuration.Properties

DEFAULT_COMMENT

Constructor Summary

Constructors

Constructor and Description
ArgsProperties(String[] aArgs) Constructs the ArgsProperties from the provided command line arguments using the prefixes as defined by the CommandArgPrefix enumeration to identify the keys (and the values) from the provided arguments.
ArgsProperties(String[] aArgs, String... aPrefixes) Constructs the ArgsProperties from the provided command line arguments using the provided prefixes to identify the keys (and the values) from the provided arguments.

Method Summary

Methods inherited from class org.refcodes.configuration.PropertiesImpl

childrenOf, containsKey, get, getDelimiter, getType, isEmpty, keySet, retrieveFrom, retrieveTo, size, toDataStructure, values

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.refcodes.configuration.Properties

childrenOf, containsValue, getDelimiter, getType, retrieve, retrieveFrom, retrieveTo, toMap, toProperties, toPropertyPath

Methods inherited from interface org.refcodes.structure.CanonicalMap

toInstance, toInstance, toType, toType

Methods inherited from interface org.refcodes.structure.PathMap

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

Methods inherited from interface org.refcodes.structure.Keys

containsKey, get, keySet, use, values

Methods inherited from interface org.refcodes.structure.Containable

isEmpty, size

Methods inherited from interface org.refcodes.mixin.Dumpable

toDump, toDump

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

Constructor Detail

ArgsProperties

public ArgsProperties(String[] aArgs)

Constructs the ArgsProperties from the provided command line arguments using the prefixes as defined by the CommandArgPrefix enumeration to identify the keys (and the values) from the provided arguments.

Parameters:

aArgs - The arguments from which to extract key/value-pairs.

ArgsProperties

public ArgsProperties(String[] aArgs,
                      String... aPrefixes)

Constructs the ArgsProperties from the provided command line arguments using the provided prefixes to identify the keys (and the values) from the provided arguments.

Parameters:

aArgs - The arguments from which to extract key/value-pairs.

aPrefixes - The prefixes to be used to identify the keys (and the values) from the provided arguments