Package org.apache.juneau.marshall.stream

Interface TokenReadable

All Superinterfaces:

RecordReadable

All Known Implementing Classes:

CborParser, CborParser.Base64, CborParser.SpacedHex, CborParserSession, Json5lParser, Json5lParserSession, Json5Parser, Json5ParserSession, JsonlParser, JsonlParserSession, JsonParser, JsonParserSession, MsgPackParser, MsgPackParser.Base64, MsgPackParser.SpacedHex, MsgPackParserSession

public interface TokenReadable
extends RecordReadable

Capability role for parsers that additionally expose the structural TokenReader cursor (FULL formats: json, json5, jsonl, cbor, msgpack).

Because TokenReader IS-A RecordReader, FULL formats get the record surface for free — the readRecords(Object) default returns readTokens(Object). Capability is detected via instanceof; a format that supports tokens is a TokenReadable (and transitively a RecordReadable).

See Also:

• TokenWritable — the symmetric writer role.
• Serializers and Parsers

Method Summary

Modifier and Type	Method	Description
default RecordReader	readRecords(Object input)	FULL formats get record semantics for free — a TokenReader IS-A RecordReader.
TokenReader	readTokens(Object input)	Opens a low-level TokenReader cursor over the specified input.

Methods inherited from interface org.apache.juneau.marshall.stream.RecordReadable

isRecordStreaming

Method Details

readTokens

TokenReader readTokens(Object input)
                throws IOException

Opens a low-level TokenReader cursor over the specified input.

Parameters:

input - The input. Subtypes define the supported types (typically Reader / CharSequence / InputStream / byte[]).

Returns:

A new TokenReader cursor positioned at TokenType.NOT_AVAILABLE.

Throws:

IOException - If a problem occurred reading the underlying input.

readRecords

default RecordReader readRecords(Object input)
                          throws IOException

FULL formats get record semantics for free — a TokenReader IS-A RecordReader.

Specified by:

readRecords in interface RecordReadable

Parameters:

input - The input.

Returns:

A new RecordReader cursor (the same object as readTokens(Object)).

Throws:

IOException - If a problem occurred reading the underlying input.