org.apache.juneau.msgpack

Class MsgPackSerializer

java.lang.Object

org.apache.juneau.Context

org.apache.juneau.BeanContext

org.apache.juneau.BeanTraverseContext

org.apache.juneau.serializer.Serializer

org.apache.juneau.serializer.OutputStreamSerializer

org.apache.juneau.msgpack.MsgPackSerializer

Direct Known Subclasses:

MsgPackSerializer.Base64, MsgPackSerializer.SpacedHex

public class MsgPackSerializer
extends OutputStreamSerializer

Serializes POJO models to MessagePack.

Media types:

Handles Accept types: octal/msgpack

Produces Content-Type types: octal/msgpack

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MsgPackSerializer.Base64 Default serializer, BASE64 string output.
static class	MsgPackSerializer.SpacedHex Default serializer, spaced-hex string output.

Field Summary

Fields

Modifier and Type	Field and Description
static MsgPackSerializer	DEFAULT Default serializer, all default settings.
static MsgPackSerializer	DEFAULT_BASE64 Default serializer, all default settings, spaced-hex string output.
static MsgPackSerializer	DEFAULT_SPACED_HEX Default serializer, all default settings, spaced-hex string output.
static String	MSGPACK_addBeanTypes Configuration property: Add "_type" properties when needed.

Fields inherited from class org.apache.juneau.serializer.OutputStreamSerializer

OSSERIALIZER_binaryFormat

Fields inherited from class org.apache.juneau.serializer.Serializer

SERIALIZER_addBeanTypes, SERIALIZER_addRootType, SERIALIZER_listener, SERIALIZER_sortCollections, SERIALIZER_sortMaps, SERIALIZER_trimEmptyCollections, SERIALIZER_trimEmptyMaps, SERIALIZER_trimNullProperties, SERIALIZER_trimStrings, SERIALIZER_uriContext, SERIALIZER_uriRelativity, SERIALIZER_uriResolution, SERIALIZER_useWhitespace

Fields inherited from class org.apache.juneau.BeanTraverseContext

BEANTRAVERSE_detectRecursions, BEANTRAVERSE_ignoreRecursions, BEANTRAVERSE_initialDepth, BEANTRAVERSE_maxDepth

Fields inherited from class org.apache.juneau.BeanContext

BEAN_beanClassVisibility, BEAN_beanConstructorVisibility, BEAN_beanDictionary, BEAN_beanDictionary_add, BEAN_beanDictionary_remove, BEAN_beanFieldVisibility, BEAN_beanFilters, BEAN_beanFilters_add, BEAN_beanFilters_remove, BEAN_beanMapPutReturnsOldValue, BEAN_beanMethodVisibility, BEAN_beansRequireDefaultConstructor, BEAN_beansRequireSerializable, BEAN_beansRequireSettersForGetters, BEAN_beansRequireSomeProperties, BEAN_beanTypePropertyName, BEAN_debug, BEAN_examples, BEAN_excludeProperties, BEAN_fluentSetters, BEAN_ignoreInvocationExceptionsOnGetters, BEAN_ignoreInvocationExceptionsOnSetters, BEAN_ignorePropertiesWithoutSetters, BEAN_ignoreUnknownBeanProperties, BEAN_ignoreUnknownNullBeanProperties, BEAN_implClasses, BEAN_includeProperties, BEAN_locale, BEAN_mediaType, BEAN_notBeanClasses, BEAN_notBeanClasses_add, BEAN_notBeanClasses_remove, BEAN_notBeanPackages, BEAN_notBeanPackages_add, BEAN_notBeanPackages_remove, BEAN_pojoSwaps, BEAN_pojoSwaps_add, BEAN_pojoSwaps_remove, BEAN_propertyNamer, BEAN_sortProperties, BEAN_timeZone, BEAN_useEnumNames, BEAN_useInterfaceProxies, BEAN_useJavaBeanIntrospector, DEFAULT_SORTED

Constructor Summary

Constructors

Constructor and Description
MsgPackSerializer(PropertyStore ps) Constructor.

Method Summary

Modifier and Type	Method and Description
ObjectMap	asMap() Returns the properties defined on this bean context as a simple map for debugging purposes.
MsgPackSerializerBuilder	builder() Creates a builder from this context object.
static MsgPackSerializerBuilder	create() Instantiates a new clean-slate MsgPackSerializerBuilder object.
OutputStreamSerializerSession	createSession(SerializerSessionArgs args) Create the session object used for actual serialization of objects.
protected boolean	isAddBeanTypes() Configuration property: Add "_type" properties when needed.

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

getBinaryFormat, isWriterSerializer, serialize

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

createDefaultSessionArgs, createSession, getAcceptMediaTypes, getListener, getMediaTypeRanges, getPrimaryMediaType, getResponseContentType, getUriContext, getUriRelativity, getUriResolution, isAddRootType, isSortCollections, isSortMaps, isTrimEmptyCollections, isTrimEmptyMaps, isTrimNullProperties, isTrimStrings, isUseWhitespace, serialize, serializeToString

