Package org.apache.juneau.msgpack

Class MsgPackSerializerSession

java.lang.Object

org.apache.juneau.ContextSession

org.apache.juneau.BeanSession

org.apache.juneau.BeanTraverseSession

org.apache.juneau.serializer.SerializerSession

org.apache.juneau.serializer.OutputStreamSerializerSession

org.apache.juneau.msgpack.MsgPackSerializerSession

public class MsgPackSerializerSession
extends OutputStreamSerializerSession

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 Basics

Nested Class Summary

Nested Classes

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

Field Summary

Fields inherited from class org.apache.juneau.BeanTraverseSession

indent

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	doSerialize(SerializerPipe out, Object o)	Serializes a POJO to the specified pipe.
protected boolean	isAddBeanTypes()	Add "_type" properties when needed.

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

create, createPipe, getBinaryFormat, isWriterSerializer, serialize, serializeToString

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

addVarBean, canIgnoreValue, create, createBeanTypeNameProperty, createDefaultVarResolverSession, forEachEntry, forEachEntry, generalize, getBeanTypeName, getExpectedRootType, getJavaMethod, getListener, getListener, getResponseHeaders, getSchema, getUriContext, getUriRelativity, getUriResolution, getUriResolver, getVarResolver, handleThrown, isAddRootType, isKeepNullProperties, isSortCollections, isSortMaps, isTrimEmptyCollections, isTrimEmptyMaps, isTrimStrings, onBeanGetterException, onError, properties, push2, relativizeUri, resolve, resolveUri, serialize, sort, sort, sort, swap, toList, toString, trim

Methods inherited from class org.apache.juneau.BeanTraverseSession

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

Methods inherited from class org.apache.juneau.BeanSession

addWarning, convertToMemberType, convertToMemberType, convertToType, convertToType, convertToType, create, getAnnotationProvider, getArgsClassMeta, getBeanClassVisibility, getBeanConstructorVisibility, getBeanDictionary, getBeanFieldVisibility, getBeanMeta, getBeanMethodVisibility, getBeanRegistry, getBeanTypePropertyName, getBeanTypePropertyName, getClassMeta, getClassMeta, getClassMetaForObject, getClassMetaForObject, getLocale, getMediaType, getNamePropertyName, getNotBeanClasses, getNotBeanPackagesNames, getPropertyNamer, getSwaps, getTimeZone, getTimeZoneId, isBean, isBean, isBeanMapPutReturnsOldValue, isBeansRequireDefaultConstructor, isBeansRequireSerializable, isBeansRequireSettersForGetters, isBeansRequireSomeProperties, isFindFluentSetters, isIgnoreInvocationExceptionsOnGetters, isIgnoreInvocationExceptionsOnSetters, isIgnoreMissingSetters, isIgnoreUnknownBeanProperties, isIgnoreUnknownNullBeanProperties, isSortProperties, isUseEnumNames, isUseInterfaceProxies, isUseJavaBeanIntrospector, newBean, newBean, newBeanMap, newBeanMap, newGenericMap, object, string, toArray, toBeanMap, toBeanMap, toBeanMap

Methods inherited from class org.apache.juneau.ContextSession

checkForWarnings, getContext, getSessionProperties, getWarnings, isDebug, toString

Methods inherited from class java.lang.Object

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

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.

doSerialize

protected void doSerialize(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.doSerialize(SerializerSession,SerializerPipe,Object).

Overrides:

doSerialize 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

protected 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()