Package org.refcodes.structure

Interface PropertiesAccessorMixin

All Superinterfaces:

Keys<java.lang.String,java.lang.String>

All Known Subinterfaces:

CanonicalMap, CanonicalMap.CanonicalMapBuilder, CanonicalMap.MutableCanonicalMap, PropertiesAccessorMixin.PropertiesBuilderMixin<T>, PropertiesAccessorMixin.PropertiesMixin

All Known Implementing Classes:

CanonicalMapBuilderImpl, CanonicalMapImpl

public interface PropertiesAccessorMixin
extends Keys<java.lang.String,java.lang.String>

Mixin with lots of accessor default methods for String key/value Map or Dictionary implementations.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	PropertiesAccessorMixin.PropertiesBuilderMixin<T>	Mixin with lots of builder default methods for String key/value Map or Dictionary implementations.
static interface	PropertiesAccessorMixin.PropertiesMixin	Mixin with lots of accessing and mutating default methods for String key/value Map or Dictionary implementations.
static interface	PropertiesAccessorMixin.PropertiesMutatorMixin	Mixin with lots of mutating default methods for String key/value Map or Dictionary implementations.

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

Keys.MutableKeys<K,V>, Keys.MutableValues<K,V>

Method Summary

Modifier and Type	Method	Description
default boolean	containsKey(java.lang.Enum<?> aKey)	Tests whether there is an element with the given key.
default java.lang.String	get(java.lang.Enum<?> aKey)	Retrieves the element assigned to the given key.
default java.lang.Boolean	getBoolean(java.lang.Enum<?> aKey)	Returns the Boolean value of the property referred to by the key.
default java.lang.Boolean	getBoolean(java.lang.String aKey)	Returns the Boolean value of the property referred to by the key.
default java.lang.Byte	getByte(java.lang.Enum<?> aKey)	Returns the Byte value of the property referred to by the key.
default java.lang.Byte	getByte(java.lang.String aKey)	Returns the Byte value of the property referred to by the key.
default java.lang.Character	getCharacter(java.lang.Enum<?> aKey)	Retrieves the Character assigned to the given key.
default java.lang.Character	getCharacter(java.lang.String aKey)	Returns the Character value of the property referred to by the key.
default java.lang.Double	getDouble(java.lang.Enum<?> aKey)	Returns the Double value of the property referred to by the key.
default java.lang.Double	getDouble(java.lang.String aKey)	Returns the Double value of the property referred to by the key.
default java.lang.Float	getFloat(java.lang.Enum<?> aKey)	Returns the Float value of the property referred to by the key.
default java.lang.Float	getFloat(java.lang.String aKey)	Returns the Float value of the property referred to by the key.
default java.lang.Integer	getInteger(java.lang.Enum<?> aKey)	Returns the Integer value of the property referred to by the key.
default java.lang.Integer	getInteger(java.lang.String aKey)	Returns the Integer value of the property referred to by the key.
default java.lang.Long	getLong(java.lang.Enum<?> aKey)	Returns the Long value of the property referred to by the key.
default java.lang.Long	getLong(java.lang.String aKey)	Returns the Long value of the property referred to by the key.
default java.lang.Short	getShort(java.lang.Enum<?> aKey)	Returns the Short value of the property referred to by the key.
default java.lang.Short	getShort(java.lang.String aKey)	Returns the Short value of the property referred to by the key.
default java.lang.String	use(java.lang.Enum<?> aKey)	Retrieves the element assigned to the given key.
default java.lang.Boolean	useBoolean(java.lang.Enum<?> aKey)	Returns the Boolean value of the property referred to by the key.
default java.lang.Boolean	useBoolean(java.lang.String aKey)	Returns the Boolean value of the property referred to by the key.
default java.lang.Byte	useByte(java.lang.Enum<?> aKey)	Returns the Byte value of the property referred to by the key.
default java.lang.Byte	useByte(java.lang.String aKey)	Returns the Byte value of the property referred to by the key.
default java.lang.Double	useDouble(java.lang.Enum<?> aKey)	Returns the Double value of the property referred to by the key.
default java.lang.Double	useDouble(java.lang.String aKey)	Returns the Double value of the property referred to by the key.
default java.lang.Float	useFloat(java.lang.Enum<?> aKey)	Returns the Float value of the property referred to by the key.
default java.lang.Float	useFloat(java.lang.String aKey)	Returns the Float value of the property referred to by the key.
default java.lang.Integer	useInteger(java.lang.Enum<?> aKey)	Returns the Integer value of the property referred to by the key.
default java.lang.Integer	useInteger(java.lang.String aKey)	Returns the Integer value of the property referred to by the key.
default java.lang.Long	useLong(java.lang.Enum<?> aKey)	Returns the Long value of the property referred to by the key.
default java.lang.Long	useLong(java.lang.String aKey)	Returns the Long value of the property referred to by the key.
default java.lang.Short	useShort(java.lang.Enum<?> aKey)	Returns the Short value of the property referred to by the key.
default java.lang.Short	useShort(java.lang.String aKey)	Returns the Short value of the property referred to by the key.

