Module io.inverno.mod.base

Package io.inverno.mod.base.converter

Class ObjectDecoder

java.lang.Object

io.inverno.mod.base.converter.ObjectDecoder

All Implemented Interfaces:

Decoder<Object,Object>, PrimitiveDecoder<Object>, SplittableDecoder<Object,Object>, SplittablePrimitiveDecoder<Object>

public class ObjectDecoder
extends Object
implements SplittablePrimitiveDecoder<Object>

Object to object Decoder implementation.

Since:

1.0

Author:

Jeremy Kuhn

See Also:

• ObjectConverter

Constructor Summary

Constructors

Constructor	Description
ObjectDecoder()	Creates a new Object decoder.

Method Summary

Modifier and Type	Method	Description
<T> T	decode(Object value, Class<T> type)	Decodes the specified value to an object whose type is represented by the specified class.
<T> T	decode(Object value, Type type)	Decodes the specified value to an object of the specified type.
BigDecimal	decodeBigDecimal(Object value)	Decodes to big decimal.
BigInteger	decodeBigInteger(Object value)	Decodes to big integer.
Boolean	decodeBoolean(Object value)	Decodes to boolean.
Byte	decodeByte(Object value)	Decodes to byte.
Character	decodeCharacter(Object value)	Decodes to character.
<T> Class<T>	decodeClass(Object value)	Decodes to class.
Currency	decodeCurrency(Object value)	Decodes to currency.
Double	decodeDouble(Object value)	Decodes to double.
File	decodeFile(Object value)	Decodes to file.
Float	decodeFloat(Object value)	Decodes to float.
InetAddress	decodeInetAddress(Object value)	Decodes to inet address.
InetSocketAddress	decodeInetSocketAddress(Object value)	Decodes to inet socket address.
Integer	decodeInteger(Object value)	Decodes to integer.
LocalDate	decodeLocalDate(Object value)	Decodes to local date.
LocalDateTime	decodeLocalDateTime(Object value)	Decodes to local datetime.
Locale	decodeLocale(Object value)	Decodes to locale.
Long	decodeLong(Object value)	Decodes to long.
Path	decodePath(Object value)	Decodes to path.
Pattern	decodePattern(Object value)	Decodes to pattern.
Short	decodeShort(Object value)	Decodes to short.
String	decodeString(Object value)	Decodes to string.
<T> T[]	decodeToArray(Object value, Class<T> type)	Decodes the specified value whose type is represented by the specified class to an array of decoded values.
<T> T[]	decodeToArray(Object value, Type type)	Decodes the specified value whose type is the specified type to an array of decoded values.
<T> List<T>	decodeToList(Object value, Class<T> type)	Decodes the specified value whose type is represented by the specified class to a list of decoded values.
<T> List<T>	decodeToList(Object value, Type type)	Decodes the specified value whose type is the specified type to a list of decoded values.
<T> Set<T>	decodeToSet(Object value, Class<T> type)	Decodes the specified value whose type is represented by the specified class to a set of decoded values.
<T> Set<T>	decodeToSet(Object value, Type type)	Decodes the specified value whose type is the specified type to a set of decoded values.
URI	decodeURI(Object value)	Decodes to URI.
URL	decodeURL(Object value)	Decodes to URL.
ZonedDateTime	decodeZonedDateTime(Object value)	Decodes to zoned datetime.

Methods inherited from class java.lang.Object

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

Constructor Details

ObjectDecoder

public ObjectDecoder()

Creates a new Object decoder.

Method Details

decode

public <T> T decode(Object value,
 Class<T> type)

Description copied from interface: Decoder

Decodes the specified value to an object whose type is represented by the specified class.

Specified by:

decode in interface Decoder<Object,Object>

Type Parameters:

T - the type of the decoded object

Parameters:

value - the object to decode

type - the class of the decoded object

Returns:

a decoded object

decode

