Module org.tquadrat.foundation.config

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

Class CollectionAccessor<T,C extends Collection<T>>

java.lang.Object

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

org.tquadrat.foundation.config.spi.prefs.CollectionAccessor<T,C>

Type Parameters:

T - The component type of the Collection.

C - The type of the Collection.

Direct Known Subclasses:

ListAccessor, SetAccessor

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

The abstract base class for implementations of PreferenceAccessor for instances of implementations of Collection.

Note:

• This class requires that there is an implementation of StringConverter available for the collection's component type.

Author:

Thomas Thrien (thomas.thrien@tquadrat.org)

Version:

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

Since:

0.0.1

UML Diagram

⁠

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

⁠

Field Summary

Fields

Modifier and Type	Field	Description
private final StringConverter<T>	m_StringConverter	The instance of StringConverter that is used to convert the collection component values.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
protected abstract C	createCollection(int size)	Creates the collection data structure.
protected final T	fromString(Preferences node, int index, String s)	Converts the given String to an instance of the property type.
final void	readPreference(Preferences node)	Reads the preference value from the given node and writes it to the property.
protected final String	toString(T t)	Converts the given instance of the property type to a 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_StringConverter

private final StringConverter<T> m_StringConverter

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

Constructor Details

CollectionAccessor

protected CollectionAccessor(String propertyName,
 StringConverter<T> stringConverter,
 Getter<C> getter,
 Setter<C> setter)

Creates a new CollectionAccessor instance.

Parameters:

propertyName - The name of the property.

stringConverter - The implementation of StringConverter for the component type.

getter - The property getter.

setter - The property setter.

Method Details

fromString

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

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

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

Parameters:

node - The Preferences node that provides the value.

index - The value index.

s - The String value; can be null.

Returns:

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

Throws:

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

createCollection

protected abstract C createCollection(int size)

Creates the collection data structure.

Parameters:

size - The suggested size of the collection; can be ignored if not appropriate.

Returns:

The collection data structure.

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<C extends Collection<T>>

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.

toString

protected final String toString(T t)

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

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

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.

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<C extends Collection<T>>

Parameters:

node - The preference node.

Throws:

BackingStoreException - There are problems on writing the given node.