Module org.tquadrat.foundation.config

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

Class SimplePreferenceAccessor<T>

java.lang.Object

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

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

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

Type Parameters:

T - The type of the property value.

Direct Known Subclasses:

EnumAccessor

@ClassVersion(sourceVersion="$Id: SimplePreferenceAccessor.java 1061 2023-09-25 16:32:43Z tquadrat $")
@API(status=STABLE,
     since="0.1.0")
public sealed class SimplePreferenceAccessor<T>
extends PreferenceAccessorBase<T>
permits EnumAccessor<T>

The implementations of PreferenceAccessor that uses the given instance of StringConverter to translate the values back and forth.

Author:

Thomas Thrien (thomas.thrien@tquadrat.org)

Version:

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

Since:

0.1.0

UML Diagram

⁠

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

⁠

Field Summary

Fields

Modifier and Type	Field	Description
private final StringConverter<T>	m_StringConverter	The implementation of StringConverter that is used to convert the preference values back and force.

Constructor Summary

Constructors

Constructor	Description
SimplePreferenceAccessor(String propertyName, Getter<T> getter, Setter<T> setter, StringConverter<T> stringConverter)	Creates a new SimplePreferenceAccessor instance.

Method Summary

Modifier and Type	Method	Description
protected final T	fromString(Preferences node, String s)	Converts the given String to an instance of the property type.
protected String	toString(T t)	Converts the given instance of the property type to a String.

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

readPreference, writePreference

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_StringConverter

private final StringConverter<T> m_StringConverter

The implementation of StringConverter that is used to convert the preference values back and force.

Constructor Details

SimplePreferenceAccessor

public SimplePreferenceAccessor(String propertyName,
 Getter<T> getter,
 Setter<T> setter,
 StringConverter<T> stringConverter)

Creates a new SimplePreferenceAccessor instance.

Parameters:

propertyName - The name of the property.

getter - The property getter.

setter - The property setter.

stringConverter - The implementation of StringConverter that is used to convert the preference values back and forth.

Method Details

fromString

protected final T fromString(Preferences node,
 String s)
                      throws InvalidPreferenceValueException

Converts the given String to an instance of the property type.

This implementation uses StringConverter.fromString(CharSequence) for the conversion.

Specified by:

fromString in class PreferenceAccessorBase<T>

Parameters:

node - The "preferences" node that provides the value.

s - The String value; can be null.

Returns:

The propertyType instance; will be null if the provided String is null or cannot be converted to the property type.

Throws:

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

toString

protected String toString(T t)

Converts the given instance of the property type to a String.

This implementation uses StringConverter.toString(Object) for the conversion.

Specified by:

toString in class PreferenceAccessorBase<T>

Parameters:

t - The property value; can be null.

Returns:

The String implementation; will be null if the provided value is null or cannot be converted to a String.