Package org.apache.juneau.marshall.msgpack

Class MsgPackParserSession

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.msgpack.MsgPackParserSession

All Implemented Interfaces:

BeanSession, ConverterSession, ArrayRecordReadable, RecordReadable, TokenReadable

public class MsgPackParserSession
extends InputStreamParserSession
implements TokenReadable, ArrayRecordReadable

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

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	MsgPackParserSession.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	MsgPackParserSession(MsgPackParserSession.Builder builder)	Constructor.

Method Summary

Modifier and Type	Method	Description
static MsgPackParserSession.Builder	create(MsgPackParser ctx)	Creates a new builder for this object.
protected <T> T	doRead(ParserPipe pipe, ClassMeta<T> type)	Workhorse method.
RecordReader	readArrayRecords(Object input)	Streaming array-element RecordReader backed by MsgPackTokenReader.
TokenReader	readTokens(Object input)	Opens a low-level pull-parser cursor over a MessagePack 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

isArrayRecordStreaming, readArrayRecords

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

get

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

isRecordStreaming

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

readRecords

Constructor Details

MsgPackParserSession

protected MsgPackParserSession(MsgPackParserSession.Builder builder)

Constructor.

Parameters:

builder - The builder for this object.

Method Details

create

public static MsgPackParserSession.Builder create(MsgPackParser ctx)

Creates a new builder for this object.

Parameters:

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

Returns:

A new builder.

readTokens

public TokenReader readTokens(Object input)
                       throws IOException

Opens a low-level pull-parser cursor over a MessagePack document, bound to this live session.

Builder properties honored:

autoCloseStreams, unbuffered.

Builder properties NOT honored:

listener, debugOutputLines, consumes, swaps, @Schema.

Specified by:

readTokens in interface TokenReadable

Parameters:

input - The input.

Returns:

A new MsgPackTokenReader.

Throws:

IOException - If a problem occurred opening the underlying input.

readArrayRecords

public RecordReader readArrayRecords(Object input)
                              throws IOException

Streaming array-element RecordReader backed by MsgPackTokenReader.

Memory is O(1) in the array length — the wrapper opens the outer MessagePack array via the token cursor and binds one element at a time, exactly mirroring the CBOR cursor. The returned cursor reports RecordReader.isStreaming() == true.

Specified by:

readArrayRecords in interface ArrayRecordReadable

Parameters:

input - The input.

Returns:

A new element-streamed RecordReader.

Throws:

IOException - If a problem occurred opening the underlying input.

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.