Module org.tquadrat.foundation.config

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

Class StringAccessor

java.lang.Object

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

org.tquadrat.foundation.config.spi.prefs.StringAccessor

@ClassVersion(sourceVersion="$Id: StringAccessor.java 914 2021-05-07 21:22:12Z tquadrat $")
@API(status=STABLE,
     since="0.0.1")
public final class StringAccessor
extends PreferenceAccessor<String>

The implementation of PreferenceAccessor for instances of String.

Author:

Thomas Thrien (thomas.thrien@tquadrat.org)

Version:

$Id: StringAccessor.java 914 2021-05-07 21:22:12Z tquadrat $

Since:

0.0.1

UML Diagram

⁠

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

⁠

Constructor Summary

Constructors

Constructor	Description
StringAccessor(String propertyName, Getter<String> getter, Setter<String> setter)	Creates a new StringAccessor instance.

Method Summary

Modifier and Type	Method	Description
final void	readPreference(Preferences node)	Reads the preference value from the given node and writes it to the property.
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

Constructor Details

StringAccessor

public StringAccessor(String propertyName,
 Getter<String> getter,
 Setter<String> setter)

Creates a new StringAccessor instance.

Parameters:

propertyName - The name of the property.

getter - The property getter.

setter - The property setter.

Method Details

readPreference

public final void readPreference(Preferences node)
                          throws InvalidPreferenceValueException

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

Specified by:

readPreference in class PreferenceAccessor<String>

Parameters:

node - The preference node.

Throws:

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

writePreference

public final void writePreference(Preferences node)

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

Specified by:

writePreference in class PreferenceAccessor<String>

Parameters:

node - The preference node.