Methods inherited from interface org.refcodes.structure.Keys

containsKey, containsValue, get, get, keySet, use, values

Method Detail

getCharacter

default java.lang.Character getCharacter(java.lang.String aKey)
                                  throws java.lang.NumberFormatException

Returns the Character value of the property referred to by the key. As property keys and values are of type String, the String value is converted accordingly.

Parameters:

aKey - The key for which to retrieve the value.

Returns:

The Integer representation of the key's String value.

Throws:

java.lang.NumberFormatException - thrown in case conversion fails.

getInteger

default java.lang.Integer getInteger(java.lang.String aKey)
                              throws java.lang.NumberFormatException

Returns the Integer value of the property referred to by the key. As property keys and values are of type String, the String value is converted accordingly.

Parameters:

aKey - The key for which to retrieve the value.

Returns:

The Integer representation of the key's String value.

Throws:

java.lang.NumberFormatException - thrown in case conversion fails.

getLong

default java.lang.Long getLong(java.lang.String aKey)
                        throws java.lang.NumberFormatException

Returns the Long value of the property referred to by the key. As property keys and values are of type String, the String value is converted accordingly.

Parameters:

aKey - The key for which to retrieve the value.

Returns:

The Long representation of the key's String value.

Throws:

java.lang.NumberFormatException - thrown in case conversion fails.

getShort

default java.lang.Short getShort(java.lang.String aKey)
                          throws java.lang.NumberFormatException

Returns the Short value of the property referred to by the key. As property keys and values are of type String, the String value is converted accordingly.

Parameters:

aKey - The key for which to retrieve the value.

Returns:

The Short representation of the key's String value.

Throws:

java.lang.NumberFormatException - thrown in case conversion fails.

getByte

default java.lang.Byte getByte(java.lang.String aKey)
                        throws java.lang.NumberFormatException

Returns the Byte value of the property referred to by the key. As property keys and values are of type String, the String value is converted accordingly.

Parameters:

aKey - The key for which to retrieve the value.

Returns:

The Byte representation of the key's String value.

Throws:

java.lang.NumberFormatException - thrown in case conversion fails.

getDouble

default java.lang.Double getDouble(java.lang.String aKey)
                            throws java.lang.NumberFormatException

Returns the Double value of the property referred to by the key. As property keys and values are of type String, the String value is converted accordingly.

Parameters:

aKey - The key for which to retrieve the value.

Returns:

The Double representation of the key's String value.

Throws:

java.lang.NumberFormatException - thrown in case conversion fails.

getFloat

default java.lang.Float getFloat(java.lang.String aKey)
                          throws java.lang.NumberFormatException

Returns the Float value of the property referred to by the key. As property keys and values are of type String, the String value is converted accordingly.

Parameters:

aKey - The key for which to retrieve the value.

Returns:

The Float representation of the key's String value.

Throws:

java.lang.NumberFormatException - thrown in case conversion fails.

getBoolean

default java.lang.Boolean getBoolean(java.lang.String aKey)
                              throws java.lang.NumberFormatException

Returns the Boolean value of the property referred to by the key. As property keys and values are of type String, the String value is converted accordingly.

Parameters:

aKey - The key for which to retrieve the value.

Returns:

The Boolean representation of the key's String value of false if there is no such key.

Throws:

java.lang.NumberFormatException - thrown in case conversion fails.

containsKey

default boolean containsKey(java.lang.Enum<?> aKey)

Tests whether there is an element with the given key. As the key passed is an enumeration, the Enum.toString() method is used on the enumeration to resolve the enumeration to a {link String} key.

Parameters:

aKey - The key for which to test whether there is an element.

Returns:

True in case there is an element for the given key.

get

default java.lang.String get(java.lang.Enum<?> aKey)

Retrieves the element assigned to the given key. As the key passed is an enumeration, the Enum.toString() method is used on the enumeration to resolve the enumeration to a {link String} key.

Parameters:

aKey - The key for which to get the element.

Returns:

The column in question or null if there is none such column.

getCharacter

