io.micronaut.serde

Interface Encoder

All Superinterfaces:

java.lang.AutoCloseable

All Known Implementing Classes:

BsonWriterEncoder, JacksonEncoder, JsonNodeEncoder

public interface Encoder
extends java.lang.AutoCloseable

Core interface for encoding a serialization format such as JSON.

Since:

1.0.0

Method Summary

Modifier and Type	Method and Description
default void	close() Finalize the current structure.
default java.lang.String	currentPath() Return an analysis of the current path.
Encoder	encodeArray(io.micronaut.core.type.Argument<?> type) Encodes an array.
void	encodeBigDecimal(java.math.BigDecimal value) Encode a BigDecimal.
void	encodeBigInteger(java.math.BigInteger value) Encode a BigInteger.
void	encodeBoolean(boolean value) Encode a boolean.
void	encodeByte(byte value) Encode a byte.
void	encodeChar(char value) Encode a char.
void	encodeDouble(double value) Encode a double.
void	encodeFloat(float value) Encode a float.
void	encodeInt(int value) Encode an int.
void	encodeKey(java.lang.String key) Encode a key.
void	encodeLong(long value) Encode a long.
void	encodeNull() Encode null.
Encoder	encodeObject(io.micronaut.core.type.Argument<?> type) Encodes an object.
void	encodeShort(short value) Encode a short.
void	encodeString(java.lang.String value) Encode a string.
void	finishStructure() Finalize a previously created structure, like an array or object.

Method Detail

encodeArray

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

Encodes an array.

Parameters:

type - The array type, never null

Returns:

The encoder, never null

Throws:

java.io.IOException - if an error occurs

encodeObject

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

Encodes an object.

Parameters:

type - The object type, never null

Returns:

The encoder, never null

Throws:

java.io.IOException - if an error occurs

finishStructure

void finishStructure()
              throws java.io.IOException

Finalize a previously created structure, like an array or object.

Throws:

java.io.IOException - If an 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

encodeKey

void encodeKey(@NonNull
               java.lang.String key)
        throws java.io.IOException

Encode a key.

Parameters:

key - The key, never null

Throws:

java.io.IOException - If an error occurs

encodeString

void encodeString(@NonNull
                  java.lang.String value)
           throws java.io.IOException

Encode a string.

Parameters:

value - The string, never null

Throws:

java.io.IOException - If an error occurs

encodeBoolean

void encodeBoolean(boolean value)
            throws java.io.IOException

Encode a boolean.

Parameters:

value - The boolean

Throws:

java.io.IOException - If an error occurs

encodeByte

void encodeByte(byte value)
         throws java.io.IOException

Encode a byte.

Parameters:

value - The byte

Throws:

java.io.IOException - If an error occurs

encodeShort

void encodeShort(short value)
          throws java.io.IOException

Encode a short.

Parameters:

value - The short

Throws:

java.io.IOException - If an error occurs

encodeChar

void encodeChar(char value)
         throws java.io.IOException

Encode a char.

Parameters:

value - The char

Throws:

java.io.IOException - If an error occurs

encodeInt

void encodeInt(int value)
        throws java.io.IOException

Encode an int.

Parameters:

value - The int

Throws:

java.io.IOException - If an error occurs

encodeLong

void encodeLong(long value)
         throws java.io.IOException

Encode a long.

Parameters:

value - The long

Throws:

java.io.IOException - If an error occurs

encodeFloat

void encodeFloat(float value)
          throws java.io.IOException

Encode a float.

Parameters:

value - The float

Throws:

java.io.IOException - If an error occurs

encodeDouble

void encodeDouble(double value)
           throws java.io.IOException

Encode a double.

Parameters:

value - The double

Throws:

java.io.IOException - If an error occurs

encodeBigInteger

void encodeBigInteger(@NonNull
                      java.math.BigInteger value)
               throws java.io.IOException

Encode a BigInteger.

Parameters:

value - The BigInteger, never null

Throws:

java.io.IOException - If an error occurs

encodeBigDecimal

void encodeBigDecimal(@NonNull
                      java.math.BigDecimal value)
               throws java.io.IOException

Encode a BigDecimal.

Parameters:

value - The BigDecimal, never null

Throws:

java.io.IOException - If an error occurs

encodeNull

void encodeNull()
         throws java.io.IOException

Encode null.

Throws:

java.io.IOException - If an error occurs

currentPath

@NonNull
default java.lang.String currentPath()

Return an analysis of the current path.

Returns:

The current path if known