Module org.tquadrat.foundation.config

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

Class PrimitiveBooleanAccessor

java.lang.Object

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

org.tquadrat.foundation.config.spi.prefs.PrimitiveBooleanAccessor

@ClassVersion(sourceVersion="$Id: PrimitiveBooleanAccessor.java 913 2021-05-06 22:28:06Z tquadrat $")
@API(status=STABLE,
     since="0.0.1")
public final class PrimitiveBooleanAccessor
extends PreferenceAccessor<Boolean>

The implementation of PreferenceAccessor for boolean.

This differs from BooleanAccessor as it forces false as the default value, while the other implementation has null as the default value.

Author:

Thomas Thrien (thomas.thrien@tquadrat.org)

Version:

$Id: PrimitiveBooleanAccessor.java 913 2021-05-06 22:28:06Z tquadrat $

Since:

0.0.1

UML Diagram

⁠

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

⁠

Constructor Summary

Constructors

Constructor	Description
PrimitiveBooleanAccessor(String propertyName, Getter<Boolean> getter, Setter<Boolean> setter)	Creates a new PrimitiveBooleanAccessor 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

PrimitiveBooleanAccessor

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

Creates a new PrimitiveBooleanAccessor 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<Boolean>

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<Boolean>

Parameters:

node - The preference node.