default java.lang.Character getCharacter(java.lang.Enum<?> aKey)
                                  throws java.lang.NumberFormatException

Retrieves the Character assigned to the given key. As the key passed is an enumeration, the Enum.toString() method is used on the enumeration to resolve the enumeration to a {link String} key.

Parameters:

aKey - The key for which to get the element.

Returns:

The column in question or null if there is none such column.

Throws:

java.lang.NumberFormatException

getInteger

default java.lang.Integer getInteger(java.lang.Enum<?> aKey)
                              throws java.lang.NumberFormatException

Returns the Integer value of the property referred to by the key. As property keys and values are of type String, the String value is converted accordingly. As the key passed is an enumeration, the Enum.toString() method is used on the enumeration to resolve the enumeration to a {link String} key.

Parameters:

aKey - The key for which to retrieve the value.

Returns:

The Integer representation of the key's String value.

Throws:

java.lang.NumberFormatException - thrown in case conversion fails.

getShort

default java.lang.Short getShort(java.lang.Enum<?> aKey)
                          throws java.lang.NumberFormatException

Returns the Short value of the property referred to by the key. As property keys and values are of type String, the String value is converted accordingly. As the key passed is an enumeration, the Enum.toString() method is used on the enumeration to resolve the enumeration to a {link String} key.

Parameters:

aKey - The key for which to retrieve the value.

Returns:

The Short representation of the key's String value.

Throws:

java.lang.NumberFormatException - thrown in case conversion fails.

getByte

default java.lang.Byte getByte(java.lang.Enum<?> aKey)
                        throws java.lang.NumberFormatException

Returns the Byte value of the property referred to by the key. As property keys and values are of type String, the String value is converted accordingly. As the key passed is an enumeration, the Enum.toString() method is used on the enumeration to resolve the enumeration to a {link String} key.

Parameters:

aKey - The key for which to retrieve the value.

Returns:

The Byte representation of the key's String value.

Throws:

java.lang.NumberFormatException - thrown in case conversion fails.

getDouble

default java.lang.Double getDouble(java.lang.Enum<?> aKey)
                            throws java.lang.NumberFormatException

Returns the Double value of the property referred to by the key. As property keys and values are of type String, the String value is converted accordingly. As the key passed is an enumeration, the Enum.toString() method is used on the enumeration to resolve the enumeration to a {link String} key.

Parameters:

aKey - The key for which to retrieve the value.

Returns:

The Double representation of the key's String value.

Throws:

java.lang.NumberFormatException - thrown in case conversion fails.

getFloat

default java.lang.Float getFloat(java.lang.Enum<?> aKey)
                          throws java.lang.NumberFormatException

Returns the Float value of the property referred to by the key. As property keys and values are of type String, the String value is converted accordingly. As the key passed is an enumeration, the Enum.toString() method is used on the enumeration to resolve the enumeration to a {link String} key.

Parameters:

aKey - The key for which to retrieve the value.

Returns:

The Float representation of the key's String value.

Throws:

java.lang.NumberFormatException - thrown in case conversion fails.

getBoolean

default java.lang.Boolean getBoolean(java.lang.Enum<?> aKey)
                              throws java.lang.NumberFormatException

Returns the Boolean value of the property referred to by the key. As property keys and values are of type String, the String value is converted accordingly. As the key passed is an enumeration, the Enum.toString() method is used on the enumeration to resolve the enumeration to a {link String} key.

Parameters:

aKey - The key for which to retrieve the value.

Returns:

The Boolean representation of the key's String value.

Throws:

java.lang.NumberFormatException - thrown in case conversion fails.

getLong

default java.lang.Long getLong(java.lang.Enum<?> aKey)
                        throws java.lang.NumberFormatException

Returns the Long value of the property referred to by the key. As property keys and values are of type String, the String value is converted accordingly. As the key passed is an enumeration, the Enum.toString() method is used on the enumeration to resolve the enumeration to a {link String} key.

Parameters:

aKey - The key for which to retrieve the value.

Returns:

The Long representation of the key's String value.

Throws:

java.lang.NumberFormatException - thrown in case conversion fails.

useInteger

default java.lang.Integer useInteger(java.lang.String aKey)
                              throws java.lang.NumberFormatException,
                                     KeyNotFoundException

Returns the Integer value of the property referred to by the key. As property keys and values are of type String, the String value is converted accordingly. In case the given key does not exist, then an KeyNotFoundException is thrown.

Parameters:

aKey - The key for which to retrieve the value.

Returns:

The Integer representation of the key's String value.

Throws:

java.lang.NumberFormatException - thrown in case conversion fails.

