Package io.micronaut.serde.bson

Class BsonReaderDecoder

java.lang.Object

io.micronaut.serde.LimitingStream

io.micronaut.serde.support.AbstractStreamDecoder

io.micronaut.serde.support.AbstractDecoderPerStructureStreamDecoder

io.micronaut.serde.bson.BsonReaderDecoder

All Implemented Interfaces:

Decoder, AutoCloseable

@Internal
public final class BsonReaderDecoder
extends AbstractDecoderPerStructureStreamDecoder

Bson implementation of Decoder.

Author:

Denis Stepanov

Nested Class Summary

Nested classes/interfaces inherited from class io.micronaut.serde.support.AbstractStreamDecoder

AbstractStreamDecoder.TokenType, AbstractStreamDecoder.ValueDecoder<R>

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

LimitingStream.RemainingLimits

Field Summary

Fields inherited from class io.micronaut.serde.LimitingStream

DEFAULT_LIMITS, DEFAULT_MAXIMUM_DEPTH

Constructor Summary

Constructors

Constructor	Description
BsonReaderDecoder(org.bson.BsonReader bsonReader, @NonNull LimitingStream.RemainingLimits remainingLimits)

Method Summary

Modifier and Type	Method	Description
protected void	backFromChild(AbstractStreamDecoder child)	Called when the old child has finished processing and returns control of the stream to the parent.
protected String	coerceScalarToString(AbstractStreamDecoder.TokenType currentToken)	Decode any non-null scalar value (number, string or boolean) to its string representation.
protected AbstractStreamDecoder	createChildDecoder()	Create a new child decoder using AbstractDecoderPerStructureStreamDecoder(AbstractDecoderPerStructureStreamDecoder,io.micronaut.serde.LimitingStream.RemainingLimits).
IOException	createDeserializationException(String message, Object invalidValue)	Creates an exception for the given message.
protected AbstractStreamDecoder.TokenType	currentToken()
byte @NonNull []	decodeBinary()	Decode binary data from this stream.
Decoder	decodeBuffer()	Buffer the whole subtree of this value and return it as a new Decoder.
<T> T	decodeCustom(org.bson.codecs.Decoder<T> decoder, org.bson.codecs.DecoderContext context)
org.bson.types.Decimal128	decodeDecimal128()	Decodes Decimal128.
org.bson.types.ObjectId	decodeObjectId()	Decodes ObjectId.
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 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 io.micronaut.serde.support.AbstractDecoderPerStructureStreamDecoder

decodeArray0, decodeKey, decodeObject0, finishStructure, hasNextArrayValue, preDecodeValue

Methods inherited from class io.micronaut.serde.support.AbstractStreamDecoder

consumeLeftElements, decodeArbitrary, decodeArray, decodeBigDecimal, decodeBigInteger, decodeBoolean, decodeByte, decodeChar, decodeCustom, decodeCustom, decodeDouble, decodeFloat, decodeInt, decodeLong, decodeNode, decodeNull, decodeNumber, decodeObject, decodeShort, decodeString, getBestNumberNode, getInteger, skipValue, unexpectedToken

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, decodeArray, decodeBigDecimalNullable, decodeBigIntegerNullable, decodeBinaryNullable, decodeBooleanNullable, decodeByteNullable, decodeCharNullable, decodeDoubleNullable, decodeFloatNullable, decodeIntNullable, decodeLongNullable, decodeNumber, decodeNumberNullable, decodeObject, decodeShortNullable, decodeStringNullable, finishStructure

Constructor Details

BsonReaderDecoder

public BsonReaderDecoder(org.bson.BsonReader bsonReader,
 @NonNull
 @NonNull LimitingStream.RemainingLimits remainingLimits)

Method Details

backFromChild

protected void backFromChild(AbstractStreamDecoder child)
                      throws IOException

Description copied from class: AbstractDecoderPerStructureStreamDecoder

Called when the old child has finished processing and returns control of the stream to the parent. Current token is assumed to be AbstractStreamDecoder.TokenType.END_ARRAY or AbstractStreamDecoder.TokenType.END_OBJECT. However we AbstractStreamDecoder.currentToken() may hold an outdated value until AbstractStreamDecoder.nextToken() is called, which this method does.

Overrides:

backFromChild in class AbstractDecoderPerStructureStreamDecoder

Parameters:

child - The now-invalid child decoder.

Throws:

IOException - if an unrecoverable error occurs

nextToken

protected void nextToken()

Description copied from class: AbstractStreamDecoder

Move to the next token.

Specified by:

nextToken in class AbstractStreamDecoder

getCurrentKey

protected String getCurrentKey()

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

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

createChildDecoder

protected AbstractStreamDecoder createChildDecoder()
                                            throws SerdeException

Description copied from class: AbstractDecoderPerStructureStreamDecoder

Create a new child decoder using AbstractDecoderPerStructureStreamDecoder(AbstractDecoderPerStructureStreamDecoder,io.micronaut.serde.LimitingStream.RemainingLimits).

Specified by:

createChildDecoder in class AbstractDecoderPerStructureStreamDecoder

Returns:

The new decoder

Throws:

SerdeException

getString

protected String getString()

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

getBoolean

protected boolean getBoolean()

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

getLong

protected long getLong()

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

getDouble

protected double getDouble()

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

getBigInteger

protected BigInteger getBigInteger()

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

getBigDecimal

protected BigDecimal getBigDecimal()

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

getBestNumber

protected Number getBestNumber()

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

decodeBinary

public byte @NonNull [] decodeBinary()
                              throws IOException

Description copied from interface: Decoder

Decode binary data from this stream. Binary data can be serialized in multiple different ways that differ by format.

• An array of numbers must be supported by all implementations, for compatibility. This is also the default implementation.
• A base64 string. This is convenient for text-based formats like json, and is supported by jackson.
• A format-specific type, for binary formats such as bson.
• Other format specific behavior. Oracle JDBC Json will parse strings as hex, for example.

Implementations must support the array shape, but the other shapes are optional.

Specified by:

decodeBinary in interface Decoder

Overrides:

decodeBinary in class AbstractStreamDecoder

Returns:

The decoded byte array

Throws:

IOException

skipChildren

protected void skipChildren()

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

currentToken

protected AbstractStreamDecoder.TokenType currentToken()

Specified by:

currentToken in class AbstractStreamDecoder

Returns:

The current token.

createDeserializationException

public IOException createDeserializationException(String message,
 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

decodeDecimal128

public org.bson.types.Decimal128 decodeDecimal128()
                                           throws IOException

Decodes Decimal128.

Returns:

decoded value

Throws:

IOException

decodeObjectId

public org.bson.types.ObjectId decodeObjectId()
                                       throws IOException

Decodes ObjectId.

Returns:

decoded value

Throws:

IOException

decodeCustom

public <T> T decodeCustom(org.bson.codecs.Decoder<T> decoder,
 org.bson.codecs.DecoderContext context)
                   throws IOException

Throws:

IOException

decodeBuffer

public Decoder decodeBuffer()
                     throws IOException

Description copied from interface: Decoder

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().

Specified by:

decodeBuffer in interface Decoder

Overrides:

decodeBuffer in class AbstractStreamDecoder

Returns:

An independent decoder that visits this subtree.

Throws:

IOException - If an unrecoverable error occurs