Package org.apache.juneau.marshall.stream

Interface RecordWritable

All Known Subinterfaces:

TokenWritable

All Known Implementing Classes:

BsonSerializer, BsonSerializer.Base64, BsonSerializer.SpacedHex, BsonSerializerSession, CborSerializer, CborSerializer.Base64, CborSerializer.SpacedHex, CborSerializerSession, CsvSerializer, CsvSerializerSession, HjsonSerializer, HjsonSerializerSession, HoconSerializer, HoconSerializerSession, HtmlDocSerializer, HtmlDocSerializerSession, HtmlSchemaDocSerializer, HtmlSchemaDocSerializerSession, HtmlSchemaSerializer, HtmlSchemaSerializer.Readable, HtmlSchemaSerializer.Simple, HtmlSchemaSerializer.SimpleReadable, HtmlSchemaSerializerSession, HtmlSerializer, HtmlSerializer.Sq, HtmlSerializer.SqReadable, HtmlSerializerSession, HtmlStrippedDocSerializer, HtmlStrippedDocSerializerSession, IniSerializer, IniSerializerSession, JcsSerializer, JcsSerializerSession, Json5lSerializer, Json5lSerializerSession, Json5Serializer, Json5Serializer.Readable, Json5SerializerSession, JsonlSerializer, JsonlSerializerSession, JsonSchemaSerializer, JsonSchemaSerializer.Readable, JsonSchemaSerializerSession, JsonSerializer, JsonSerializer.Readable, JsonSerializerSession, MarkdownDocSerializer, MarkdownDocSerializerSession, MarkdownSerializer, MarkdownSerializerSession, MsgPackSerializer, MsgPackSerializer.Base64, MsgPackSerializer.SpacedHex, MsgPackSerializerSession, OpenApiSerializer, OpenApiSerializerSession, ParquetSerializer, ParquetSerializerSession, PlainTextSerializer, PlainTextSerializerSession, SoapXmlSerializer, SoapXmlSerializerSession, SseSerializer, SseSerializerSession, TomlSerializer, TomlSerializerSession, UonSerializer, UonSerializer.Encoding, UonSerializer.Readable, UonSerializerSession, UrlEncodingSerializer, UrlEncodingSerializer.Expanded, UrlEncodingSerializer.PlainText, UrlEncodingSerializer.Readable, UrlEncodingSerializerSession, XmlDocSerializer, XmlDocSerializer.Ns, XmlDocSerializerSession, XmlSerializer, XmlSerializer.Ns, XmlSerializer.NsSq, XmlSerializer.NsSqReadable, XmlSerializer.Sq, XmlSerializer.SqReadable, XmlSerializerSession, YamlSerializer, YamlSerializer.Readable, YamlSerializerSession

public interface RecordWritable

Capability role for objects that can open a whole-value RecordWriter cursor.

The symmetric writer-side counterpart of RecordReadable. Implemented at both levels of the serializer surface:

• the convenience Serializer subclass — a thin delegator that mirrors write(...) by forwarding to getSession().writeRecords(output);
• the SerializerSession subclass (where the live BeanSession/MarshallingContext is) — the real cursor creation.

Capability is detected via instanceof.

See Also:

• TokenWritable — the structural-token extension (FULL formats).
• RecordReadable — the symmetric reader role.
• Serializers and Parsers

Method Summary

Modifier and Type	Method	Description
default boolean	isRecordStreaming()	Streaming-quality signal queryable before opening a cursor.
RecordWriter	writeRecords(Object output)	Opens a low-level RecordWriter cursor over the specified output.

Method Details

writeRecords

RecordWriter writeRecords(Object output)
                   throws IOException

Opens a low-level RecordWriter cursor over the specified output.

When invoked on a convenience Serializer the cursor is opened with default session args (mirroring write(...)). Callers that need request-derived configuration should instead call createSession(args).build() and invoke this method on the resulting SerializerSession.

Parameters:

output - The output. Subtypes define the supported types (typically Writer / OutputStream / File / StringBuilder).

Returns:

A new RecordWriter cursor.

Throws:

IOException - If a problem occurred opening the underlying output.

isRecordStreaming

default boolean isRecordStreaming()

Streaming-quality signal queryable before opening a cursor.

Returns:

true if writeRecords(Object) returns an O(1)-memory streaming cursor; false for buffered (whole-value) formats backed by RecordAdapter.