public <T> T decode(Object value,
 Type type)
             throws ConverterException

Description copied from interface: Decoder

Decodes the specified value to an object of the specified type.

Specified by:

decode in interface Decoder<Object,Object>

Type Parameters:

T - the type of the decoded object

Parameters:

value - the object to decode

type - the type of the decoded object

Returns:

a decoded object

Throws:

ConverterException - if there was an error decoding the value

decodeToList

public <T> List<T> decodeToList(Object value,
 Class<T> type)

Description copied from interface: SplittableDecoder

Decodes the specified value whose type is represented by the specified class to a list of decoded values.

Specified by:

decodeToList in interface SplittableDecoder<Object,Object>

Type Parameters:

T - the type of the decoded object

Parameters:

value - the value to decode

type - the class of the decoded object

Returns:

a list of decoded values

decodeToList

public <T> List<T> decodeToList(Object value,
 Type type)

Description copied from interface: SplittableDecoder

Decodes the specified value whose type is the specified type to a list of decoded values.

Specified by:

decodeToList in interface SplittableDecoder<Object,Object>

Type Parameters:

T - the type of the decoded object

Parameters:

value - the value to decode

type - the type of the decoded object

Returns:

a list of decoded values

decodeToSet

public <T> Set<T> decodeToSet(Object value,
 Class<T> type)

Description copied from interface: SplittableDecoder

Decodes the specified value whose type is represented by the specified class to a set of decoded values.

Specified by:

decodeToSet in interface SplittableDecoder<Object,Object>

Type Parameters:

T - the type of the decoded object

Parameters:

value - the value to decode

type - the class of the decoded object

Returns:

a set of decoded values

decodeToSet

public <T> Set<T> decodeToSet(Object value,
 Type type)

Description copied from interface: SplittableDecoder

Decodes the specified value whose type is the specified type to a set of decoded values.

Specified by:

decodeToSet in interface SplittableDecoder<Object,Object>

Type Parameters:

T - the type of the decoded object

Parameters:

value - the value to decode

type - the type of the decoded object

Returns:

a set of decoded values

decodeToArray

public <T> T[] decodeToArray(Object value,
 Class<T> type)

Description copied from interface: SplittableDecoder

Decodes the specified value whose type is represented by the specified class to an array of decoded values.

Specified by:

decodeToArray in interface SplittableDecoder<Object,Object>

Type Parameters:

T - the type of the decoded object

Parameters:

value - the value to decode

type - the class of the decoded object

Returns:

an array of decoded values

decodeToArray

public <T> T[] decodeToArray(Object value,
 Type type)

Description copied from interface: SplittableDecoder

Decodes the specified value whose type is the specified type to an array of decoded values.

Specified by:

decodeToArray in interface SplittableDecoder<Object,Object>

Type Parameters:

T - the type of the decoded object

Parameters:

value - the value to decode

type - the type of the decoded object

Returns:

an array of decoded values

decodeByte

public Byte decodeByte(Object value)
                throws ConverterException

Description copied from interface: PrimitiveDecoder

Decodes to byte.

Specified by:

decodeByte in interface PrimitiveDecoder<Object>

Parameters:

value - the encoded value to decode

Returns:

a decoded value

Throws:

ConverterException - if there was an error decoding the value

decodeShort

public Short decodeShort(Object value)
                  throws ConverterException

Description copied from interface: PrimitiveDecoder

Decodes to short.

Specified by:

decodeShort in interface PrimitiveDecoder<Object>

Parameters:

value - the encoded value to decode

Returns:

a decoded value

Throws:

ConverterException - if there was an error decoding the value

decodeInteger

public Integer decodeInteger(Object value)
                      throws ConverterException

Description copied from interface: PrimitiveDecoder

Decodes to integer.

Specified by:

decodeInteger in interface PrimitiveDecoder<Object>

Parameters:

value - the encoded value to decode

Returns:

a decoded value

Throws:

ConverterException - if there was an error decoding the value

decodeLong

public Long decodeLong(Object value)
                throws ConverterException

Description copied from interface: PrimitiveDecoder

Decodes to long.

Specified by:

decodeLong in interface PrimitiveDecoder<Object>

Parameters:

value - the encoded value to decode

Returns:

a decoded value

Throws:

ConverterException - if there was an error decoding the value

decodeFloat

public Float decodeFloat(Object value)
                  throws ConverterException

Description copied from interface: PrimitiveDecoder

Decodes to float.

Specified by:

decodeFloat in interface PrimitiveDecoder<Object>

Parameters:

value - the encoded value to decode

Returns:

a decoded value

Throws:

ConverterException - if there was an error decoding the value

decodeDouble

public Double decodeDouble(Object value)
                    throws ConverterException

Description copied from interface: PrimitiveDecoder

Decodes to double.

Specified by:

decodeDouble in interface PrimitiveDecoder<Object>

Parameters:

value - the encoded value to decode

Returns:

a decoded value

Throws:

ConverterException - if there was an error decoding the value

decodeCharacter

public Character decodeCharacter(Object value)
                          throws ConverterException

Description copied from interface: PrimitiveDecoder

Decodes to character.

Specified by:

decodeCharacter in interface PrimitiveDecoder<Object>

Parameters:

value - the encoded value to decode

Returns:

a decoded value

Throws:

ConverterException - if there was an error decoding the value

decodeBoolean

public Boolean decodeBoolean(Object value)
                      throws ConverterException

Description copied from interface: PrimitiveDecoder

Decodes to boolean.

Specified by:

decodeBoolean in interface PrimitiveDecoder<Object>

Parameters:

value - the encoded value to decode

Returns:

a decoded value

Throws:

ConverterException - if there was an error decoding the value

decodeString

public String decodeString(Object value)
                    throws ConverterException

Description copied from interface: PrimitiveDecoder

Decodes to string.

Specified by:

decodeString in interface PrimitiveDecoder<Object>

Parameters:

value - the encoded value to decode

Returns:

a decoded value

Throws:

ConverterException - if there was an error decoding the value

decodeBigInteger

public BigInteger decodeBigInteger(Object value)
                            throws ConverterException

Description copied from interface: PrimitiveDecoder

Decodes to big integer.

Specified by:

decodeBigInteger in interface PrimitiveDecoder<Object>

Parameters:

value - the encoded value to decode

Returns:

a decoded value

Throws:

ConverterException - if there was an error decoding the value

decodeBigDecimal

public BigDecimal decodeBigDecimal(Object value)
                            throws ConverterException

Description copied from interface: PrimitiveDecoder

Decodes to big decimal.

Specified by:

decodeBigDecimal in interface PrimitiveDecoder<Object>

Parameters:

value - the encoded value to decode

Returns:

a decoded value

Throws:

ConverterException - if there was an error decoding the value

decodeLocalDate

public LocalDate decodeLocalDate(Object value)
                          throws ConverterException

Description copied from interface: PrimitiveDecoder

Decodes to local date.

Specified by:

decodeLocalDate in interface PrimitiveDecoder<Object>

Parameters:

value - the encoded value to decode

Returns:

a decoded value

Throws:

ConverterException - if there was an error decoding the value

decodeLocalDateTime

public LocalDateTime decodeLocalDateTime(Object value)
                                  throws ConverterException

Description copied from interface: PrimitiveDecoder

Decodes to local datetime.

Specified by:

decodeLocalDateTime in interface PrimitiveDecoder<Object>

Parameters:

value - the encoded value to decode

Returns:

a decoded value

Throws:

ConverterException - if there was an error decoding the value

decodeZonedDateTime

public ZonedDateTime decodeZonedDateTime(Object value)
                                  throws ConverterException

Description copied from interface: PrimitiveDecoder

