io.micronaut.serde

Interface Decoder

All Superinterfaces:

java.lang.AutoCloseable

All Known Implementing Classes:

AbstractChildReuseStreamDecoder, AbstractStreamDecoder, BsonReaderDecoder, JacksonDecoder, JsonNodeDecoder, JsonParserDecoder

public interface Decoder
extends java.lang.AutoCloseable

Core interface for decoding values from a serialized format such as JSON.

Since:

1.0.0

Method Summary

Modifier and Type	Method and Description
default void	close() Finalize the current structure.
java.io.IOException	createDeserializationException(java.lang.String message, java.lang.Object invalidValue) Creates an exception for the given message.
java.lang.Object	decodeArbitrary() Decodes the current state into an arbitrary object.
default Decoder	decodeArray() Start decoding an array.
Decoder	decodeArray(io.micronaut.core.type.Argument<?> type) Start decoding an array.
java.math.BigDecimal	decodeBigDecimal() Decodes a BigDecimal.
java.math.BigInteger	decodeBigInteger() Decodes a BigInteger.
boolean	decodeBoolean() Decodes a boolean.
Decoder	decodeBuffer() Buffer the whole subtree of this value and return it as a new Decoder.
byte	decodeByte() Decodes a byte.
char	decodeChar() Decodes a char.
double	decodeDouble() Decodes a double.
float	decodeFloat() Decodes a float.
int	decodeInt() Decodes a int.
java.lang.String	decodeKey() Decodes a key, if there are no more keys to decode returns null.
long	decodeLong() Decodes a long.
boolean	decodeNull() Attempt to decode a null value.
default Decoder	decodeObject() Decodes an object.
Decoder	decodeObject(io.micronaut.core.type.Argument<?> type) Decodes an object.
short	decodeShort() Decodes a short.
java.lang.String	decodeString() Decodes a string.
void	finishStructure()
boolean	hasNextArrayValue()
void	skipValue() Skips the current value.

Method Detail

decodeArray

@NonNull
Decoder decodeArray(io.micronaut.core.type.Argument<?> type)
                      throws java.io.IOException

Start decoding an array.

Parameters:

type - The array type

Returns:

The array decoder

Throws:

java.io.IOException - If an unrecoverable error occurs

decodeArray

@NonNull
default Decoder decodeArray()
                              throws java.io.IOException

Start decoding an array.

Returns:

The array decoder

Throws:

java.io.IOException - If an unrecoverable error occurs

hasNextArrayValue

boolean hasNextArrayValue()
                   throws java.io.IOException

Returns:

Returns true if another array value is available.

Throws:

java.io.IOException - If an unrecoverable error occurs

decodeObject

@NonNull
Decoder decodeObject(@NonNull
                              io.micronaut.core.type.Argument<?> type)
                       throws java.io.IOException

Decodes an object.

Parameters:

type - The type, never null

Returns:

The object decoder

Throws:

java.io.IOException - If an unrecoverable error occurs

decodeObject

@NonNull
default Decoder decodeObject()
                               throws java.io.IOException

Decodes an object.

Returns:

The object decoder

Throws:

java.io.IOException - If an unrecoverable error occurs

decodeKey

@Nullable
java.lang.String decodeKey()
                              throws java.io.IOException

Decodes a key, if there are no more keys to decode returns null.

Returns:

The key or null if there aren't any more keys

Throws:

java.io.IOException - If an unrecoverable error occurs

decodeString

@NonNull
java.lang.String decodeString()
                                throws java.io.IOException

Decodes a string.

Returns:

The string, never null

Throws:

java.io.IOException - If an unrecoverable error occurs

decodeBoolean

boolean decodeBoolean()
               throws java.io.IOException

Decodes a boolean.

Returns:

The boolean

Throws:

java.io.IOException - If an unrecoverable error occurs

decodeByte

byte decodeByte()
         throws java.io.IOException

Decodes a byte.

Returns:

The byte

Throws:

java.io.IOException - If an unrecoverable error occurs

decodeShort

short decodeShort()
           throws java.io.IOException

Decodes a short.

Returns:

The short

Throws:

java.io.IOException - If an unrecoverable error occurs

decodeChar

char decodeChar()
         throws java.io.IOException

Decodes a char.

Returns:

The char

Throws:

java.io.IOException - If an unrecoverable error occurs

decodeInt

int decodeInt()
       throws java.io.IOException

Decodes a int.

Returns:

The int

Throws:

java.io.IOException - If an unrecoverable error occurs

decodeLong

long decodeLong()
         throws java.io.IOException

Decodes a long.

Returns:

The long

Throws:

java.io.IOException - If an unrecoverable error occurs

decodeFloat

float decodeFloat()
           throws java.io.IOException

Decodes a float.

Returns:

The float

Throws:

java.io.IOException - If an unrecoverable error occurs

decodeDouble

double decodeDouble()
             throws java.io.IOException

Decodes a double.

Returns:

The double

Throws:

java.io.IOException - If an unrecoverable error occurs

decodeBigInteger

@NonNull
java.math.BigInteger decodeBigInteger()
                                        throws java.io.IOException

Decodes a BigInteger.

Returns:

The BigInteger, never null

Throws:

java.io.IOException - If an unrecoverable error occurs

decodeBigDecimal

@NonNull
java.math.BigDecimal decodeBigDecimal()
                                        throws java.io.IOException

Decodes a BigDecimal.

Returns:

The BigDecimal, never null

Throws:

java.io.IOException - If an unrecoverable error occurs

decodeNull

boolean decodeNull()
            throws java.io.IOException

Attempt to decode a null value. Returns false if this value is not null, and another method should be used for decoding. Returns true if this value was null, and the cursor has been advanced to the next value.

Returns:

Returns true if the value was null

Throws:

java.io.IOException - If an unrecoverable error occurs

decodeArbitrary

@Nullable
java.lang.Object decodeArbitrary()
                                    throws java.io.IOException

Decodes the current state into an arbitrary object.

The following should be decoded by this method:

• Object types will be decoded into a Map
• Array types will be decoded into a List
• JSON primitive types into the equivalent Java wrapper type

Returns:

The decoded object

Throws:

java.io.IOException - If an unrecoverable error occurs

decodeBuffer

Decoder decodeBuffer()
              throws java.io.IOException

Buffer the whole subtree of this value and return it as a new Decoder. The returned Decoder can be used independently to this Decoder. This means actual parsing of the subtree can be delayed.

The returned Decoder should behave identically to this Decoder. This means that for example decoder.decodeDouble() should be equivalent to decoder.decodeBuffer().decodeDouble().

Returns:

An independent decoder that visits this subtree.

Throws:

java.io.IOException - If an unrecoverable error occurs

skipValue

void skipValue()
        throws java.io.IOException

Skips the current value.

Throws:

java.io.IOException - If an unrecoverable error occurs

finishStructure

void finishStructure()
              throws java.io.IOException

Throws:

java.lang.IllegalStateException - If there are still elements left to consume

java.io.IOException - If an unrecoverable error occurs

close

default void close()
            throws java.io.IOException

Finalize the current structure. Equivalent to calling finishStructure().

Specified by:

close in interface java.lang.AutoCloseable

Throws:

java.io.IOException - If an unrecoverable error occurs

createDeserializationException

@NonNull
java.io.IOException createDeserializationException(@NonNull
                                                            java.lang.String message,
                                                            @Nullable
                                                            java.lang.Object invalidValue)

Creates an exception for the given message.

Parameters:

message - The message, never null

invalidValue - The invalid value. Can be null.

Returns:

The exception, never null