java.lang.Object
- io.micronaut.serde.support.AbstractStreamDecoder

All Implemented Interfaces:

io.micronaut.serde.Decoder, java.lang.AutoCloseable

Direct Known Subclasses:

AbstractChildReuseStreamDecoder
```
@Internal
public abstract class AbstractStreamDecoder
extends java.lang.Object
implements io.micronaut.serde.Decoder
```
Abstract base class for stream-based Decoders.

Nested Class Summary

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

Constructor Summary

Constructors
Modifier	Constructor	Description
`protected`	`AbstractStreamDecoder(AbstractStreamDecoder parent)`	Child constructor.
`protected`	`AbstractStreamDecoder(java.lang.Class<?> view)`	Root constructor.

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
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 abstract java.lang.String`	`coerceScalarToString()`	Decode any non-null scalar value (number, string or boolean) to its string representation.
`protected abstract AbstractStreamDecoder`	`createChildDecoder()`	Create a new child decoder using `AbstractStreamDecoder(AbstractStreamDecoder)`.
`protected abstract AbstractStreamDecoder.TokenType`	`currentToken()`
`java.lang.Object`	`decodeArbitrary()`
`io.micronaut.serde.Decoder`	`decodeArray(io.micronaut.core.type.Argument<?> type)`
`java.math.BigDecimal`	`decodeBigDecimal()`
`java.math.BigInteger`	`decodeBigInteger()`
`boolean`	`decodeBoolean()`
`io.micronaut.serde.Decoder`	`decodeBuffer()`
`byte`	`decodeByte()`
`char`	`decodeChar()`
`protected <T> T`	`decodeCustom(AbstractStreamDecoder.ValueDecoder<T> readFunction)`	Decode a custom type.
`protected <T> T`	`decodeCustom(AbstractStreamDecoder.ValueDecoder<T> readFunction, boolean callNext)`	Decode a custom type.
`double`	`decodeDouble()`
`float`	`decodeFloat()`
`int`	`decodeInt()`
`java.lang.String`	`decodeKey()`
`long`	`decodeLong()`
`boolean`	`decodeNull()`
`protected <T> T`	`decodeNumber(AbstractStreamDecoder.ValueDecoder<T> fromNumberToken, java.util.function.Function<java.lang.String,T> fromString, T zero, T one)`	Decode a number type, applying all necessary coercions.
`io.micronaut.serde.Decoder`	`decodeObject(io.micronaut.core.type.Argument<?> type)`
`short`	`decodeShort()`
`java.lang.String`	`decodeString()`
`void`	`finishStructure()`
`protected abstract java.lang.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 java.math.BigDecimal`	`getBigDecimal()`	Decode the current `AbstractStreamDecoder.TokenType.NUMBER` value as a `BigDecimal` value.
`protected abstract java.math.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 java.lang.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.
`boolean`	`hasNextArrayValue()`
`protected abstract void`	`nextToken()`	Move to the next token.
`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`.
`void`	`skipValue()`
`protected java.io.IOException`	`unexpectedToken(AbstractStreamDecoder.TokenType expected)`

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, decodeObject

- Constructor Detail
  - AbstractStreamDecoder
```
protected AbstractStreamDecoder(@NonNull
                                AbstractStreamDecoder parent)
```
    Child constructor. Should inherit the parser from the parent.
    
    Parameters:
    
    parent - The parent decoder.
  - AbstractStreamDecoder
```
protected AbstractStreamDecoder(@NonNull
                                java.lang.Class<?> view)
```
    Root constructor.
    
    Parameters:
    
    view - The selected view class.
- Method Detail
  - currentToken
```
@Nullable
protected abstract AbstractStreamDecoder.TokenType currentToken()
```
    Returns:
    
    The current token.
  - nextToken
```
protected abstract void nextToken()
                           throws java.io.IOException
```
    Move to the next token.
    
    Throws:
    
    java.io.IOException - if an unrecoverable error occurs
  - unexpectedToken
```
protected java.io.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.
  - finishStructure
```
public final void finishStructure()
                           throws java.io.IOException
```
    Specified by:
    
    finishStructure in interface io.micronaut.serde.Decoder
    
    Throws:
    
    java.io.IOException
  - backFromChild
```
protected void backFromChild(AbstractStreamDecoder child)
                      throws java.io.IOException
```
    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 currentToken() may hold an outdated value until nextToken() is called, which this method does.
    
    Parameters:
    
    child - The now-invalid child decoder.
    
    Throws:
    
    java.io.IOException - if an unrecoverable error occurs
  - hasNextArrayValue
```
public final boolean hasNextArrayValue()
```
    Specified by:
    
    hasNextArrayValue in interface io.micronaut.serde.Decoder
  - getCurrentKey
```
protected abstract java.lang.String getCurrentKey()
                                           throws java.io.IOException
