Class YamlDecoder

java.lang.Object

io.micronaut.serde.LimitingStream

io.micronaut.serde.support.AbstractStreamDecoder

io.micronaut.serde.yaml.YamlDecoder

All Implemented Interfaces:

Decoder, AutoCloseable

public final class YamlDecoder
extends AbstractStreamDecoder

YAML implementation of the Decoder interface.

The decoder reads exactly one YAML document. The root node may be a mapping, a sequence or a scalar. Anchors, aliases and merge keys are resolved while reading, quoted scalars are always strings, and plain scalars are typed with the YAML 1.2 core schema. Additional documents in the input are rejected.

Since:

3.2.0

Nested Class Summary

Nested classes/interfaces inherited from class AbstractStreamDecoder

AbstractStreamDecoder.TokenType, AbstractStreamDecoder.ValueDecoder<R>

Nested classes/interfaces inherited from class LimitingStream

LimitingStream.RemainingLimits

Field Summary

Fields inherited from class LimitingStream

DEFAULT_LIMITS, DEFAULT_MAXIMUM_DEPTH

Constructor Summary

Constructors

Constructor	Description
YamlDecoder(@NonNull InputStream inputStream, @NonNull LimitingStream.RemainingLimits remainingLimits)	Creates a YAML decoder with the default read settings and every coercion allowed.

Method Summary

Modifier and Type	Method	Description
protected String	coerceScalarToString(AbstractStreamDecoder.TokenType currentToken)	Decode any non-null scalar value (number, string or boolean) to its string representation.
@NonNull IOException	createDeserializationException(@NonNull String message, @Nullable Object invalidValue)	Creates an exception for the given message.
protected @Nullable AbstractStreamDecoder.TokenType	currentToken()
void	finishStructure(boolean consumeLeftElements)
protected Number	getBestNumber()	Decode the current AbstractStreamDecoder.TokenType.NUMBER value as a Number value.
protected BigDecimal	getBigDecimal()	Decode the current AbstractStreamDecoder.TokenType.NUMBER value as a BigDecimal value.
protected BigInteger	getBigInteger()	Decode the current AbstractStreamDecoder.TokenType.NUMBER value as a BigInteger value.
protected boolean	getBoolean()	Decode the current AbstractStreamDecoder.TokenType.BOOLEAN value.
protected String	getCurrentKey()	Get the current object field name.
protected double	getDouble()	Decode the current AbstractStreamDecoder.TokenType.NUMBER value as a double value.
protected long	getLong()	Decode the current AbstractStreamDecoder.TokenType.NUMBER value as a long value.
protected String	getString()	Decode the current AbstractStreamDecoder.TokenType.STRING value.
protected boolean	isCurrentNumberFloat()	Whether the current AbstractStreamDecoder.TokenType.NUMBER token has a fractional part.
protected void	nextToken()	Move to the next token.
protected 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.

Methods inherited from class AbstractStreamDecoder

consumeLeftElements, decodeArbitrary, decodeArray, decodeArray0, decodeBigDecimal, decodeBigInteger, decodeBinary, decodeBoolean, decodeBuffer, decodeByte, decodeChar, decodeCustom, decodeCustom, decodeDouble, decodeFloat, decodeInt, decodeKey, decodeLong, decodeNode, decodeNull, decodeNumber, decodeObject, decodeObject0, decodeShort, decodeString, getBestNumberNode, getBigDecimalFromNumber, getCoercionPolicy, getInteger, hasNextArrayValue, preDecodeValue, skipValue, unexpectedToken

Methods inherited from class LimitingStream

childLimits, decreaseDepth, increaseDepth, limitsFromConfiguration, ourLimits

Methods inherited from class Object

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

Methods inherited from interface Decoder

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

Constructor Details

YamlDecoder

public YamlDecoder(@NonNull InputStream inputStream,
 @NonNull LimitingStream.RemainingLimits remainingLimits)
            throws IOException

Creates a YAML decoder with the default read settings and every coercion allowed.

Parameters:

inputStream - The YAML input stream

remainingLimits - The remaining stream limits

Throws:

IOException - if the input cannot be read or holds no YAML document

Method Details

currentToken

