Package org.apache.juneau.marshall.msgpack

Class MsgPackSerializerSession

java.lang.Object

org.apache.juneau.marshall.ContextSession

org.apache.juneau.marshall.MarshallingSession

org.apache.juneau.marshall.MarshallingTraverseSession

org.apache.juneau.marshall.serializer.SerializerSession

org.apache.juneau.marshall.serializer.OutputStreamSerializerSession

org.apache.juneau.marshall.msgpack.MsgPackSerializerSession

All Implemented Interfaces:

BeanSession, ConverterSession, ArrayRecordWritable, RecordWritable, TokenWritable

public class MsgPackSerializerSession
extends OutputStreamSerializerSession
implements TokenWritable, ArrayRecordWritable

Session object that lives for the duration of a single use of MsgPackSerializer.

Notes:

• This class is not thread safe and is typically discarded after one use.

See Also:

• MessagePack

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	MsgPackSerializerSession.Builder	Builder class.

Nested classes/interfaces inherited from class org.apache.juneau.marshall.serializer.OutputStreamSerializerSession

OutputStreamSerializerSession.DefaultBuilder

Field Summary

Fields inherited from class org.apache.juneau.marshall.MarshallingTraverseSession

indent

Fields inherited from class org.apache.juneau.marshall.MarshallingSession

NAME_PROPERTY_NAME

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	MsgPackSerializerSession(MsgPackSerializerSession.Builder builder)	Constructor.

Method Summary

Modifier and Type	Method	Description
static MsgPackSerializerSession.Builder	create(MsgPackSerializer ctx)	Creates a new builder for this object.
protected void	doWrite(SerializerPipe out, Object o)	Serializes a POJO to the specified pipe.
boolean	isAddBeanTypes()	Add "_type" properties when needed.
boolean	isArrayRecordStreaming()	Streaming-quality signal queryable before opening a cursor.
RecordWriter	writeArrayRecords(Object output)	Buffered array-element RecordWriter.
RecordWriter	writeArrayRecords(Object output, int expectedCount)	Streaming array-element RecordWriter that pre-declares the element count and writes each element directly to the output stream — no per-element buffering.
TokenWriter	writeTokens(Object output)	Opens a low-level push generator that emits MessagePack one structural event at a time, bound to this live session.

Methods inherited from class org.apache.juneau.marshall.serializer.OutputStreamSerializerSession

create, createPipe, getBinaryFormat, hasNativeBytes, isWriterSerializer, write, writeToString

Methods inherited from class org.apache.juneau.marshall.serializer.SerializerSession

addVarBean, canIgnoreValue, canIgnoreValue, create, createBeanTypeNameProperty, createDefaultVarResolverSession, forEachEntry, forEachEntry, forEachStreamableEntry, generalize, getBeanTypeName, getCalendarFormat, getDateFormat, getDurationFormat, getExpectedRootType, getJavaMethod, getListener, getListener, getLocaleFormat, getPeriodFormat, getResponseHeaders, getSchema, getTemporalFormat, getTimeZoneFormat, getUriContext, getUriRelativity, getUriResolution, getUriResolver, getVarResolver, handleThrown, isAddRootType, isKeepNullProperties, isNonDefault, isSortCollections, isSortMaps, isTrimEmptyCollections, isTrimEmptyMaps, isTrimStrings, onBeanGetterException, onError, properties, push2, relativizeUri, resolve, resolveUri, sort, sort, sort, swap, toList, toListFromStreamable, toString, trim, unwrapSupplier, write, writeCalendar, writeDate, writeDuration, writePeriod, writeTemporal

Methods inherited from class org.apache.juneau.marshall.MarshallingTraverseSession

getInitialDepth, getLastLocation, getMaxDepth, getOptionalType, getOptionalValue, getStack, isDetectRecursions, isIgnoreRecursions, isOptional, isRoot, pop, push, setCurrentClass, setCurrentProperty, willExceedDepth, willRecurse

Methods inherited from class org.apache.juneau.marshall.MarshallingSession

