Module org.tquadrat.foundation.config

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

Class PreferenceAccessor<T>

java.lang.Object

org.tquadrat.foundation.config.spi.prefs.PreferenceAccessor<T>

Type Parameters:

T - The type of the property.

Direct Known Subclasses:

BooleanAccessor, BulkDataAccessorBase, ByteAccessor, CollectionAccessor, DateAccessor, DoubleAccessor, FloatAccessor, IntegerAccessor, LongAccessor, MapAccessor, PreferenceAccessorBase, PrimitiveBooleanAccessor, PrimitiveByteAccessor, PrimitiveDoubleAccessor, PrimitiveFloatAccessor, PrimitiveIntAccessor, PrimitiveLongAccessor, PrimitiveShortAccessor, ShortAccessor, StringAccessor

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

The abstract base class for the preference accessors.

Custom preference accessors can be implemented based directly on this class. If a StringConverter implementation exists for the given type, the accessor for that type should be implemented based on PreferenceAccessorBase.

Accessors for types that should be stored as byte arrays (or BLOBs) can be implemented by extending BulkDataAccessorBase.

Author:

Thomas Thrien (thomas.thrien@tquadrat.org)

Version:

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

Since:

0.0.1

See Also:

• Preferences.MAX_VALUE_LENGTH

UML Diagram

⁠

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

⁠

Field Summary

Fields

Modifier and Type	Field	Description
private final Getter<T>	m_Getter	The property getter.
private final String	m_PropertyName	The property name.
private final Setter<T>	m_Setter	The property setter.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	PreferenceAccessor(String propertyName, Getter<T> getter, Setter<T> setter)	Creates a new PreferenceAccessor instance.

Method Summary

Modifier and Type	Method	Description
final String	getPropertyName()	Returns the property name.
protected final Getter<T>	getter()	Returns the getter.
protected final boolean	hasKey(Preferences node)	Checks whether the provided preferences node has a key name like the property name.
abstract void	readPreference(Preferences node)	Reads the preference value from the given node and writes it to the property.
protected final Setter<T>	setter()	Returns the setter.
abstract void	writePreference(Preferences node)	Writes the preference value from the property and writes it to the given node.

Methods inherited from class java.lang.Object

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

Field Details

m_Getter

private final Getter<T> m_Getter

The property getter.

m_PropertyName

private final String m_PropertyName

The property name.

m_Setter

private final Setter<T> m_Setter

The property setter.

Constructor Details

PreferenceAccessor

protected PreferenceAccessor(String propertyName,
 Getter<T> getter,
 Setter<T> setter)

Creates a new PreferenceAccessor instance.

Parameters:

propertyName - The name of the property.

getter - The property getter.

setter - The property setter.

Method Details

getPropertyName

public final String getPropertyName()

Returns the property name.

Returns:

The property name.

getter

protected final Getter<T> getter()

Returns the getter.

Returns:

The getter.

hasKey

protected final boolean hasKey(Preferences node)
                        throws BackingStoreException

Checks whether the provided preferences node has a key name like the property name.

Parameters:

node - The preferences node.

Returns:

true if there is a key with that name, false otherwise.

Throws:

BackingStoreException - There are problems on reading the given node.

readPreference

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

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

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.

setter

protected final Setter<T> setter()

Returns the setter.

Returns:

The setter.

writePreference

public abstract void writePreference(Preferences node)
                              throws BackingStoreException

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

Parameters:

node - The preference node.

Throws:

BackingStoreException - There are problems on writing the given node.