Module org.tquadrat.foundation.config

Package org.tquadrat.foundation.config.spi.prefs

Class MapAccessor<K,V>

java.lang.Object

org.tquadrat.foundation.config.spi.prefs.PreferenceAccessor<Map<K,V>>

org.tquadrat.foundation.config.spi.prefs.MapAccessor<K,V>

Type Parameters:

K - The key type of the Map.

V - The value type of the Map.

@ClassVersion(sourceVersion="$Id: MapAccessor.java 1061 2023-09-25 16:32:43Z tquadrat $")
@API(status=STABLE,
     since="0.0.1")
public final class MapAccessor<K,V>
extends PreferenceAccessor<Map<K,V>>

The implementation of PreferenceAccessor for instances of Map.

Note:

• This class requires that there is an implementation of StringConverter available for both the Map's key and value types.

Author:

Thomas Thrien (thomas.thrien@tquadrat.org)

Version:

$Id: MapAccessor.java 1061 2023-09-25 16:32:43Z tquadrat $

Since:

0.0.1

UML Diagram

⁠

UML Diagram for "org.tquadrat.foundation.config.spi.prefs.MapAccessor"

⁠

Field Summary

Fields

Modifier and Type	Field	Description
private final StringConverter<K>	m_KeyStringConverter	The instance of StringConverter that is used to convert the key values.
private final StringConverter<V>	m_ValueStringConverter	The instance of StringConverter that is used to convert the key values.

Constructor Summary

Constructors

Constructor	Description
MapAccessor(String propertyName, StringConverter<K> keyStringConverter, StringConverter<V> valueStringConverter, Getter<Map<K,V>> getter, Setter<Map<K,V>> setter)	Creates a new MapAccessor instance.

Method Summary

Modifier and Type	Method	Description
private final Map<K,V>	fromStringMap(Preferences node, Map<String,String> map)	Converts the given Map<String,String> to a Map<K,V>.
final void	readPreference(Preferences node)	Reads the preference value from the given node and writes it to the property.
private final Map<String,String>	toStringMap(Map<? extends K,? extends V> map)	Converts the given Map<K,V> to a Map<String,String>.
final void	writePreference(Preferences node)	Writes the preference value from the property and writes it to the given node.

Methods inherited from class org.tquadrat.foundation.config.spi.prefs.PreferenceAccessor

getPropertyName, getter, hasKey, setter

Methods inherited from class java.lang.Object

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

Field Details

m_KeyStringConverter

private final StringConverter<K> m_KeyStringConverter

The instance of StringConverter that is used to convert the key values.

m_ValueStringConverter

private final StringConverter<V> m_ValueStringConverter

The instance of StringConverter that is used to convert the key values.

Constructor Details

MapAccessor

public MapAccessor(String propertyName,
 StringConverter<K> keyStringConverter,
 StringConverter<V> valueStringConverter,
 Getter<Map<K,V>> getter,
 Setter<Map<K,V>> setter)

Creates a new MapAccessor instance.

Parameters:

propertyName - The name of the property.

keyStringConverter - The implementation of StringConverter for the key type.

valueStringConverter - The implementation of StringConverter for the value type.

getter - The property getter.

setter - The property setter.

Method Details

fromStringMap

private final Map<K,V> fromStringMap(Preferences node,
 Map<String,String> map)
                              throws InvalidPreferenceValueException

Converts the given Map<String,String> to a Map<K,V>.

Parameters:

node - The Preferences node that provides the key and value.

map - The input map; can be null.

Returns:

The converted map; will be null if the provided map was null.

Throws:

InvalidPreferenceValueException - The preferences value cannot be translated to the property type.

readPreference

public final void readPreference(Preferences node)
                          throws BackingStoreException,
InvalidPreferenceValueException

Reads the preference value from the given node and writes it to the property.

Specified by:

readPreference in class PreferenceAccessor<Map<K,V>>

Parameters:

node - The preference node.

Throws:

BackingStoreException - There are problems on reading the given node.

InvalidPreferenceValueException - The preferences value cannot be translated to the property type.

toStringMap

private final Map<String,String> toStringMap(Map<? extends K,? extends V> map)

Converts the given Map<K,V> to a Map<String,String>.

Parameters:

map - The input map.

Returns:

The converted map.

writePreference

public final void writePreference(Preferences node)
                           throws BackingStoreException

Writes the preference value from the property and writes it to the given node.

Specified by:

writePreference in class PreferenceAccessor<Map<K,V>>

Parameters:

node - The preference node.

Throws:

BackingStoreException - There are problems on writing the given node.