Module com.cryptoalgo.oursql.oursql

Package com.cryptoalgo.codable

Interface KeyedDecodingContainer<T extends Enum<T>>

Type Parameters:

T - The type of the codingKeys enum used for decoding

All Known Implementing Classes:

PreferencesDecoder

public interface KeyedDecodingContainer<T extends Enum<T>>

A keyed decoding container for use by Decodable classes during decoding

Decodable classes can retrieve an instance of a keyed decoding container by calling Decoder.container() in their decoding constructor.

See Also:

• Decoder.container()

Method Summary

Modifier and Type	Method	Description
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.

Method Details

decodeBooleanIfPresent

Optional<Boolean> decodeBooleanIfPresent(T forKey)
                                  throws DecodingException

Decodes a single Boolean at a given codingKey.

Parameters:

forKey - codingKey to attempt to decode value from

Returns:

Optional decoded Boolean

Throws:

DecodingException - If decoding fails for whatever reason

decodeBoolean

Boolean decodeBoolean(T forKey)
               throws DecodingException,
NoSuchElementException

Decodes a single Boolean at a given codingKey.

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

Optional<Integer> decodeIntegerIfPresent(T forKey)
                                  throws DecodingException,
NoSuchElementException

Decodes a single Integer at a given codingKey.

Parameters:

forKey - codingKey to attempt to decode value from

Returns:

Optional<Integer> decoded Integer

Throws:

DecodingException - If decoding fails for whatever reason

NoSuchElementException

decodeInteger

Integer decodeInteger(T forKey)
               throws DecodingException,
NoSuchElementException

Decodes a single Integer at a given codingKey.

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

Optional<String> decodeStringIfPresent(T forKey)
                                throws DecodingException

Decodes a single String at a given codingKey.

Parameters:

forKey - codingKey to attempt to decode value from

Returns:

Decoded String

Throws:

DecodingException - If decoding fails for whatever reason

decodeString

String decodeString(T forKey)
             throws DecodingException,
NoSuchElementException

Decodes a single String at a given codingKey.

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