```
    Get the current object field name. Only called for AbstractStreamDecoder.TokenType.KEY.
    
    Returns:
    
    The current field key
    
    Throws:
    
    java.io.IOException - if an unrecoverable error occurs
  - decodeKey
```
@Nullable
public final java.lang.String decodeKey()
                                 throws java.io.IOException
```
    Specified by:
    
    decodeKey in interface io.micronaut.serde.Decoder
    
    Throws:
    
    java.io.IOException
  - createChildDecoder
```
protected abstract AbstractStreamDecoder createChildDecoder()
```
    Create a new child decoder using AbstractStreamDecoder(AbstractStreamDecoder).
    
    Returns:
    
    The new decoder
  - decodeArray
```
@NonNull
public final io.micronaut.serde.Decoder decodeArray(io.micronaut.core.type.Argument<?> type)
                                             throws java.io.IOException
```
    Specified by:
    
    decodeArray in interface io.micronaut.serde.Decoder
    
    Throws:
    
    java.io.IOException
  - decodeObject
```
@NonNull
public final io.micronaut.serde.Decoder decodeObject(io.micronaut.core.type.Argument<?> type)
                                              throws java.io.IOException
```
    Specified by:
    
    decodeObject in interface io.micronaut.serde.Decoder
    
    Throws:
    
    java.io.IOException
  - coerceScalarToString
```
protected abstract java.lang.String coerceScalarToString()
                                                  throws java.io.IOException
```
    Decode any non-null scalar value (number, string or boolean) to its string representation.
    
    Returns:
    
    The current value, coerced to a string
    
    Throws:
    
    java.io.IOException - if an unrecoverable error occurs
  - decodeString
```
@NonNull
public final java.lang.String decodeString()
                                    throws java.io.IOException
```
    Specified by:
    
    decodeString in interface io.micronaut.serde.Decoder
    
    Throws:
    
    java.io.IOException
  - getBoolean
```
protected abstract boolean getBoolean()
                               throws java.io.IOException
```
    Decode the current AbstractStreamDecoder.TokenType.BOOLEAN value. Called for no other token type.
    
    Returns:
    
    The boolean value
    
    Throws:
    
    java.io.IOException - if an unrecoverable error occurs
  - decodeBoolean
```
public final boolean decodeBoolean()
                            throws java.io.IOException
```
    Specified by:
    
    decodeBoolean in interface io.micronaut.serde.Decoder
    
    Throws:
    
    java.io.IOException
  - decodeByte
```
public final byte decodeByte()
                      throws java.io.IOException
```
    Specified by:
    
    decodeByte in interface io.micronaut.serde.Decoder
    
    Throws:
    
    java.io.IOException
  - decodeShort
```
public final short decodeShort()
                        throws java.io.IOException
```
    Specified by:
    
    decodeShort in interface io.micronaut.serde.Decoder
    
    Throws:
    
    java.io.IOException
  - decodeChar
```
public final char decodeChar()
                      throws java.io.IOException
```
    Specified by:
    
    decodeChar in interface io.micronaut.serde.Decoder
    
    Throws:
    
    java.io.IOException
  - decodeInt
```
public final int decodeInt()
                    throws java.io.IOException
```
    Specified by:
    
    decodeInt in interface io.micronaut.serde.Decoder
    
    Throws:
    
    java.io.IOException
  - decodeLong
```
public final long decodeLong()
                      throws java.io.IOException
```
    Specified by:
    
    decodeLong in interface io.micronaut.serde.Decoder
    
    Throws:
    
    java.io.IOException
  - getLong
```
protected abstract long getLong()
                         throws java.io.IOException
```
    Decode the current AbstractStreamDecoder.TokenType.NUMBER value as a long value. Called for no other token type.
    
    Returns:
    
    The number value
    
    Throws:
    
    java.io.IOException - if an unrecoverable error occurs
  - getInteger
```
protected int getInteger()
                  throws java.io.IOException
```
    Decode the current AbstractStreamDecoder.TokenType.NUMBER value as a long value. Called for no other token type.
    
    Returns:
    
    The number value
    
    Throws:
    
    java.io.IOException - if an unrecoverable error occurs
  - getDouble
```
protected abstract double getDouble()
                             throws java.io.IOException
```
    Decode the current AbstractStreamDecoder.TokenType.NUMBER value as a double value. Called for no other token type.
    
    Returns:
    
    The number value
    
    Throws:
    
    java.io.IOException - if an unrecoverable error occurs
  - getBigInteger
```
protected abstract java.math.BigInteger getBigInteger()
                                               throws java.io.IOException
```
    Decode the current AbstractStreamDecoder.TokenType.NUMBER value as a BigInteger value. Called for no other token type.
    
    Returns:
    
    The number value
    
    Throws:
    
    java.io.IOException - if an unrecoverable error occurs
  - getBigDecimal
```
protected abstract java.math.BigDecimal getBigDecimal()
                                               throws java.io.IOException