KeyNotFoundException - thrown in case this instance does not contain the requested element (no such key found in the collection).

useLong

default java.lang.Long useLong(java.lang.String aKey)
                        throws java.lang.NumberFormatException,
                               KeyNotFoundException

Returns the Long value of the property referred to by the key. As property keys and values are of type String, the String value is converted accordingly. In case the given key does not exist, then an KeyNotFoundException is thrown.

Parameters:

aKey - The key for which to retrieve the value.

Returns:

The Long representation of the key's String value.

Throws:

java.lang.NumberFormatException - thrown in case conversion fails.

KeyNotFoundException - thrown in case this instance does not contain the requested element (no such key found in the collection).

useShort

default java.lang.Short useShort(java.lang.String aKey)
                          throws java.lang.NumberFormatException,
                                 KeyNotFoundException

Returns the Short value of the property referred to by the key. As property keys and values are of type String, the String value is converted accordingly. In case the given key does not exist, then an KeyNotFoundException is thrown.

Parameters:

aKey - The key for which to retrieve the value.

Returns:

The Short representation of the key's String value.

Throws:

java.lang.NumberFormatException - thrown in case conversion fails.

KeyNotFoundException - thrown in case this instance does not contain the requested element (no such key found in the collection).

useByte

default java.lang.Byte useByte(java.lang.String aKey)
                        throws java.lang.NumberFormatException,
                               KeyNotFoundException

Returns the Byte value of the property referred to by the key. As property keys and values are of type String, the String value is converted accordingly. In case the given key does not exist, then an KeyNotFoundException is thrown.

Parameters:

aKey - The key for which to retrieve the value.

Returns:

The Byte representation of the key's String value.

Throws:

java.lang.NumberFormatException - thrown in case conversion fails.

KeyNotFoundException - thrown in case this instance does not contain the requested element (no such key found in the collection).

useDouble

default java.lang.Double useDouble(java.lang.String aKey)
                            throws java.lang.NumberFormatException,
                                   KeyNotFoundException

Returns the Double value of the property referred to by the key. As property keys and values are of type String, the String value is converted accordingly. In case the given key does not exist, then an KeyNotFoundException is thrown.

Parameters:

aKey - The key for which to retrieve the value.

Returns:

The Double representation of the key's String value.

Throws:

java.lang.NumberFormatException - thrown in case conversion fails.

KeyNotFoundException - thrown in case this instance does not contain the requested element (no such key found in the collection).

useFloat

default java.lang.Float useFloat(java.lang.String aKey)
                          throws java.lang.NumberFormatException,
                                 KeyNotFoundException

Returns the Float value of the property referred to by the key. As property keys and values are of type String, the String value is converted accordingly. In case the given key does not exist, then an KeyNotFoundException is thrown.

Parameters:

aKey - The key for which to retrieve the value.

Returns:

The Float representation of the key's String value.

Throws:

java.lang.NumberFormatException - thrown in case conversion fails.

KeyNotFoundException - thrown in case this instance does not contain the requested element (no such key found in the collection).

useBoolean

default java.lang.Boolean useBoolean(java.lang.String aKey)
                              throws java.lang.NumberFormatException,
                                     KeyNotFoundException

Returns the Boolean value of the property referred to by the key. As property keys and values are of type String, the String value is converted accordingly. In case the given key does not exist, then an KeyNotFoundException is thrown.

Parameters:

aKey - The key for which to retrieve the value.

Returns:

The Boolean representation of the key's String value.

Throws:

java.lang.NumberFormatException - thrown in case conversion fails.

KeyNotFoundException - thrown in case this instance does not contain the requested element (no such key found in the collection).

use

default java.lang.String use(java.lang.Enum<?> aKey)
                      throws KeyNotFoundException

Retrieves the element assigned to the given key. In case the given key does not exist, then an KeyNotFoundException is thrown. As the key passed is an enumeration, the Enum.toString() method is used on the enumeration to resolve the enumeration to a {link String} key.

Parameters:

aKey - The key for which to use the element.

Returns:

The column in question or null if there is none such column.

Throws:

KeyNotFoundException - thrown in case this instance does not contain the requested element (no such key found in the collection).

useInteger

default java.lang.Integer useInteger(java.lang.Enum<?> aKey)
                              throws java.lang.NumberFormatException,
                                     KeyNotFoundException

Returns the Integer value of the property referred to by the key. As property keys and values are of type String, the String value is converted accordingly. In case the given key does not exist, then an KeyNotFoundException is thrown. As the key passed is an enumeration, the Enum.toString() method is used on the enumeration to resolve the enumeration to a {link String} key.