Methods inherited from class org.apache.juneau.BeanTraverseContext

createSession, getInitialDepth, getMaxDepth, isDetectRecursions, isIgnoreRecursions

Methods inherited from class org.apache.juneau.BeanContext

_class, createBeanSession, createBeanSession, createDefaultBeanSessionArgs, createSession, dumpCacheStats, getBeanClassVisibility, getBeanConstructorVisibility, getBeanDictionaryClasses, getBeanFieldVisibility, getBeanMeta, getBeanMethodVisibility, getBeanRegistry, getBeanTypePropertyName, getClassMeta, getClassMeta, getClassMetaForObject, getExcludeProperties, getImplClassConstructor, getIncludeProperties, getLocale, getMediaType, getPropertyNamer, getTimeZone, hasSameCache, isBean, isBeanMapPutReturnsOldValue, isBeansRequireDefaultConstructor, isBeansRequireSerializable, isBeansRequireSettersForGetters, isBeansRequireSomeProperties, isDebug, isFluentSetters, isIgnoreInvocationExceptionsOnGetters, isIgnoreInvocationExceptionsOnSetters, isIgnorePropertiesWithoutSetters, isIgnoreUnknownBeanProperties, isIgnoreUnknownNullBeanProperties, isNotABean, isSortProperties, isUseEnumNames, isUseInterfaceProxies, isUseJavaBeanIntrospector, newInstance, newInstance, newInstanceFromOuter, object, resolveClassMeta, string

Methods inherited from class org.apache.juneau.Context

equals, getArrayProperty, getArrayProperty, getBooleanProperty, getClassArrayProperty, getClassArrayProperty, getClassArrayProperty, getClassListProperty, getClassListProperty, getClassMapProperty, getClassMapProperty, getClassProperty, getClassSetProperty, getClassSetProperty, getInstanceArrayProperty, getInstanceArrayProperty, getInstanceArrayProperty, getInstanceProperty, getInstanceProperty, getInstanceProperty, getIntegerProperty, getListProperty, getListProperty, getLongProperty, getMapProperty, getProperty, getProperty, getPropertyKeys, getPropertyStore, getSetProperty, getSetProperty, getStringProperty, hashCode, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

MSGPACK_addBeanTypes

public static final String MSGPACK_addBeanTypes

Configuration property: Add "_type" properties when needed.

Property:

• Name: "MsgPackSerializer.addBeanTypes.b"
• Data type: Boolean
• Default: false
• Session property: false
• Methods:
  • MsgPackSerializerBuilder.addBeanTypes(boolean)

Description:

If true, then "_type" properties will be added to beans if their type cannot be inferred through reflection.

When present, this value overrides the Serializer.SERIALIZER_addBeanTypes setting and is provided to customize the behavior of specific serializers in a SerializerGroup.

See Also:

Constant Field Values

DEFAULT

public static final MsgPackSerializer DEFAULT

Default serializer, all default settings.

DEFAULT_SPACED_HEX

public static final MsgPackSerializer DEFAULT_SPACED_HEX

Default serializer, all default settings, spaced-hex string output.

DEFAULT_BASE64

public static final MsgPackSerializer DEFAULT_BASE64

Default serializer, all default settings, spaced-hex string output.

Constructor Detail

MsgPackSerializer

public MsgPackSerializer(PropertyStore ps)

Constructor.

Parameters:

ps - The property store containing all the settings for this object.

Method Detail

builder

public MsgPackSerializerBuilder builder()

Description copied from class: Context

Creates a builder from this context object.

Builders are used to define new contexts (e.g. serializers, parsers) based on existing configurations.

Overrides:

builder in class Serializer

Returns:

A new ContextBuilder object.

create

public static MsgPackSerializerBuilder create()

Instantiates a new clean-slate MsgPackSerializerBuilder object.

This is equivalent to simply calling new MsgPackSerializerBuilder().

Note that this method creates a builder initialized to all default settings, whereas builder() copies the settings of the object called on.

Returns:

A new MsgPackSerializerBuilder object.

createSession

public OutputStreamSerializerSession createSession(SerializerSessionArgs args)

Description copied from class: Serializer

Create the session object used for actual serialization of objects.

Specified by:

createSession in class OutputStreamSerializer

Parameters:

args - Runtime arguments. These specify session-level information such as locale and URI context. It also include session-level properties that override the properties defined on the bean and serializer contexts.

Returns:

The new session object.

isAddBeanTypes

protected final boolean isAddBeanTypes()

Description copied from class: Serializer

Configuration property: Add "_type" properties when needed.

Overrides:

isAddBeanTypes in class Serializer

Returns:

true if "_type" properties added to beans if their type cannot be inferred through reflection.

See Also:

Serializer.SERIALIZER_addBeanTypes

asMap

public ObjectMap asMap()

Description copied from class: Context

Returns the properties defined on this bean context as a simple map for debugging purposes.

Overrides:

asMap in class OutputStreamSerializer

Returns:

A new map containing the properties defined on this context.