Package io.micronaut.serde.support

Class AbstractStreamDecoder

java.lang.Object

io.micronaut.serde.LimitingStream

io.micronaut.serde.support.AbstractStreamDecoder

All Implemented Interfaces:

io.micronaut.serde.Decoder, AutoCloseable

Direct Known Subclasses:

AbstractDecoderPerStructureStreamDecoder

@Internal
public abstract class AbstractStreamDecoder
extends io.micronaut.serde.LimitingStream
implements io.micronaut.serde.Decoder

Abstract base class for stream-based Decoders.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static enum	AbstractStreamDecoder.TokenType	The token type.
static interface	AbstractStreamDecoder.ValueDecoder<R>	Decoder function for a single value.

Nested classes/interfaces inherited from class io.micronaut.serde.LimitingStream

io.micronaut.serde.LimitingStream.RemainingLimits

Field Summary

Fields inherited from class io.micronaut.serde.LimitingStream

DEFAULT_LIMITS, DEFAULT_MAXIMUM_DEPTH

Constructor Summary

Constructors

Constructor	Description
AbstractStreamDecoder(@NonNull io.micronaut.serde.LimitingStream.RemainingLimits remainingLimits)

Method Summary

Modifier and Type	Method	Description
protected abstract String	coerceScalarToString(AbstractStreamDecoder.TokenType currentToken)	Decode any non-null scalar value (number, string or boolean) to its string representation.
protected void	consumeLeftElements(AbstractStreamDecoder.TokenType currentToken)	Consumes left elements.
protected abstract @Nullable AbstractStreamDecoder.TokenType	currentToken()
final @Nullable Object	decodeArbitrary()
final @NonNull io.micronaut.serde.Decoder	decodeArray(io.micronaut.core.type.Argument<?> type)
protected AbstractStreamDecoder	decodeArray0(AbstractStreamDecoder.TokenType currentToken)	Decodes the array.
final @NonNull BigDecimal	decodeBigDecimal()
final @NonNull BigInteger	decodeBigInteger()
byte @NonNull []	decodeBinary()
final boolean	decodeBoolean()
io.micronaut.serde.Decoder	decodeBuffer()
final byte	decodeByte()
final char	decodeChar()
protected final <T> T	decodeCustom(AbstractStreamDecoder.ValueDecoder<T> readFunction)	Decode a custom type.
protected final <T> T	decodeCustom(AbstractStreamDecoder.ValueDecoder<T> readFunction, boolean callNext)	Decode a custom type.
final double	decodeDouble()
final float	decodeFloat()
final int	decodeInt()
@Nullable String	decodeKey()
final long	decodeLong()
@NonNull io.micronaut.json.tree.JsonNode	decodeNode()
final boolean	decodeNull()
protected final <T> T	decodeNumber(AbstractStreamDecoder.TokenType currentToken, AbstractStreamDecoder.ValueDecoder<T> fromNumberToken, Function<String,T> fromString, T zero, T one)	Decode a number type, applying all necessary coercions.
final @NonNull io.micronaut.serde.Decoder	decodeObject(io.micronaut.core.type.Argument<?> type)
protected AbstractStreamDecoder	decodeObject0(AbstractStreamDecoder.TokenType currentToken)	Decodes the object.
final short	decodeShort()
@NonNull String	decodeString()
void	finishStructure(boolean consumeLeftElements)
protected abstract Number	getBestNumber()	Decode the current AbstractStreamDecoder.TokenType.NUMBER value as a Number value.
protected io.micronaut.json.tree.JsonNode	getBestNumberNode()	Decode the current AbstractStreamDecoder.TokenType.NUMBER value as a numeric JsonNode.
protected abstract BigDecimal	getBigDecimal()	Decode the current AbstractStreamDecoder.TokenType.NUMBER value as a BigDecimal value.
protected abstract BigInteger	getBigInteger()	Decode the current AbstractStreamDecoder.TokenType.NUMBER value as a BigInteger value.
protected abstract boolean	getBoolean()	Decode the current AbstractStreamDecoder.TokenType.BOOLEAN value.
protected abstract String	getCurrentKey()	Get the current object field name.
protected abstract double	getDouble()	Decode the current AbstractStreamDecoder.TokenType.NUMBER value as a double value.
protected int	getInteger()	Decode the current AbstractStreamDecoder.TokenType.NUMBER value as a long value.
protected abstract long	getLong()	Decode the current AbstractStreamDecoder.TokenType.NUMBER value as a long value.
protected abstract String	getString()	Decode the current AbstractStreamDecoder.TokenType.STRING value.
boolean	hasNextArrayValue()
protected abstract void	nextToken()	Move to the next token.
protected void	preDecodeValue(AbstractStreamDecoder.TokenType currentToken)	Should be called before attempting to decode a value.
protected abstract void	skipChildren()	If we are at a AbstractStreamDecoder.TokenType.START_OBJECT or AbstractStreamDecoder.TokenType.START_ARRAY, skip to the matching AbstractStreamDecoder.TokenType.END_OBJECT or AbstractStreamDecoder.TokenType.END_ARRAY.
final void	skipValue()
protected IOException	unexpectedToken(AbstractStreamDecoder.TokenType expected)

