Package org.apache.juneau.marshall.bson

Class BsonParserSession

java.lang.Object

org.apache.juneau.marshall.ContextSession

org.apache.juneau.marshall.MarshallingSession

org.apache.juneau.marshall.parser.ParserSession

org.apache.juneau.marshall.parser.InputStreamParserSession

org.apache.juneau.marshall.bson.BsonParserSession

All Implemented Interfaces:

BeanSession, ConverterSession, ArrayRecordReadable, RecordReadable

public class BsonParserSession
extends InputStreamParserSession
implements RecordReadable, ArrayRecordReadable

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

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	BsonParserSession.Builder	Builder class.

Nested classes/interfaces inherited from class org.apache.juneau.marshall.parser.InputStreamParserSession

InputStreamParserSession.DefaultBuilder

Field Summary

Fields inherited from class org.apache.juneau.marshall.parser.ParserSession

DEFAULT_MAX_PARSE_DEPTH

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

NAME_PROPERTY_NAME

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	BsonParserSession(BsonParserSession.Builder builder)

Method Summary

Modifier and Type	Method	Description
static BsonParserSession.Builder	create(BsonParser ctx)	Creates a new builder for a BsonParserSession.
protected <T> T	doRead(ParserPipe pipe, ClassMeta<T> type)	Workhorse method.
boolean	isArrayRecordStreaming()	The BSON array-record cursor is buffered/RecordAdapter-backed, not O(1) streaming.
boolean	isRecordStreaming()	The BSON record cursor is buffered/RecordAdapter-backed, not O(1) streaming.
RecordReader	readArrayRecords(Object input)	Buffered array-element RecordReader for BSON, bound to this live session.
RecordReader	readRecords(Object input)	Opens a whole-value pull-parser cursor over a BSON document, bound to this live session.

Methods inherited from class org.apache.juneau.marshall.parser.InputStreamParserSession

create, createPipe, getBinaryFormat, hasNativeBytes, isReaderParser

Methods inherited from class org.apache.juneau.marshall.parser.ParserSession

allocateLocal, cast, checkRequired, convertAttrToType, create, doReadIntoCollection, doReadIntoMap, doReadToBeanConsumer, enterParseDepth, exitParseDepth, getCalendarFormat, getClassMeta, getDateFormat, getDebugOutputLines, getDurationFormat, getInputAsString, getJavaMethod, getLastLocation, getListener, getListener, getListenerClass, getLocaleFormat, getNulls, getOuter, getPeriodFormat, getPosition, getSchema, getStringBuilder, getTemporalFormat, getTimeZoneFormat, isAutoCloseStreams, isTrimStrings, isUnbuffered, mark, onBeanSetterException, onUnknownProperty, parentBean, properties, read, read, read, read, read, read, readArgs, readCalendar, readDate, readDuration, readIntoCollection, readIntoMap, readPeriod, readTemporal, readToBeanConsumer, returnStringBuilder, setCurrentClass, setCurrentProperty, setName, setParent, setPipe, swapParentBean, trim, trim, unmark, unswap

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

readArrayRecords

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

get

Constructor Details

BsonParserSession

protected BsonParserSession(BsonParserSession.Builder builder)

Method Details

create

public static BsonParserSession.Builder create(BsonParser ctx)

Creates a new builder for a BsonParserSession.

Parameters:

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

Returns:

A new builder.

doRead

protected <T> T doRead(ParserPipe pipe,
 ClassMeta<T> type)
                throws IOException,
ParseException,
ExecutableException

Description copied from class: ParserSession

Workhorse method.

Subclasses are expected to implement this method or Parser.doRead(ParserSession,ParserPipe,ClassMeta).

The default implementation of this method simply calls Parser.doRead(ParserSession,ParserPipe,ClassMeta).

Overrides:

doRead in class ParserSession

Type Parameters:

T - The class type of the object to create.

Parameters:

pipe - Where to get the input from.

type - The class type of the object to create. If null or Object.class, object type is based on what's being parsed. For example, when parsing JSON text, it may return a String, Number, JsonMap, etc...

Returns:

The parsed object.

Throws:

IOException - Thrown by underlying stream.

ParseException - Malformed input encountered.

ExecutableException - Exception occurred on invoked constructor/method/field.

readRecords

public RecordReader readRecords(Object input)
                         throws IOException

Opens a whole-value pull-parser cursor over a BSON document, bound to this live session. read(...) delegates to the polymorphic ParserSession.read(Object, Class) entry point.

Specified by:

readRecords in interface RecordReadable

Parameters:

input - The input.

Returns:

A new RecordReader cursor.

Throws:

IOException - If a problem occurred opening the underlying input.

readArrayRecords

public RecordReader readArrayRecords(Object input)
                              throws IOException

Buffered array-element RecordReader for BSON, bound to this live session. Calls parse(input, List.class, Object.class) once and iterates the result.

Specified by:

readArrayRecords in interface ArrayRecordReadable

Parameters:

input - The input.

Returns:

A buffered RecordReader.

Throws:

IOException - If a problem occurred reading the input.

isRecordStreaming

public boolean isRecordStreaming()

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

Specified by:

isRecordStreaming in interface RecordReadable

Returns:

Always false.

isArrayRecordStreaming

public boolean isArrayRecordStreaming()

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

Specified by:

isArrayRecordStreaming in interface ArrayRecordReadable

Returns:

Always false.