addWarning, convertToMemberType, convertToMemberType, convertToMemberType, convertToType, convertToType, convertToType, convertToType, create, get, getActiveView, getAnnotationProvider, getArgsClassMeta, getBeanClassVisibility, getBeanConstructorVisibility, getBeanDictionary, getBeanFieldVisibility, getBeanMeta, getBeanMethodVisibility, getBeanRegistry, getBeanTypePropertyName, getBeanTypePropertyName, getClassLoader, getClassMeta, getClassMeta, getClassMetaForObject, getClassMetaForObject, getLocale, getMarshallingContext, getMediaType, getNotBeanClasses, getNotBeanPackagesNames, getPropertyNamer, getSwaps, getTimeZone, getTimeZoneId, isBean, isBean, isBeanMapPutReturnsOldValue, isBeansRequireDefaultConstructor, isBeansRequireSerializable, isBeansRequireSettersForGetters, isBeansRequireSomeProperties, isFindFluentSetters, isIgnoreInvocationExceptionsOnGetters, isIgnoreInvocationExceptionsOnSetters, isIgnoreMissingSetters, isIgnoreUnknownBeanProperties, isIgnoreUnknownNullBeanProperties, isPropertyInActiveView, isRecordComponentOrder, isUnsortedProperties, isUseInterfaceProxies, isUseJavaBeanIntrospector, isValidateSchema, newBean, newBean, newBeanMap, newBeanMap, newGenericList, newGenericMap, newGenericMap, object, parseToList, parseToMap, string, toArray, toBeanMap, toBeanMap, toBeanMap

Methods inherited from class org.apache.juneau.marshall.ContextSession

checkForWarnings, getContext, getSessionProperties, getWarnings, isDebug, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.juneau.commons.conversion.ConverterSession

get

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

isRecordStreaming

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

writeRecords

Constructor Details

MsgPackSerializerSession

protected MsgPackSerializerSession(MsgPackSerializerSession.Builder builder)

Constructor.

Parameters:

builder - The builder for this object.

Method Details

create

public static MsgPackSerializerSession.Builder create(MsgPackSerializer ctx)

Creates a new builder for this object.

Parameters:

ctx - The context creating this session.
Cannot be null.

Returns:

A new builder.

writeTokens

public TokenWriter writeTokens(Object output)
                        throws IOException

Opens a low-level push generator that emits MessagePack one structural event at a time, bound to this live session.

MsgPack containers are length-prefixed with no indefinite-length encoding, so the writer buffers each open container's body bytes until the matching endXxx call; memory cost is O(largest open container).

Builder properties honored:

keepNullProperties, trimEmptyMaps, trimEmptyCollections, sortMaps, sortCollections, trimStrings — all flow through to object(Object).

Builder properties NOT honored:

useWhitespace, maxIndent, quoteChar, escapeSolidus (binary format); uriContext, uriResolution, uriRelativity, listener.

Specified by:

writeTokens in interface TokenWritable

Parameters:

output - The output.

Returns:

A new MsgPackTokenWriter.

Throws:

IOException - If the output type is not supported or could not be opened.

writeArrayRecords

public RecordWriter writeArrayRecords(Object output)
                               throws IOException

Buffered array-element RecordWriter. MsgPack's array wire format is length-prefixed, so streaming without a known element count requires either buffering (this method) or the writeArrayRecords(Object, int) overload that takes a count.

Specified by:

writeArrayRecords in interface ArrayRecordWritable

Parameters:

output - The output.

Returns:

A buffered RecordWriter.

Throws:

IOException - If a problem occurred opening the underlying output.

isArrayRecordStreaming

public boolean isArrayRecordStreaming()

Description copied from interface: ArrayRecordWritable

Streaming-quality signal queryable before opening a cursor.

Specified by:

isArrayRecordStreaming in interface ArrayRecordWritable

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).

writeArrayRecords

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

Streaming array-element RecordWriter that pre-declares the element count and writes each element directly to the output stream — no per-element buffering. The caller must pass exactly expectedCount RecordWriter.write(Object) calls before RecordWriter.close(); mismatch throws on close.

Specified by:

writeArrayRecords in interface ArrayRecordWritable

Parameters:

output - The output (must be an OutputStream).

expectedCount - The number of elements that will be written.

Returns:

A streaming RecordWriter.

Throws:

IOException - If a problem occurred opening the underlying output.

doWrite

protected void doWrite(SerializerPipe out,
 Object o)
                throws IOException,
SerializeException

Description copied from class: SerializerSession

Serializes a POJO to the specified pipe.

This method should NOT close the context object.

The default implementation of this method simply calls Serializer.doWrite(SerializerSession,SerializerPipe,Object).

Overrides:

doWrite in class SerializerSession

Parameters:

out - Where to send the output from the serializer.

o - The object to serialize.

Throws:

IOException - Thrown by underlying stream.

SerializeException - Problem occurred trying to serialize object.

isAddBeanTypes

public boolean isAddBeanTypes()

Description copied from class: SerializerSession

Add "_type" properties when needed.

Overrides:

isAddBeanTypes in class SerializerSession

Returns:

true if "_type" properties added to beans if their type cannot be inferred through reflection.

See Also:

• Serializer.Builder.addBeanTypes()