Package ch.tocco.nice2.toolbox.api.collection

Class StringValueMap<T extends Serializable>

java.lang.Object

ch.tocco.nice2.toolbox.api.collection.StringValueMap<T>

All Implemented Interfaces:

ReadOnlyMap<T>, WriteableMap<T>, Serializable

public class StringValueMap<T extends Serializable>
extends Object
implements WriteableMap<T>, Serializable

Implementation of WriteableMap that uses strings as values. This class is not thread safe by default. You may use a synchronized map implementation as underlying map to make this thread safe.

All getters that return a number may throw NumberFormatException when parsing the string value, though this does not happen when only the interface methods are used to put values in the map.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	StringValueMap.Convert<V>

Constructor Summary

Constructors

Constructor	Description
StringValueMap()	Uses a HashMap as underlying map.
StringValueMap(Map<T,String> values)	Uses the specified map as underlying map implementation.

Method Summary

Modifier and Type	Method	Description
void	clear()
boolean	containsKey(T key)
boolean	equals(Object o)
@Nullable Boolean	getBoolean(T key)
@org.jetbrains.annotations.Nullable boolean	getBoolean(T key, boolean fallback)
StringValueMap.Convert<Boolean>	getBooleanConvert()
<V> @Nullable StringValueMap.Convert<V>	getConverter(Class<V> clazz)
@Nullable Date	getDate(T key)
@Nullable Date	getDate(T key, Date fallback)
StringValueMap.Convert<Date>	getDateConvert()
@Nullable BigDecimal	getDecimal(T key)
@Nullable BigDecimal	getDecimal(T key, BigDecimal fallback)
StringValueMap.Convert<BigDecimal>	getDecimalConvert()
@Nullable Double	getDouble(T key)
@org.jetbrains.annotations.Nullable double	getDouble(T key, double fallback)
StringValueMap.Convert<Double>	getDoubleConvert()
<S extends Enum<S>> S	getEnum(T key, Class<S> enumClass)
<S extends Enum<S>> S	getEnum(T key, Class<S> enumClass, S fallback)
<E extends Enum<E>> StringValueMap.Convert<E>	getEnumConvert(Class<E> clazz)
@Nullable Float	getFloat(T key)
@org.jetbrains.annotations.Nullable float	getFloat(T key, float fallback)
StringValueMap.Convert<Float>	getFloatConvert()
@Nullable Integer	getInt(T key)
@org.jetbrains.annotations.Nullable int	getInt(T key, int fallback)
StringValueMap.Convert<Integer>	getIntConvert()
@Nullable Long	getLong(T key)
@org.jetbrains.annotations.Nullable long	getLong(T key, long fallback)
StringValueMap.Convert<Long>	getLongConvert()
String	getString(T key)
@Nullable String	getString(T key, String fallback)
StringValueMap.Convert<String>	getStringConvert()
<V> V	getValue(T key, Class<V> clazz)
<V> V	getValue(T key, Class<V> clazz, V fallback)
<V> V	getValueOrFallback(T key, StringValueMap.Convert<V> convert, V fallback)	This is the main getter, which uses a converter to convert the string values to the requested type.
Map<T,String>	getValues()	Gives direct access to the underlying map.
int	hashCode()
protected void	initializeConverter(Class clazz)	Initializes the converter map.
Set<T>	keySet()	Returns an immutable view of all keys.
<V> void	registerConverter(Class<V> clazz, StringValueMap.Convert<V> converter)
boolean	removeValue(T key)
boolean	setBoolean(T key, boolean bool)
boolean	setDate(T key, Date value)
boolean	setDecimal(T key, BigDecimal value)
boolean	setDouble(T key, double value)
boolean	setEnum(T key, Enum value)
boolean	setFloat(T key, float value)
boolean	setInt(T key, int value)
boolean	setLong(T key, long value)
boolean	setString(T key, String value)
boolean	setValue(T key, Object value)
void	setValues(Map<T,String> values)	Sets the underlying map.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

StringValueMap

public StringValueMap(Map<T,String> values)

Uses the specified map as underlying map implementation.

StringValueMap

public StringValueMap()

Uses a HashMap as underlying map.

Method Details

getConverter

@Nullable
public <V> @Nullable StringValueMap.Convert<V> getConverter(Class<V> clazz)

registerConverter

public <V> void registerConverter(Class<V> clazz,
 StringValueMap.Convert<V> converter)

getStringConvert

public StringValueMap.Convert<String> getStringConvert()

getBooleanConvert

public StringValueMap.Convert<Boolean> getBooleanConvert()

getIntConvert

public StringValueMap.Convert<Integer> getIntConvert()

getLongConvert

public StringValueMap.Convert<Long> getLongConvert()

getDoubleConvert

public StringValueMap.Convert<Double> getDoubleConvert()

getFloatConvert

public StringValueMap.Convert<Float> getFloatConvert()

getDecimalConvert

public StringValueMap.Convert<BigDecimal> getDecimalConvert()

getEnumConvert

public <E extends Enum<E>>
StringValueMap.Convert<E> getEnumConvert(Class<E> clazz)

getDateConvert

public StringValueMap.Convert<Date> getDateConvert()

removeValue

public boolean removeValue(T key)

Specified by:

removeValue in interface WriteableMap<T extends Serializable>

setString

public boolean setString(T key,
 String value)

Specified by:

setString in interface WriteableMap<T extends Serializable>

setBoolean

public boolean setBoolean(T key,
 boolean bool)

Specified by:

setBoolean in interface WriteableMap<T extends Serializable>