Decodes to zoned datetime.

Specified by:

decodeZonedDateTime in interface PrimitiveDecoder<Object>

Parameters:

value - the encoded value to decode

Returns:

a decoded value

Throws:

ConverterException - if there was an error decoding the value

decodeCurrency

public Currency decodeCurrency(Object value)
                        throws ConverterException

Description copied from interface: PrimitiveDecoder

Decodes to currency.

Specified by:

decodeCurrency in interface PrimitiveDecoder<Object>

Parameters:

value - the encoded value to decode

Returns:

a decoded value

Throws:

ConverterException - if there was an error decoding the value

decodeLocale

public Locale decodeLocale(Object value)
                    throws ConverterException

Description copied from interface: PrimitiveDecoder

Decodes to locale.

Specified by:

decodeLocale in interface PrimitiveDecoder<Object>

Parameters:

value - the encoded value to decode

Returns:

a decoded value

Throws:

ConverterException - if there was an error decoding the value

decodeFile

public File decodeFile(Object value)
                throws ConverterException

Description copied from interface: PrimitiveDecoder

Decodes to file.

Specified by:

decodeFile in interface PrimitiveDecoder<Object>

Parameters:

value - the encoded value to decode

Returns:

a decoded value

Throws:

ConverterException - if there was an error decoding the value

decodePath

public Path decodePath(Object value)
                throws ConverterException

Description copied from interface: PrimitiveDecoder

Decodes to path.

Specified by:

decodePath in interface PrimitiveDecoder<Object>

Parameters:

value - the encoded value to decode

Returns:

a decoded value

Throws:

ConverterException - if there was an error decoding the value

decodeURI

public URI decodeURI(Object value)
              throws ConverterException

Description copied from interface: PrimitiveDecoder

Decodes to URI.

Specified by:

decodeURI in interface PrimitiveDecoder<Object>

Parameters:

value - the encoded value to decode

Returns:

a decoded value

Throws:

ConverterException - if there was an error decoding the value

decodeURL

public URL decodeURL(Object value)
              throws ConverterException

Description copied from interface: PrimitiveDecoder

Decodes to URL.

Specified by:

decodeURL in interface PrimitiveDecoder<Object>

Parameters:

value - the encoded value to decode

Returns:

a decoded value

Throws:

ConverterException - if there was an error decoding the value

decodePattern

public Pattern decodePattern(Object value)
                      throws ConverterException

Description copied from interface: PrimitiveDecoder

Decodes to pattern.

Specified by:

decodePattern in interface PrimitiveDecoder<Object>

Parameters:

value - the encoded value to decode

Returns:

a decoded value

Throws:

ConverterException - if there was an error decoding the value

decodeInetAddress

public InetAddress decodeInetAddress(Object value)
                              throws ConverterException

Description copied from interface: PrimitiveDecoder

Decodes to inet address.

Specified by:

decodeInetAddress in interface PrimitiveDecoder<Object>

Parameters:

value - the encoded value to decode

Returns:

a decoded value

Throws:

ConverterException - if there was an error decoding the value

decodeInetSocketAddress

public InetSocketAddress decodeInetSocketAddress(Object value)
                                          throws ConverterException

Description copied from interface: PrimitiveDecoder

Decodes to inet socket address.

Specified by:

decodeInetSocketAddress in interface PrimitiveDecoder<Object>

Parameters:

value - the encoded value to decode

Returns:

a decoded value

Throws:

ConverterException - if there was an error decoding the value

decodeClass

public <T> Class<T> decodeClass(Object value)
                         throws ConverterException

Description copied from interface: PrimitiveDecoder

Decodes to class.

Specified by:

decodeClass in interface PrimitiveDecoder<Object>

Type Parameters:

T - the target class type

Parameters:

value - the encoded value to decode

Returns:

a decoded value

Throws:

ConverterException - if there was an error decoding the value