Module org.tquadrat.foundation.config

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

Class ImageAccessor

java.lang.Object

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

org.tquadrat.foundation.config.spi.prefs.BulkDataAccessorBase<BufferedImage>

org.tquadrat.foundation.config.spi.prefs.ImageAccessor

@ClassVersion(sourceVersion="$Id: ImageAccessor.java 911 2021-05-06 22:07:00Z tquadrat $")
@API(status=STABLE,
     since="0.0.1")
public final class ImageAccessor
extends BulkDataAccessorBase<BufferedImage>

The implementation of PreferenceAccessor for instances of BufferedImage.

Note:

• The image will be stored to the preferences as PNG, no matter what the original image format was!

Author:

Thomas Thrien (thomas.thrien@tquadrat.org)

Version:

$Id: ImageAccessor.java 911 2021-05-06 22:07:00Z tquadrat $

Since:

0.0.1

UML Diagram

⁠

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

⁠

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
protected final BufferedImage	fromByteArray(Preferences node, byte[] source)	Converts the given byte array to an instance of the property type.
protected final byte[]	toByteArray(Preferences node, BufferedImage source)	Converts the given instance of the property type into a byte array.

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

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

Constructor Details

ImageAccessor

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

Creates a new MapAccessor instance.

Parameters:

propertyName - The name of the property.

getter - The property getter.

setter - The property setter.

Method Details

fromByteArray

protected final BufferedImage fromByteArray(Preferences node,
 byte[] source)
                                     throws InvalidPreferenceValueException

Converts the given byte array to an instance of the property type.

Specified by:

fromByteArray in class BulkDataAccessorBase<BufferedImage>

Parameters:

node - The reference to the Preferences node that provides the value.

source - The byte array; can be null.

Returns:

The instance, or null if the source was already null.

Throws:

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

toByteArray

protected final byte[] toByteArray(Preferences node,
 BufferedImage source)
                            throws InvalidPreferenceValueException

Converts the given instance of the property type into a byte array.

Specified by:

toByteArray in class BulkDataAccessorBase<BufferedImage>

Parameters:

node - The reference to the Preferences node that is used to store the preferences value.

source - The instance; can be null.

Returns:

The byte array, or null if the source was already null.

Throws:

InvalidPreferenceValueException - The conversion failed to a byte array failed.