Package org.apache.juneau.marshall.stream

Interface ArrayRecordWritable

All Known Implementing Classes:

BsonSerializer, BsonSerializer.Base64, BsonSerializer.SpacedHex, BsonSerializerSession, 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, ParquetSerializer, ParquetSerializerSession, YamlSerializer, YamlSerializer.Readable, YamlSerializerSession

public interface ArrayRecordWritable

Capability role for serializers that can emit each element of a top-level wire array as a separate record.

The symmetric writer-side counterpart of ArrayRecordReadable. Capability is detected via instanceof.

See Also:

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

Method Summary

Modifier and Type	Method	Description
default boolean	isArrayRecordStreaming()	Streaming-quality signal queryable before opening a cursor.
RecordWriter	writeArrayRecords(Object output)	Opens a RecordWriter that wraps each write(...) call as one element of a top-level wire array.
default RecordWriter	writeArrayRecords(Object output, int expectedCount)	Variant of writeArrayRecords(Object) for length-prefixed binary formats that require the element count up front (msgpack, bson).

Method Details

writeArrayRecords

RecordWriter writeArrayRecords(Object output)
                        throws IOException

Opens a RecordWriter that wraps each write(...) call as one element of a top-level wire array.

Parameters:

output - The output.

Returns:

A new element-streamed RecordWriter.

Throws:

IOException - If a problem occurred opening the underlying output.

writeArrayRecords

default RecordWriter writeArrayRecords(Object output,
 int expectedCount)
                                throws IOException

Variant of writeArrayRecords(Object) for length-prefixed binary formats that require the element count up front (msgpack, bson). Other formats may ignore the count and behave the same as writeArrayRecords(Object).

Parameters:

output - The output.

expectedCount - The number of elements that will be written. Must match the number of RecordWriter.write(Object) calls before RecordWriter.close().

Returns:

A new element-streamed RecordWriter.

Throws:

IOException - If a problem occurred opening the underlying output.

isArrayRecordStreaming

default boolean isArrayRecordStreaming()

Streaming-quality signal queryable before opening a cursor.

Returns:

true for true element streaming (json/cbor/msgpack); false for the buffered RecordAdapter.arrayWriter(org.apache.juneau.marshall.serializer.SerializerSession, java.lang.Object)-backed formats (yaml, parquet, bson).