```
    Decode the current AbstractStreamDecoder.TokenType.NUMBER value as a BigDecimal value. Called for no other token type.
    
    Returns:
    
    The number value
    
    Throws:
    
    java.io.IOException - if an unrecoverable error occurs
  - getBestNumber
```
protected abstract java.lang.Number getBestNumber()
                                           throws java.io.IOException
```
    Decode the current AbstractStreamDecoder.TokenType.NUMBER value as a Number value. Called for no other token type.
    
    Returns:
    
    The number value
    
    Throws:
    
    java.io.IOException - if an unrecoverable error occurs
  - getBestNumberNode
```
protected io.micronaut.json.tree.JsonNode getBestNumberNode()
                                                     throws java.io.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:
    
    java.io.IOException - if an unrecoverable error occurs
  - decodeFloat
```
public final float decodeFloat()
                        throws java.io.IOException
```
    Specified by:
    
    decodeFloat in interface io.micronaut.serde.Decoder
    
    Throws:
    
    java.io.IOException
  - decodeDouble
```
public final double decodeDouble()
                          throws java.io.IOException
```
    Specified by:
    
    decodeDouble in interface io.micronaut.serde.Decoder
    
    Throws:
    
    java.io.IOException
  - decodeBigInteger
```
@NonNull
public final java.math.BigInteger decodeBigInteger()
                                            throws java.io.IOException
```
    Specified by:
    
    decodeBigInteger in interface io.micronaut.serde.Decoder
    
    Throws:
    
    java.io.IOException
  - decodeBigDecimal
```
@NonNull
public final java.math.BigDecimal decodeBigDecimal()
                                            throws java.io.IOException
```
    Specified by:
    
    decodeBigDecimal in interface io.micronaut.serde.Decoder
    
    Throws:
    
    java.io.IOException
  - decodeNumber
```
protected final <T> T decodeNumber(AbstractStreamDecoder.ValueDecoder<T> fromNumberToken,
                                   java.util.function.Function<java.lang.String,T> fromString,
                                   T zero,
                                   T one)
                            throws java.io.IOException
```
    Decode a number type, applying all necessary coercions.
    
    Type Parameters:
    
    T - The number type.
    
    Parameters:
    
    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:
    
    java.io.IOException - if an unrecoverable error occurs
  - decodeCustom
```
protected final <T> T decodeCustom(AbstractStreamDecoder.ValueDecoder<T> readFunction)
                            throws java.io.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:
    
    java.io.IOException - if an unrecoverable error occurs
  - decodeCustom
```
protected final <T> T decodeCustom(AbstractStreamDecoder.ValueDecoder<T> readFunction,
                                   boolean callNext)
                            throws java.io.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:
    
    java.io.IOException - if an unrecoverable error occurs
  - decodeNull
```
public final boolean decodeNull()
                         throws java.io.IOException
```
    Specified by:
    
    decodeNull in interface io.micronaut.serde.Decoder
    
    Throws:
    
    java.io.IOException
  - decodeBuffer
```
public io.micronaut.serde.Decoder decodeBuffer()
                                        throws java.io.IOException
```
    Specified by:
    
    decodeBuffer in interface io.micronaut.serde.Decoder
    
    Throws:
    
    java.io.IOException
  - decodeArbitrary
```
@Nullable
public final java.lang.Object decodeArbitrary()
                                       throws java.io.IOException
```
    Specified by:
    
    decodeArbitrary in interface io.micronaut.serde.Decoder
    
    Throws:
    
    java.io.IOException
  - skipChildren
```
protected abstract void skipChildren()
                              throws java.io.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:
    
    java.io.IOException - if an unrecoverable error occurs
  - skipValue
```
public final void skipValue()
                     throws java.io.IOException
```
    Specified by:
    
    skipValue in interface io.micronaut.serde.Decoder
    
    Throws:
    
    java.io.IOException

Class AbstractStreamDecoder

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface io.micronaut.serde.Decoder

Constructor Detail

AbstractStreamDecoder

AbstractStreamDecoder

Method Detail

currentToken

nextToken

unexpectedToken

finishStructure

backFromChild

hasNextArrayValue

getCurrentKey

decodeKey

createChildDecoder

decodeArray

decodeObject

coerceScalarToString

decodeString

getBoolean

decodeBoolean

decodeByte

decodeShort

decodeChar

decodeInt

decodeLong

getLong

getInteger

getDouble

getBigInteger

getBigDecimal

getBestNumber

getBestNumberNode

decodeFloat

decodeDouble

decodeBigInteger

decodeBigDecimal

decodeNumber

decodeCustom

decodeCustom

decodeNull

decodeBuffer

decodeArbitrary

skipChildren

skipValue