org.refcodes.structure

Interface PropertiesAccessorMixin.PropertiesMutatorMixin

All Superinterfaces:

Clearable, Keys<String,String>, Keys.MutableKeys<String,String>, Keys.MutableValues<String,String>

All Known Subinterfaces:

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

All Known Implementing Classes:

CanonicalMapBuilderImpl

Enclosing interface:

PropertiesAccessorMixin

public static interface PropertiesAccessorMixin.PropertiesMutatorMixin
extends Keys.MutableValues<String,String>

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

Nested Class Summary

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

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

Method Summary

Modifier and Type	Method and Description
default String	put(Enum<?> aKey, String aValue) Adds the given element related to the given key.
default String	put(Property aProperty) Puts the key/value-pair from the provided Property.
default String	putBoolean(Enum<?> aKey, Boolean aValue) Sets the Boolean value for the property referred to by the key.
default String	putBoolean(String aKey, Boolean aValue) Sets the Boolean value for the property referred to by the key.
default String	putByte(Enum<?> aKey, Byte aValue) Sets the Byte value for the property referred to by the key.
default String	putByte(String aKey, Byte aValue) Sets the Byte value for the property referred to by the key.
default String	putDouble(Enum<?> aKey, Double aValue) Sets the Double value for the property referred to by the key.
default String	putDouble(String aKey, Double aValue) Sets the Double value for the property referred to by the key.
default String	putFloat(Enum<?> aKey, Float aValue) Sets the Float value for the property referred to by the key.
default String	putFloat(String aKey, Float aValue) Sets the Float value for the property referred to by the key.
default String	putInteger(Enum<?> aKey, Integer aValue) Sets the Integer value for the property referred to by the key.
default String	putInteger(String aKey, Integer aValue) Sets the Integer value for the property referred to by the key.
default String	putLong(Enum<?> aKey, Long aValue) Sets the Long value for the property referred to by the key.
default String	putLong(String aKey, Long aValue) Sets the Long value for the property referred to by the key.
default String	putShort(Enum<?> aKey, Short aValue) Sets the Short value for the property referred to by the key.
default String	putShort(String aKey, Short aValue) Sets the Short value for the property referred to by the key.

Methods inherited from interface org.refcodes.structure.Keys.MutableValues

put

Methods inherited from interface org.refcodes.structure.Keys.MutableKeys

delete

Methods inherited from interface org.refcodes.structure.Keys

containsKey, containsValue, get, keySet, use, values

Methods inherited from interface org.refcodes.structure.Clearable

clear

Method Detail

putInteger

default String putInteger(String aKey,
                          Integer aValue)

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

Parameters:

aKey - The key for which to retrieve the value.

aValue - The Integer representation for the String value.

Returns:

the string

putShort

default String putShort(String aKey,
                        Short aValue)

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

Parameters:

aKey - The key for which to retrieve the value.

aValue - The Short representation for the String value.

Returns:

the string

putByte

default String putByte(String aKey,
                       Byte aValue)

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

Parameters:

aKey - The key for which to retrieve the value.

aValue - The Byte representation for the String value.

Returns:

the string

putDouble

default String putDouble(String aKey,
                         Double aValue)

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

Parameters:

aKey - The key for which to retrieve the value.

aValue - The Double representation for the String value.

Returns:

the string

putFloat

default String putFloat(String aKey,
                        Float aValue)

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

Parameters:

aKey - The key for which to retrieve the value.

aValue - The Float representation for the String value.

Returns:

the string

putBoolean

default String putBoolean(String aKey,
                          Boolean aValue)

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

Parameters:

aKey - The key for which to retrieve the value.

aValue - The Boolean representation for the String value.

Returns:

the string

putLong

default String putLong(String aKey,
                       Long aValue)

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

Parameters:

aKey - The key for which to retrieve the value.

aValue - The Long representation for the String value.

Returns:

the string

put

default String put(Property aProperty)

Puts the key/value-pair from the provided Property.

Parameters:

aProperty - The property's key/value to be inserted.

Returns:

The property value overwritten by the provided property.

put

default String put(Enum<?> aKey,
                   String aValue)

Adds the given element related 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 add the element.

aValue - The value to be related with the given key.

Returns:

The value being replaced by the provided value or null if none value has been replaced.

putInteger

default String putInteger(Enum<?> aKey,
                          Integer aValue)

Sets the Integer value for the property referred to by the key. As property keys and values are of type String, the Integer 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.

aValue - The Integer representation for the String value.

Returns:

the string

putShort

default String putShort(Enum<?> aKey,
                        Short aValue)

Sets the Short value for the property referred to by the key. As property keys and values are of type String, the Short 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.

aValue - The Short representation for the String value.

Returns:

the string

putByte

default String putByte(Enum<?> aKey,
                       Byte aValue)

Sets the Byte value for the property referred to by the key. As property keys and values are of type String, the Byte 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.

aValue - The Byte representation for the String value.

Returns:

the string

putDouble

default String putDouble(Enum<?> aKey,
                         Double aValue)

Sets the Double value for the property referred to by the key. As property keys and values are of type String, the Double 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.

aValue - The Double representation for the String value.

Returns:

the string

putFloat

default String putFloat(Enum<?> aKey,
                        Float aValue)

Sets the Float value for the property referred to by the key. As property keys and values are of type String, the Float 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.

aValue - The Float representation for the String value.

Returns:

the string

putBoolean

default String putBoolean(Enum<?> aKey,
                          Boolean aValue)

Sets the Boolean value for the property referred to by the key. As property keys and values are of type String, the Boolean 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.

aValue - The Boolean representation for the String value.

Returns:

the string

putLong

default String putLong(Enum<?> aKey,
                       Long aValue)

Sets the Long value for the property referred to by the key. As property keys and values are of type String, the Long 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.

aValue - The Long representation for the String value.

Returns:

the string