io.micronaut.serde.jackson

Class JacksonEncoder

java.lang.Object

io.micronaut.serde.jackson.JacksonEncoder

All Implemented Interfaces:

Encoder, java.lang.AutoCloseable

public abstract class JacksonEncoder
extends java.lang.Object
implements Encoder

Implementation of the Encoder interface for Jackson.

Field Summary

Fields

Modifier and Type	Field and Description
protected com.fasterxml.jackson.core.JsonGenerator	generator

Method Summary

Modifier and Type	Method and Description
void	close() Finalize the current structure.
static Encoder	create(com.fasterxml.jackson.core.JsonGenerator generator)
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.
protected abstract void	finishStructureToken()

Methods inherited from class java.lang.Object

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

Field Detail

generator

protected final com.fasterxml.jackson.core.JsonGenerator generator

Method Detail

create

public static Encoder create(@NonNull
                             com.fasterxml.jackson.core.JsonGenerator generator)

encodeArray

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

Description copied from interface: Encoder

Encodes an array.

Specified by:

encodeArray in interface Encoder

Parameters:

type - The array type, never null

Returns:

The encoder, never null

Throws:

java.io.IOException - if an error occurs

encodeObject

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

Description copied from interface: Encoder

Encodes an object.

Specified by:

encodeObject in interface Encoder

Parameters:

type - The object type, never null

Returns:

The encoder, never null

Throws:

java.io.IOException - if an error occurs

finishStructure

public final void finishStructure()
                           throws java.io.IOException

Description copied from interface: Encoder

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

Specified by:

finishStructure in interface Encoder

Throws:

java.io.IOException - If an error occurs

close

public final void close()
                 throws java.io.IOException

Description copied from interface: Encoder

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

Specified by:

close in interface Encoder

Specified by:

close in interface java.lang.AutoCloseable

Throws:

java.io.IOException - If an unrecoverable error occurs

finishStructureToken

protected abstract void finishStructureToken()
                                      throws java.io.IOException

Throws:

java.io.IOException

currentPath

public java.lang.String currentPath()

Description copied from interface: Encoder

Return an analysis of the current path.

Specified by:

currentPath in interface Encoder

Returns:

The current path if known

encodeKey

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

Description copied from interface: Encoder

Encode a key.

Specified by:

encodeKey in interface Encoder

Parameters:

key - The key, never null

Throws:

java.io.IOException - If an error occurs

encodeString

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

Description copied from interface: Encoder

Encode a string.

Specified by:

encodeString in interface Encoder

Parameters:

value - The string, never null

Throws:

java.io.IOException - If an error occurs

encodeBoolean

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

Description copied from interface: Encoder

Encode a boolean.

Specified by:

encodeBoolean in interface Encoder

Parameters:

value - The boolean

Throws:

java.io.IOException - If an error occurs

encodeByte

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

Description copied from interface: Encoder

Encode a byte.

Specified by:

encodeByte in interface Encoder

Parameters:

value - The byte

Throws:

java.io.IOException - If an error occurs

encodeShort

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

Description copied from interface: Encoder

Encode a short.

Specified by:

encodeShort in interface Encoder

Parameters:

value - The short

Throws:

java.io.IOException - If an error occurs

encodeChar

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

Description copied from interface: Encoder

Encode a char.

Specified by:

encodeChar in interface Encoder

Parameters:

value - The char

Throws:

java.io.IOException - If an error occurs

encodeInt

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

Description copied from interface: Encoder

Encode an int.

Specified by:

encodeInt in interface Encoder

Parameters:

value - The int

Throws:

java.io.IOException - If an error occurs

encodeLong

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

Description copied from interface: Encoder

Encode a long.

Specified by:

encodeLong in interface Encoder

Parameters:

value - The long

Throws:

java.io.IOException - If an error occurs

encodeFloat

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

Description copied from interface: Encoder

Encode a float.

Specified by:

encodeFloat in interface Encoder

Parameters:

value - The float

Throws:

java.io.IOException - If an error occurs

encodeDouble

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

Description copied from interface: Encoder

Encode a double.

Specified by:

encodeDouble in interface Encoder

Parameters:

value - The double

Throws:

java.io.IOException - If an error occurs

encodeBigInteger

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

Description copied from interface: Encoder

Encode a BigInteger.

Specified by:

encodeBigInteger in interface Encoder

Parameters:

value - The BigInteger, never null

Throws:

java.io.IOException - If an error occurs

encodeBigDecimal

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

Description copied from interface: Encoder

Encode a BigDecimal.

Specified by:

encodeBigDecimal in interface Encoder

Parameters:

value - The BigDecimal, never null

Throws:

java.io.IOException - If an error occurs

encodeNull

public final void encodeNull()
                      throws java.io.IOException

Description copied from interface: Encoder

Encode null.

Specified by:

encodeNull in interface Encoder

Throws:

java.io.IOException - If an error occurs