Class ToonDecoder

java.lang.Object

io.micronaut.serde.toon.util.ToonDecoder

@Internal
@Singleton
public final class ToonDecoder
extends Object

Builds a JSON tree from a TOON document.

Each call reads the stream and parses the text with a fresh ToonDocumentParser, which does the line pre-processing and recursive-descent parsing.

Since:

3.3.0

See Also:

• TOON specification

Constructor Summary

Constructors

Constructor	Description
ToonDecoder(SerdeToonConfiguration toonConfiguration)	Creates a TOON decoder.

Method Summary

Modifier and Type	Method	Description
io.micronaut.json.tree.JsonNode	parse(InputStream stream)	Parses a TOON document from the given stream into a JSON tree, using LimitingStream.DEFAULT_LIMITS as the nesting-depth budget.
io.micronaut.json.tree.JsonNode	parse(InputStream stream, LimitingStream.RemainingLimits remainingLimits)	Parses a TOON document from the given stream into a JSON tree, rejecting input nested deeper than remainingLimits allows.

Methods inherited from class Object

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

Constructor Details

ToonDecoder

public ToonDecoder(SerdeToonConfiguration toonConfiguration)

Creates a TOON decoder.

Parameters:

toonConfiguration - The TOON format configuration

Method Details

parse

public io.micronaut.json.tree.JsonNode parse(InputStream stream)
                                      throws IOException

Parses a TOON document from the given stream into a JSON tree, using LimitingStream.DEFAULT_LIMITS as the nesting-depth budget.

Parameters:

stream - The TOON input stream

Returns:

The parsed JSON tree

Throws:

IOException - If the TOON input cannot be read or is malformed

parse

public io.micronaut.json.tree.JsonNode parse(InputStream stream,
 LimitingStream.RemainingLimits remainingLimits)
                                      throws IOException

Parses a TOON document from the given stream into a JSON tree, rejecting input nested deeper than remainingLimits allows.

Parameters:

stream - The TOON input stream

remainingLimits - The nesting-depth budget, e.g. from LimitingStream.limitsFromConfiguration(SerdeConfiguration)

Returns:

The parsed JSON tree

Throws:

IOException - If the TOON input cannot be read, is malformed, or nests too deeply