Package org.apache.juneau.marshall.cbor

Class CborSerializerSession

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.cbor.CborSerializerSession

All Implemented Interfaces:

BeanSession, ConverterSession, ArrayRecordWritable, RecordWritable, TokenWritable

public class CborSerializerSession
extends OutputStreamSerializerSession
implements TokenWritable, ArrayRecordWritable

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

Notes:

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

See Also:

• CBOR

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	CborSerializerSession.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	CborSerializerSession(CborSerializerSession.Builder builder)	Constructor.

Method Summary

Modifier and Type	Method	Description
static CborSerializerSession.Builder	create(CborSerializer ctx)	Creates a new builder for this object.
protected void	doWrite(SerializerPipe out, Object o)	Serializes a POJO to the specified pipe.
RecordWriter	writeArrayRecords(Object output)	Streaming array-element RecordWriter backed by CborTokenWriter.
TokenWriter	writeTokens(Object output)	Opens a low-level push generator that emits CBOR (RFC 8949) 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, isAddBeanTypes, 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.marshall.stream.ArrayRecordWritable

isArrayRecordStreaming, writeArrayRecords

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

CborSerializerSession

protected CborSerializerSession(CborSerializerSession.Builder builder)

Constructor.

Parameters:

builder - The builder for this object.

Method Details

create

public static CborSerializerSession.Builder create(CborSerializer 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 CBOR (RFC 8949) one structural event at a time, bound to this live session.

Containers (startObject / startArray) are emitted as CBOR indefinite-length markers (0xBF / 0x9F) so the caller doesn't have to know element counts up front; matching endXxx calls emit the BREAK byte (0xFF). Resulting bytes are valid RFC-8949 CBOR.

Builder properties honored:

Databind-level settings flow through to object(Object): keepNullProperties, trimEmptyMaps, trimEmptyCollections, sortMaps, sortCollections, trimStrings.

Builder properties NOT honored:

useWhitespace, maxIndent, quoteChar, escapeSolidus (binary format — no text-formatting concepts apply); uriContext, uriResolution, uriRelativity, listener.

Specified by:

writeTokens in interface TokenWritable

Parameters:

output - The output. Accepts an OutputStream.

Returns:

A new CborTokenWriter.

Throws:

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

writeArrayRecords

public RecordWriter writeArrayRecords(Object output)
                               throws IOException

Streaming array-element RecordWriter backed by CborTokenWriter. Memory is O(1) — CBOR's writer always uses indefinite-length arrays (0x9F .. 0xFF) so element count is not required up front.

Specified by:

writeArrayRecords in interface ArrayRecordWritable

Parameters:

output - The output.

Returns:

A new element-streamed 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.