setInt

public boolean setInt(T key,
 int value)

Specified by:

setInt in interface WriteableMap<T extends Serializable>

setLong

public boolean setLong(T key,
 long value)

Specified by:

setLong in interface WriteableMap<T extends Serializable>

setDouble

public boolean setDouble(T key,
 double value)

Specified by:

setDouble in interface WriteableMap<T extends Serializable>

setFloat

public boolean setFloat(T key,
 float value)

Specified by:

setFloat in interface WriteableMap<T extends Serializable>

setDecimal

public boolean setDecimal(T key,
 BigDecimal value)

Specified by:

setDecimal in interface WriteableMap<T extends Serializable>

setEnum

public boolean setEnum(T key,
 Enum value)

Specified by:

setEnum in interface WriteableMap<T extends Serializable>

setDate

public boolean setDate(T key,
 Date value)

Specified by:

setDate in interface WriteableMap<T extends Serializable>

initializeConverter

protected void initializeConverter(Class clazz)

Initializes the converter map. This is invoked if the first try to find a converter for the sepcified value class failed. Override this to add more converters.

setValue

public boolean setValue(T key,
 Object value)

Specified by:

setValue in interface WriteableMap<T extends Serializable>

getValue

public <V> V getValue(T key,
 Class<V> clazz)

Specified by:

getValue in interface ReadOnlyMap<T extends Serializable>

getValue

public <V> V getValue(T key,
 Class<V> clazz,
 V fallback)

Specified by:

getValue in interface ReadOnlyMap<T extends Serializable>

getValueOrFallback

@Nullable
public <V> V getValueOrFallback(T key,
 StringValueMap.Convert<V> convert,
 @Nullable
 V fallback)

This is the main getter, which uses a converter to convert the string values to the requested type.

It will first look up the underlying map for a value associated to the specified key. If this returns null, the specified fallback value is returned (which may also be null).

getString

public String getString(T key)

Specified by:

getString in interface ReadOnlyMap<T extends Serializable>

getString

@Nullable
public @Nullable String getString(T key,
 String fallback)

Specified by:

getString in interface ReadOnlyMap<T extends Serializable>

getBoolean

@Nullable
public @Nullable Boolean getBoolean(T key)

Specified by:

getBoolean in interface ReadOnlyMap<T extends Serializable>

getBoolean

@Nullable
public @org.jetbrains.annotations.Nullable boolean getBoolean(T key,
 boolean fallback)

Specified by:

getBoolean in interface ReadOnlyMap<T extends Serializable>

getInt

@Nullable
public @Nullable Integer getInt(T key)

Specified by:

getInt in interface ReadOnlyMap<T extends Serializable>

getInt

@Nullable
public @org.jetbrains.annotations.Nullable int getInt(T key,
 int fallback)

Specified by:

getInt in interface ReadOnlyMap<T extends Serializable>

getLong

@Nullable
public @Nullable Long getLong(T key)

Specified by:

getLong in interface ReadOnlyMap<T extends Serializable>

getLong

@Nullable
public @org.jetbrains.annotations.Nullable long getLong(T key,
 long fallback)

Specified by:

getLong in interface ReadOnlyMap<T extends Serializable>

getFloat

@Nullable
public @Nullable Float getFloat(T key)

Specified by:

getFloat in interface ReadOnlyMap<T extends Serializable>

getFloat

@Nullable
public @org.jetbrains.annotations.Nullable float getFloat(T key,
 float fallback)

Specified by:

getFloat in interface ReadOnlyMap<T extends Serializable>

getDouble

@Nullable
public @Nullable Double getDouble(T key)

Specified by:

getDouble in interface ReadOnlyMap<T extends Serializable>

getDouble

@Nullable
public @org.jetbrains.annotations.Nullable double getDouble(T key,
 double fallback)

Specified by:

getDouble in interface ReadOnlyMap<T extends Serializable>

getDecimal

@Nullable
public @Nullable BigDecimal getDecimal(T key)

Specified by:

getDecimal in interface ReadOnlyMap<T extends Serializable>

getDecimal

@Nullable
public @Nullable BigDecimal getDecimal(T key,
 BigDecimal fallback)

Specified by:

getDecimal in interface ReadOnlyMap<T extends Serializable>

getEnum

@Nullable
public <S extends Enum<S>> S getEnum(T key,
 Class<S> enumClass)

Specified by:

getEnum in interface ReadOnlyMap<T extends Serializable>

getEnum

@Nullable
public <S extends Enum<S>> S getEnum(T key,
 Class<S> enumClass,
 S fallback)

Specified by:

getEnum in interface ReadOnlyMap<T extends Serializable>

getDate

@Nullable
public @Nullable Date getDate(T key)

Specified by:

getDate in interface ReadOnlyMap<T extends Serializable>

getDate

@Nullable
public @Nullable Date getDate(T key,
 Date fallback)

Specified by:

getDate in interface ReadOnlyMap<T extends Serializable>

keySet

public Set<T> keySet()

Description copied from interface: ReadOnlyMap

Returns an immutable view of all keys.

Specified by:

keySet in interface ReadOnlyMap<T extends Serializable>

containsKey

public boolean containsKey(T key)

Specified by:

containsKey in interface ReadOnlyMap<T extends Serializable>

clear

public void clear()

Specified by:

clear in interface WriteableMap<T extends Serializable>

getValues

public Map<T,String> getValues()

Gives direct access to the underlying map.

setValues

public void setValues(Map<T,String> values)

Sets the underlying map.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object