Module com.cryptoalgo.oursql.oursql

Package com.cryptoalgo.codable.preferencesCoder

Class PreferencesEncoder<T extends Enum<T>>

java.lang.Object

com.cryptoalgo.codable.preferencesCoder.PreferencesEncoder<T>

Type Parameters:

T - Type of enum of codingKeys to be used during encoding

All Implemented Interfaces:

Encoder<T>, KeyedEncodingContainer<T>

public final class PreferencesEncoder<T extends Enum<T>>
extends Object
implements Encoder<T>, KeyedEncodingContainer<T>

Built-in encoder implementation which writes data to non-volatile storage through Java's Preferences module.

Implications: Limitations to Java's Preferences module also apply here, most notably that large amounts of data shouldn't be written to nodes. Doing so leads to significant performance penalties and might cause OOM errors when attempting to retrieve those keys.

Field Summary

Fields

Modifier and Type	Field	Description
static final Preferences	rootNode	Root preference node for use by PreferenceCoder.

Constructor Summary

Constructors

Constructor	Description
PreferencesEncoder(String node)	Creates an instance of an encoder which can be used to serialize Encodable classes to Java's Preferences

Method Summary

Modifier and Type	Method	Description
KeyedEncodingContainer<T>	container()	Retrieve an instance of a KeyedEncodingContainer to be used to encode keyed data
void	encode(@Nullable Boolean value, T forKey)	Encode a Boolean value into a specified key
void	encode(@Nullable Integer value, T forKey)	Encode an Integer value into a specified key
void	encode(@Nullable String value, T forKey)	Encode a String value into a specified key
<E extends Encodable<T>> void	encode(E encoding)	Encode the provided instance of an Encodable class.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

rootNode

public static final Preferences rootNode

Root preference node for use by PreferenceCoder.

Constructor Details

PreferencesEncoder

public PreferencesEncoder(String node)

Creates an instance of an encoder which can be used to serialize Encodable classes to Java's Preferences

Parameters:

node - Path of Preferences node to write values to

Method Details

encode

public <E extends Encodable<T>> void encode(E encoding)
                                     throws EncodingException

Encode the provided instance of an Encodable class.

Type Parameters:

E - Type of the Encodable class

Parameters:

encoding - Instance of an Encodable class

Throws:

EncodingException - If encoding failed for whatever reason

container

public KeyedEncodingContainer<T> container()

Description copied from interface: Encoder

Retrieve an instance of a KeyedEncodingContainer to be used to encode keyed data

Specified by:

container in interface Encoder<T extends Enum<T>>

Returns:

An instance of a KeyedEncodingContainer

encode

public void encode(@Nullable
 @Nullable Integer value,
 T forKey)

Description copied from interface: KeyedEncodingContainer

Encode an Integer value into a specified key

Specified by:

encode in interface KeyedEncodingContainer<T extends Enum<T>>

Parameters:

value - Value to encode

forKey - Key to encode value into

encode

public void encode(@Nullable
 @Nullable Boolean value,
 T forKey)

Description copied from interface: KeyedEncodingContainer

Encode a Boolean value into a specified key

Specified by:

encode in interface KeyedEncodingContainer<T extends Enum<T>>

Parameters:

value - Value to encode

forKey - Key to encode value into

encode

public void encode(@Nullable
 @Nullable String value,
 T forKey)

Description copied from interface: KeyedEncodingContainer

Encode a String value into a specified key

Specified by:

encode in interface KeyedEncodingContainer<T extends Enum<T>>

Parameters:

value - Value to encode

forKey - Key to encode value into