protected @Nullable AbstractStreamDecoder.TokenType currentToken()

Specified by:

currentToken in class AbstractStreamDecoder

Returns:

The current token.

nextToken

protected void nextToken()
                  throws IOException

Description copied from class: AbstractStreamDecoder

Move to the next token.

Specified by:

nextToken in class AbstractStreamDecoder

Throws:

IOException - if an unrecoverable error occurs

getCurrentKey

protected String getCurrentKey()
                        throws IOException

Description copied from class: AbstractStreamDecoder

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

Specified by:

getCurrentKey in class AbstractStreamDecoder

Returns:

The current field key

Throws:

IOException - if an unrecoverable error occurs

coerceScalarToString

protected String coerceScalarToString(AbstractStreamDecoder.TokenType currentToken)
                               throws IOException

Description copied from class: AbstractStreamDecoder

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

Specified by:

coerceScalarToString in class AbstractStreamDecoder

Parameters:

currentToken - The current token

Returns:

The current value, coerced to a string

Throws:

IOException - if an unrecoverable error occurs

getString

protected String getString()
                    throws IOException

Description copied from class: AbstractStreamDecoder

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

Specified by:

getString in class AbstractStreamDecoder

Returns:

The String value

Throws:

IOException - if an unrecoverable error occurs

getBoolean

protected boolean getBoolean()
                      throws IOException

Description copied from class: AbstractStreamDecoder

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

Specified by:

getBoolean in class AbstractStreamDecoder

Returns:

The boolean value

Throws:

IOException - if an unrecoverable error occurs

isCurrentNumberFloat

protected boolean isCurrentNumberFloat()

Description copied from class: AbstractStreamDecoder

Whether the current AbstractStreamDecoder.TokenType.NUMBER token has a fractional part. Only called when the configuration forbids reading a floating point number as an integer, so a decoder that never sees that configuration keeps working without implementing it.

The default implementation materialises the number with AbstractStreamDecoder.getBestNumber(). A decoder whose underlying parser consumes the value when it is read, as a forward only BSON reader does, must override this and answer from the token type instead.

Overrides:

isCurrentNumberFloat in class AbstractStreamDecoder

Returns:

true if the current number is a floating point number

getLong

protected long getLong()
                throws IOException

Description copied from class: AbstractStreamDecoder

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

Specified by:

getLong in class AbstractStreamDecoder

Returns:

The number value

Throws:

IOException - if an unrecoverable error occurs

getDouble

protected double getDouble()
                    throws IOException

Description copied from class: AbstractStreamDecoder

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

Specified by:

getDouble in class AbstractStreamDecoder

Returns:

The number value

Throws:

IOException - if an unrecoverable error occurs

getBigInteger

protected BigInteger getBigInteger()
                            throws IOException

Description copied from class: AbstractStreamDecoder

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

Specified by:

getBigInteger in class AbstractStreamDecoder

Returns:

The number value

Throws:

IOException - if an unrecoverable error occurs

getBigDecimal

protected BigDecimal getBigDecimal()
                            throws IOException

Description copied from class: AbstractStreamDecoder

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

Specified by:

getBigDecimal in class AbstractStreamDecoder

Returns:

The number value

Throws:

IOException - if an unrecoverable error occurs

getBestNumber

protected Number getBestNumber()
                        throws IOException

Description copied from class: AbstractStreamDecoder

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

Specified by:

getBestNumber in class AbstractStreamDecoder

Returns:

The number value

Throws:

IOException - if an unrecoverable error occurs

skipChildren

protected void skipChildren()
                     throws IOException

Description copied from class: AbstractStreamDecoder

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.

Specified by:

skipChildren in class AbstractStreamDecoder

Throws:

IOException - if an unrecoverable error occurs

finishStructure

public void finishStructure(boolean consumeLeftElements)
                     throws IOException

Specified by:

finishStructure in interface Decoder

Overrides:

finishStructure in class AbstractStreamDecoder

Parameters:

consumeLeftElements - True to consume left elements

Throws:

IOException - If an unrecoverable error occurs

createDeserializationException

public @NonNull IOException createDeserializationException(@NonNull String message,
 @Nullable Object invalidValue)

Description copied from interface: Decoder

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