Package org.apache.juneau.marshall.stream

Interface TokenWritable

All Superinterfaces:

RecordWritable

All Known Implementing Classes:

CborSerializer, CborSerializer.Base64, CborSerializer.SpacedHex, CborSerializerSession, JcsSerializer, JcsSerializerSession, Json5lSerializer, Json5lSerializerSession, Json5Serializer, Json5Serializer.Readable, Json5SerializerSession, JsonlSerializer, JsonlSerializerSession, JsonSchemaSerializer, JsonSchemaSerializer.Readable, JsonSchemaSerializerSession, JsonSerializer, JsonSerializer.Readable, JsonSerializerSession, MsgPackSerializer, MsgPackSerializer.Base64, MsgPackSerializer.SpacedHex, MsgPackSerializerSession

public interface TokenWritable
extends RecordWritable

Capability role for serializers that additionally expose the structural TokenWriter cursor (FULL formats: json, json5, jsonl, cbor, msgpack, jsonschema, jcs).

Because TokenWriter IS-A RecordWriter, FULL formats get the record surface for free — the writeRecords(Object) default returns writeTokens(Object). Capability is detected via instanceof.

See Also:

• TokenReadable — the symmetric reader role.
• Serializers and Parsers

Method Summary

Modifier and Type	Method	Description
default RecordWriter	writeRecords(Object output)	FULL formats get record semantics for free — a TokenWriter IS-A RecordWriter.
TokenWriter	writeTokens(Object output)	Opens a low-level TokenWriter push generator targeting the specified output.

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

isRecordStreaming

Method Details

writeTokens

TokenWriter writeTokens(Object output)
                 throws IOException

Opens a low-level TokenWriter push generator targeting the specified output.

Parameters:

output - The output. Subtypes define the supported types: byte formats (cbor, msgpack) accept an OutputStream; char formats (json, json5, jsonl, jsonschema, jcs) accept a Writer or an OutputStream (encoded as UTF-8).

Returns:

A new TokenWriter.

Throws:

IOException - If a problem occurred opening the underlying output.

writeRecords

default RecordWriter writeRecords(Object output)
                           throws IOException

FULL formats get record semantics for free — a TokenWriter IS-A RecordWriter.

Specified by:

writeRecords in interface RecordWritable

Parameters:

output - The output.

Returns:

A new RecordWriter cursor (the same object as writeTokens(Object)).

Throws:

IOException - If a problem occurred opening the underlying output.