Module com.cryptoalgo.oursql.oursql

Package com.cryptoalgo.codable.preferencesCoder

Class PreferencesDecoder<T extends Enum<T>>

java.lang.Object

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

Type Parameters:

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

All Implemented Interfaces:

Decoder<T>, KeyedDecodingContainer<T>

public final class PreferencesDecoder<T extends Enum<T>>
extends Object
implements Decoder<T>, KeyedDecodingContainer<T>

An implementation of a Decoder that decodes data stored in Java's Preferences

Note: Decoding methods returns Optional.empty() if the value in the provided key exists but cannot be cased to the requested type. This behaviour might be modified in the future to throw DecodingException instead.

See Also:

• PreferencesEncoder

Constructor Summary

Constructors

Constructor	Description
PreferencesDecoder(String node)	Creates an instance of a decoder which can be used to deserialize Decodable classes from Java's Preferences

Method Summary

Modifier and Type	Method	Description
KeyedDecodingContainer<T>	container()	Retrieve an instance of a KeyedDecodingContainer to decode keyed data
<D extends Decodable<T>> D	decode(Class<D> decoding)	Create an instance of a Decodable class by decoding values from Preferences
Boolean	decodeBoolean(T forKey)	Decodes a single Boolean at a given codingKey.
Optional<Boolean>	decodeBooleanIfPresent(T forKey)	Decodes a single Boolean at a given codingKey.
Integer	decodeInteger(T forKey)	Decodes a single Integer at a given codingKey.
Optional<Integer>	decodeIntegerIfPresent(T forKey)	Decodes a single Integer at a given codingKey.
String	decodeString(T forKey)	Decodes a single String at a given codingKey.
Optional<String>	decodeStringIfPresent(T forKey)	Decodes a single String at a given codingKey.

Methods inherited from class java.lang.Object

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

Constructor Details

PreferencesDecoder

public PreferencesDecoder(String node)

Creates an instance of a decoder which can be used to deserialize Decodable classes from Java's Preferences

Parameters:

node - Path of Preferences node to read values from

Method Details

decode

public <D extends Decodable<T>> D decode(Class<D> decoding)
                                  throws DecodingException,
InvocationTargetException

Create an instance of a Decodable class by decoding values from Preferences

Type Parameters:

D - Type of class to decode

Parameters:

decoding - .class of class to decode

Returns:

Instance of the requested class, populated with decoded data

Throws:

DecodingException - If decoding failed for whatever reason (use .printStackTrace() to find out more)

InvocationTargetException - If the decoding constructor of the class to be decoded threw an exception

decodeBooleanIfPresent

public Optional<Boolean> decodeBooleanIfPresent(T forKey)

Description copied from interface: KeyedDecodingContainer

Decodes a single Boolean at a given codingKey.

Specified by:

decodeBooleanIfPresent in interface KeyedDecodingContainer<T extends Enum<T>>

Parameters:

forKey - codingKey to attempt to decode value from

Returns:

Optional decoded Boolean

decodeBoolean

public Boolean decodeBoolean(T forKey)
                      throws DecodingException,
NoSuchElementException

Description copied from interface: KeyedDecodingContainer

Decodes a single Boolean at a given codingKey.

Specified by:

decodeBoolean in interface KeyedDecodingContainer<T extends Enum<T>>

Parameters:

forKey - codingKey to attempt to decode value from

Returns:

Decoded Boolean

Throws:

DecodingException - If decoding fails for whatever reason

NoSuchElementException - If the value at the requested key isn't present

decodeIntegerIfPresent

public Optional<Integer> decodeIntegerIfPresent(T forKey)

Description copied from interface: KeyedDecodingContainer

Decodes a single Integer at a given codingKey.

Specified by:

decodeIntegerIfPresent in interface KeyedDecodingContainer<T extends Enum<T>>

Parameters:

forKey - codingKey to attempt to decode value from

Returns:

Optional<Integer> decoded Integer

decodeInteger

public Integer decodeInteger(T forKey)
                      throws DecodingException,
NoSuchElementException

Description copied from interface: KeyedDecodingContainer

Decodes a single Integer at a given codingKey.

Specified by:

decodeInteger in interface KeyedDecodingContainer<T extends Enum<T>>

Parameters:

forKey - codingKey to attempt to decode value from

Returns:

Decoded Integer

Throws:

DecodingException - If decoding fails for whatever reason

NoSuchElementException - If the value at the requested key isn't present

decodeStringIfPresent

public Optional<String> decodeStringIfPresent(T forKey)

Description copied from interface: KeyedDecodingContainer

Decodes a single String at a given codingKey.

Specified by:

decodeStringIfPresent in interface KeyedDecodingContainer<T extends Enum<T>>

Parameters:

forKey - codingKey to attempt to decode value from

Returns:

Decoded String

decodeString

public String decodeString(T forKey)
                    throws DecodingException,
NoSuchElementException

Description copied from interface: KeyedDecodingContainer

Decodes a single String at a given codingKey.

Specified by:

decodeString in interface KeyedDecodingContainer<T extends Enum<T>>

Parameters:

forKey - codingKey to attempt to decode value from

Returns:

Optional<String> decoded String

Throws:

DecodingException - If decoding fails for whatever reason

NoSuchElementException - If the value at the requested key isn't present

container

public KeyedDecodingContainer<T> container()

Description copied from interface: Decoder

Retrieve an instance of a KeyedDecodingContainer to decode keyed data

Specified by:

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

Returns:

An instance of a KeyedDecodingContainer