Package org.apache.juneau.marshall.bson

Class BsonSerializerSession

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.bson.BsonSerializerSession

All Implemented Interfaces:

BeanSession, ConverterSession, ArrayRecordWritable, RecordWritable

public class BsonSerializerSession
extends OutputStreamSerializerSession
implements RecordWritable, ArrayRecordWritable

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

Notes:

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

See Also:

• BSON

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static BsonSerializerSession.Builder	create(BsonSerializer ctx)	Creates a new builder for this object.
protected void	doWrite(SerializerPipe out, Object o)	Serializes a POJO to the specified pipe.
boolean	isArrayRecordStreaming()	The BSON array-record writer is buffered/RecordAdapter-backed, not O(1) streaming.
boolean	isRecordStreaming()	The BSON record writer is buffered/RecordAdapter-backed, not O(1) streaming.
RecordWriter	writeArrayRecords(Object output)	Buffered array-element RecordWriter for BSON, bound to this live session.
RecordWriter	writeRecords(Object output)	Opens a whole-value push generator targeting BSON output, 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

writeArrayRecords

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

get

Constructor Details

BsonSerializerSession

protected BsonSerializerSession(BsonSerializerSession.Builder builder)

Method Details

create

public static BsonSerializerSession.Builder create(BsonSerializer ctx)

Creates a new builder for this object.

Parameters:

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

Returns:

A new builder.

writeRecords

public RecordWriter writeRecords(Object output)
                          throws IOException

Opens a whole-value push generator targeting BSON output, bound to this live session. write(Object) delegates to SerializerSession.write(Object, Object).

Specified by:

writeRecords in interface RecordWritable

Parameters:

output - The output.

Returns:

A new RecordWriter.

Throws:

IOException - If a problem occurred opening the underlying output.

writeArrayRecords

public RecordWriter writeArrayRecords(Object output)
                               throws IOException

Buffered array-element RecordWriter for BSON, bound to this live session. BSON's wire format requires the entire document byte-length up front (length prefix at every nesting level), so streaming without buffering is not possible.

Specified by:

writeArrayRecords in interface ArrayRecordWritable

Parameters:

output - The output.

Returns:

A buffered RecordWriter.

Throws:

IOException - If a problem occurred opening the underlying output.

isRecordStreaming

public boolean isRecordStreaming()

The BSON record writer is buffered/RecordAdapter-backed, not O(1) streaming.

Specified by:

isRecordStreaming in interface RecordWritable

Returns:

Always false.

isArrayRecordStreaming

public boolean isArrayRecordStreaming()

The BSON array-record writer is buffered/RecordAdapter-backed, not O(1) streaming.

Specified by:

isArrayRecordStreaming in interface ArrayRecordWritable

Returns:

Always false.

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.