Parameters:

aKey - The key for which to retrieve the value.

Returns:

The Integer representation of the key's String value.

Throws:

java.lang.NumberFormatException - thrown in case conversion fails.

KeyNotFoundException - thrown in case this instance does not contain the requested element (no such key found in the collection).

useShort

default java.lang.Short useShort(java.lang.Enum<?> aKey)
                          throws java.lang.NumberFormatException,
                                 KeyNotFoundException

Returns the Short value of the property referred to by the key. As property keys and values are of type String, the String value is converted accordingly. In case the given key does not exist, then an KeyNotFoundException is thrown. As the key passed is an enumeration, the Enum.toString() method is used on the enumeration to resolve the enumeration to a {link String} key.

Parameters:

aKey - The key for which to retrieve the value.

Returns:

The Short representation of the key's String value.

Throws:

java.lang.NumberFormatException - thrown in case conversion fails.

KeyNotFoundException - thrown in case this instance does not contain the requested element (no such key found in the collection).

useByte

default java.lang.Byte useByte(java.lang.Enum<?> aKey)
                        throws java.lang.NumberFormatException,
                               KeyNotFoundException

Returns the Byte value of the property referred to by the key. As property keys and values are of type String, the String value is converted accordingly. In case the given key does not exist, then an KeyNotFoundException is thrown. As the key passed is an enumeration, the Enum.toString() method is used on the enumeration to resolve the enumeration to a {link String} key.

Parameters:

aKey - The key for which to retrieve the value.

Returns:

The Byte representation of the key's String value.

Throws:

java.lang.NumberFormatException - thrown in case conversion fails.

KeyNotFoundException - thrown in case this instance does not contain the requested element (no such key found in the collection).

useDouble

default java.lang.Double useDouble(java.lang.Enum<?> aKey)
                            throws java.lang.NumberFormatException,
                                   KeyNotFoundException

Returns the Double value of the property referred to by the key. As property keys and values are of type String, the String value is converted accordingly. In case the given key does not exist, then an KeyNotFoundException is thrown. As the key passed is an enumeration, the Enum.toString() method is used on the enumeration to resolve the enumeration to a {link String} key.

Parameters:

aKey - The key for which to retrieve the value.

Returns:

The Double representation of the key's String value.

Throws:

java.lang.NumberFormatException - thrown in case conversion fails.

KeyNotFoundException - thrown in case this instance does not contain the requested element (no such key found in the collection).

useFloat

default java.lang.Float useFloat(java.lang.Enum<?> aKey)
                          throws java.lang.NumberFormatException,
                                 KeyNotFoundException

Returns the Float value of the property referred to by the key. As property keys and values are of type String, the String value is converted accordingly. In case the given key does not exist, then an KeyNotFoundException is thrown. As the key passed is an enumeration, the Enum.toString() method is used on the enumeration to resolve the enumeration to a {link String} key.

Parameters:

aKey - The key for which to retrieve the value.

Returns:

The Float representation of the key's String value.

Throws:

java.lang.NumberFormatException - thrown in case conversion fails.

KeyNotFoundException - thrown in case this instance does not contain the requested element (no such key found in the collection).

useBoolean

default java.lang.Boolean useBoolean(java.lang.Enum<?> aKey)
                              throws java.lang.NumberFormatException,
                                     KeyNotFoundException

Returns the Boolean value of the property referred to by the key. As property keys and values are of type String, the String value is converted accordingly. In case the given key does not exist, then an KeyNotFoundException is thrown. As the key passed is an enumeration, the Enum.toString() method is used on the enumeration to resolve the enumeration to a {link String} key.

Parameters:

aKey - The key for which to retrieve the value.

Returns:

The Boolean representation of the key's String value.

Throws:

java.lang.NumberFormatException - thrown in case conversion fails.

KeyNotFoundException - thrown in case this instance does not contain the requested element (no such key found in the collection).

useLong

default java.lang.Long useLong(java.lang.Enum<?> aKey)
                        throws java.lang.NumberFormatException,
                               KeyNotFoundException

Returns the Long value of the property referred to by the key. As property keys and values are of type String, the String value is converted accordingly. In case the given key does not exist, then an KeyNotFoundException is thrown. As the key passed is an enumeration, the Enum.toString() method is used on the enumeration to resolve the enumeration to a {link String} key.

Parameters:

aKey - The key for which to retrieve the value.

Returns:

The Long representation of the key's String value.

Throws:

java.lang.NumberFormatException - thrown in case conversion fails.

KeyNotFoundException - thrown in case this instance does not contain the requested element (no such key found in the collection).