Methods inherited from class io.micronaut.serde.LimitingStream

childLimits, decreaseDepth, increaseDepth, limitsFromConfiguration, ourLimits

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.micronaut.serde.Decoder

close, createDeserializationException, decodeArray, decodeBigDecimalNullable, decodeBigIntegerNullable, decodeBinaryNullable, decodeBooleanNullable, decodeByteNullable, decodeCharNullable, decodeDoubleNullable, decodeFloatNullable, decodeIntNullable, decodeLongNullable, decodeObject, decodeShortNullable, decodeStringNullable, finishStructure

Constructor Details

AbstractStreamDecoder

public AbstractStreamDecoder(@NonNull
 @NonNull io.micronaut.serde.LimitingStream.RemainingLimits remainingLimits)

Method Details

currentToken

@Nullable
protected abstract @Nullable AbstractStreamDecoder.TokenType currentToken()

Returns:

The current token.

nextToken

protected abstract void nextToken()
                           throws IOException

Move to the next token.

Throws:

IOException - if an unrecoverable error occurs

unexpectedToken

protected IOException unexpectedToken(AbstractStreamDecoder.TokenType expected)

Parameters:

expected - The token type that was expected in place of currentToken().

Returns:

The exception that should be thrown to signify an unexpected token.

preDecodeValue

protected void preDecodeValue(AbstractStreamDecoder.TokenType currentToken)

Should be called before attempting to decode a value. Has basic sanity checks, such as confirming we're not currently in a AbstractStreamDecoder.TokenType.KEY and that there's no child decoder currently running.

Parameters:

currentToken - The current token

finishStructure

public void finishStructure(boolean consumeLeftElements)
                     throws IOException

Specified by:

finishStructure in interface io.micronaut.serde.Decoder

Throws:

IOException

consumeLeftElements

protected void consumeLeftElements(AbstractStreamDecoder.TokenType currentToken)
                            throws IOException

Consumes left elements.

Parameters:

currentToken - The current token

Throws:

IOException

hasNextArrayValue

public boolean hasNextArrayValue()

Specified by:

hasNextArrayValue in interface io.micronaut.serde.Decoder

getCurrentKey

protected abstract String getCurrentKey()
                                 throws IOException

Get the current object field name. Only called for AbstractStreamDecoder.TokenType.KEY.

Returns:

The current field key

Throws:

IOException - if an unrecoverable error occurs

decodeKey

@Nullable
public @Nullable String decodeKey()
                           throws IOException

Specified by:

decodeKey in interface io.micronaut.serde.Decoder

Throws:

IOException

decodeArray

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

Specified by:

decodeArray in interface io.micronaut.serde.Decoder

Throws:

IOException

decodeArray0

protected AbstractStreamDecoder decodeArray0(AbstractStreamDecoder.TokenType currentToken)
                                      throws IOException

Decodes the array.

Parameters:

currentToken - The current token

Returns:

The decoder

Throws:

IOException - The exception

decodeObject

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

Specified by:

decodeObject in interface io.micronaut.serde.Decoder

Throws:

IOException

decodeObject0

protected AbstractStreamDecoder decodeObject0(AbstractStreamDecoder.TokenType currentToken)
                                       throws IOException

Decodes the object.

Parameters:

currentToken - The current token

Returns:

The decoder

Throws:

IOException - The exception

coerceScalarToString

protected abstract String coerceScalarToString(AbstractStreamDecoder.TokenType currentToken)
                                        throws IOException

Decode any non-null scalar value (number, string or boolean) to its string representation.

Parameters:

currentToken - The current token

Returns:

The current value, coerced to a string

Throws:

IOException - if an unrecoverable error occurs

decodeString

@NonNull
public @NonNull String decodeString()
                             throws IOException

Specified by:

decodeString in interface io.micronaut.serde.Decoder

Throws:

IOException

getString

protected abstract String getString()
                             throws IOException

Decode the current AbstractStreamDecoder.TokenType.STRING value. Called for no other token type.

Returns:

The String value

Throws:

IOException - if an unrecoverable error occurs

getBoolean

protected abstract boolean getBoolean()
                               throws IOException

Decode the current AbstractStreamDecoder.TokenType.BOOLEAN value. Called for no other token type.

Returns:

The boolean value

Throws:

IOException - if an unrecoverable error occurs

decodeBoolean

public final boolean decodeBoolean()
                            throws IOException

Specified by:

decodeBoolean in interface io.micronaut.serde.Decoder

Throws:

IOException

decodeByte

public final byte decodeByte()
                      throws IOException

Specified by:

decodeByte in interface io.micronaut.serde.Decoder

Throws:

IOException

decodeShort

public final short decodeShort()
                        throws IOException

Specified by:

decodeShort in interface io.micronaut.serde.Decoder

Throws:

IOException

decodeChar

public final char decodeChar()
                      throws IOException

Specified by:

decodeChar in interface io.micronaut.serde.Decoder

Throws:

IOException

decodeInt

public final int decodeInt()
                    throws IOException

Specified by:

decodeInt in interface io.micronaut.serde.Decoder

Throws:

IOException

decodeLong

public final long decodeLong()
                      throws IOException

Specified by:

decodeLong in interface io.micronaut.serde.Decoder

Throws:

IOException

getLong

protected abstract long getLong()
                         throws IOException

Decode the current AbstractStreamDecoder.TokenType.NUMBER value as a long value. Called for no other token type.

Returns:

The number value

Throws:

IOException - if an unrecoverable error occurs

getInteger

protected int getInteger()
                  throws IOException

Decode the current AbstractStreamDecoder.TokenType.NUMBER value as a long value. Called for no other token type.

Returns:

The number value

Throws:

IOException - if an unrecoverable error occurs

getDouble

protected abstract double getDouble()
                             throws IOException

Decode the current AbstractStreamDecoder.TokenType.NUMBER value as a double value. Called for no other token type.

Returns:

The number value

Throws:

IOException - if an unrecoverable error occurs

getBigInteger

protected abstract BigInteger getBigInteger()
                                     throws IOException

Decode the current AbstractStreamDecoder.TokenType.NUMBER value as a BigInteger value. Called for no other token type.

Returns:

The number value

Throws:

IOException - if an unrecoverable error occurs

getBigDecimal

protected abstract BigDecimal getBigDecimal()
                                     throws IOException

Decode the current AbstractStreamDecoder.TokenType.NUMBER value as a BigDecimal value. Called for no other token type.

Returns:

The number value

Throws:

IOException - if an unrecoverable error occurs

getBestNumber

protected abstract Number getBestNumber()
                                 throws IOException

Decode the current AbstractStreamDecoder.TokenType.NUMBER value as a Number value. Called for no other token type.

Returns:

The number value

Throws:

IOException - if an unrecoverable error occurs

getBestNumberNode

protected io.micronaut.json.tree.JsonNode getBestNumberNode()
                                                     throws IOException

Decode the current AbstractStreamDecoder.TokenType.NUMBER value as a numeric JsonNode. Called for no other token type. Default implementation tries to construct a node from getBestNumber().

Returns:

The number value

Throws:

IOException - if an unrecoverable error occurs

decodeFloat

public final float decodeFloat()
                        throws IOException

Specified by:

decodeFloat in interface io.micronaut.serde.Decoder

Throws:

IOException

decodeDouble

public final double decodeDouble()
                          throws IOException

Specified by:

decodeDouble in interface io.micronaut.serde.Decoder

Throws:

IOException

decodeBigInteger

@NonNull
public final @NonNull BigInteger decodeBigInteger()
                                           throws IOException

Specified by:

decodeBigInteger in interface io.micronaut.serde.Decoder

Throws:

IOException

decodeBigDecimal

@NonNull
public final @NonNull BigDecimal decodeBigDecimal()
                                           throws IOException

Specified by:

decodeBigDecimal in interface io.micronaut.serde.Decoder

Throws:

IOException

decodeNumber

protected final <T> T decodeNumber(AbstractStreamDecoder.TokenType currentToken,
 AbstractStreamDecoder.ValueDecoder<T> fromNumberToken,
 Function<String,T> fromString,
 T zero,
 T one)
                            throws IOException

Decode a number type, applying all necessary coercions.

Type Parameters:

T - The number type.

Parameters:

currentToken - The current token

fromNumberToken - Called if currentToken() is a AbstractStreamDecoder.TokenType.NUMBER.

fromString - Called for the textual value if currentToken() is a AbstractStreamDecoder.TokenType.STRING. Should throw NumberFormatException on parse failure.

zero - The zero value.

one - The one value.

Returns:

The parsed number.

Throws:

IOException - if an unrecoverable error occurs

decodeBinary

public byte @NonNull [] decodeBinary()
                              throws IOException

Specified by:

decodeBinary in interface io.micronaut.serde.Decoder

Throws:

IOException

decodeCustom

protected final <T> T decodeCustom(AbstractStreamDecoder.ValueDecoder<T> readFunction)
                            throws IOException

Decode a custom type.

Type Parameters:

T - Value type

Parameters:

readFunction - Function to call for reading the value. The AbstractStreamDecoder parameter to the function will just be this, but this allows subclasses to avoid capturing this to avoid an allocation.

Returns:

The parsed value.

Throws:

IOException - if an unrecoverable error occurs

decodeCustom

protected final <T> T decodeCustom(AbstractStreamDecoder.ValueDecoder<T> readFunction,
 boolean callNext)
                            throws IOException

Decode a custom type.

Type Parameters:

T - Value type

Parameters:

readFunction - Function to call for reading the value. The AbstractStreamDecoder parameter to the function will just be this, but this allows subclasses to avoid capturing this to avoid an allocation.

callNext - Pass "true" if next token should be read after invocation

Returns:

The parsed value.

Throws:

IOException - if an unrecoverable error occurs

decodeNull

public final boolean decodeNull()
                         throws IOException

Specified by:

decodeNull in interface io.micronaut.serde.Decoder

Throws:

IOException

decodeBuffer

public io.micronaut.serde.Decoder decodeBuffer()
                                        throws IOException

Specified by:

decodeBuffer in interface io.micronaut.serde.Decoder

Throws:

IOException

decodeNode

@NonNull
public @NonNull io.micronaut.json.tree.JsonNode decodeNode()
                                                    throws IOException

Specified by:

decodeNode in interface io.micronaut.serde.Decoder

Throws:

IOException

decodeArbitrary

@Nullable
public final @Nullable Object decodeArbitrary()
                                       throws IOException

Specified by:

decodeArbitrary in interface io.micronaut.serde.Decoder

Throws:

IOException

skipChildren

protected abstract void skipChildren()
                              throws IOException

If we are at a AbstractStreamDecoder.TokenType.START_OBJECT or AbstractStreamDecoder.TokenType.START_ARRAY, skip to the matching AbstractStreamDecoder.TokenType.END_OBJECT or AbstractStreamDecoder.TokenType.END_ARRAY. Else, do nothing.

Throws:

IOException - if an unrecoverable error occurs

skipValue

public final void skipValue()
                     throws IOException

Specified by:

skipValue in interface io.micronaut.serde.Decoder

Throws:

IOException