Package org.apache.juneau.msgpack
Class MsgPackSerializer
java.lang.Object
org.apache.juneau.Context
org.apache.juneau.BeanContextable
org.apache.juneau.BeanTraverseContext
org.apache.juneau.serializer.Serializer
org.apache.juneau.serializer.OutputStreamSerializer
org.apache.juneau.msgpack.MsgPackSerializer
- All Implemented Interfaces:
AnnotationProvider
,MsgPackMetaProvider
- Direct Known Subclasses:
MsgPackSerializer.Base64
,MsgPackSerializer.SpacedHex
Serializes POJO models to MessagePack.
Accept types: octal/msgpack
Media types:
Handles
Produces
Notes:
- This class is thread safe and reusable.
See Also:
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic class
Default serializer, BASE64 string output.static class
Builder class.static class
Default serializer, spaced-hex string output.Nested classes/interfaces inherited from class org.apache.juneau.serializer.Serializer
Serializer.Null
-
Field Summary
Modifier and TypeFieldDescriptionstatic final MsgPackSerializer
Default serializer, all default settings.static final MsgPackSerializer
Default serializer, all default settings, spaced-hex string output.static final MsgPackSerializer
Default serializer, all default settings, spaced-hex string output.Fields inherited from class org.apache.juneau.Context
CONTEXT_APPLY_FILTER
Fields inherited from interface org.apache.juneau.AnnotationProvider
DISABLE_ANNOTATION_CACHING
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptioncopy()
Creates a builder from this context object.static MsgPackSerializer.Builder
create()
Creates a new builder for this object.Create a session builder based on the properties defined on this context.Returns the language-specific metadata on the specified bean property.getMsgPackClassMeta
(ClassMeta<?> cm) Returns the language-specific metadata on the specified class.Returns a session to use for this context.protected final boolean
Add"_type" properties when needed.protected JsonMap
Returns the properties on this bean as a map for debugging.Methods inherited from class org.apache.juneau.serializer.OutputStreamSerializer
getBinaryFormat, isWriterSerializer, serialize
Methods inherited from class org.apache.juneau.serializer.Serializer
createSerializerBuilder, doSerialize, forEachAcceptMediaType, getListener, getMediaTypeRanges, getPrimaryMediaType, getResponseContentType, getResponseHeaders, getUriContext, getUriRelativity, getUriResolution, isAddRootType, isKeepNullProperties, isSortCollections, isSortMaps, isTrimEmptyCollections, isTrimEmptyMaps, isTrimStrings, serialize, serializeToString
Methods inherited from class org.apache.juneau.BeanTraverseContext
getInitialDepth, getMaxDepth, isDetectRecursions, isIgnoreRecursions
Methods inherited from class org.apache.juneau.BeanContextable
getBeanContext
Methods inherited from class org.apache.juneau.Context
createBuilder, firstAnnotation, firstAnnotation, firstAnnotation, firstAnnotation, firstDeclaredAnnotation, forEachAnnotation, forEachAnnotation, forEachAnnotation, forEachAnnotation, forEachDeclaredAnnotation, hasAnnotation, hasAnnotation, hasAnnotation, hasAnnotation, init, isDebug, lastAnnotation, lastAnnotation, lastAnnotation, lastAnnotation, lastDeclaredAnnotation, 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.AnnotationProvider
firstAnnotation, firstAnnotation, firstAnnotation, firstAnnotation, firstDeclaredAnnotation, forEachAnnotation, forEachAnnotation, forEachAnnotation, forEachAnnotation, forEachDeclaredAnnotation, lastAnnotation, lastAnnotation, lastAnnotation, lastAnnotation, lastDeclaredAnnotation
-
Field Details
-
DEFAULT
Default serializer, all default settings. -
DEFAULT_SPACED_HEX
Default serializer, all default settings, spaced-hex string output. -
DEFAULT_BASE64
Default serializer, all default settings, spaced-hex string output.
-
-
Constructor Details
-
MsgPackSerializer
Constructor.- Parameters:
builder
- The builder for this object.
-
-
Method Details
-
create
Creates a new builder for this object.- Returns:
- A new builder.
-
copy
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:
copy
in classSerializer
- Returns:
- A new Builder object.
-
createSession
Description copied from class:Context
Create a session builder based on the properties defined on this context.Use this method for creating sessions where you want to override basic settings. Otherwise, use
Context.getSession()
directly.- Overrides:
createSession
in classOutputStreamSerializer
- Returns:
- A new session builder.
-
getSession
Description copied from class:Context
Returns a session to use for this context.Note that subclasses may opt to return a reusable non-modifiable session.
- Overrides:
getSession
in classOutputStreamSerializer
- Returns:
- A new session object.
-
getMsgPackClassMeta
Description copied from interface:MsgPackMetaProvider
Returns the language-specific metadata on the specified class.- Specified by:
getMsgPackClassMeta
in interfaceMsgPackMetaProvider
- Parameters:
cm
- The class to return the metadata on.- Returns:
- The metadata.
-
getMsgPackBeanPropertyMeta
Description copied from interface:MsgPackMetaProvider
Returns the language-specific metadata on the specified bean property.- Specified by:
getMsgPackBeanPropertyMeta
in interfaceMsgPackMetaProvider
- Parameters:
bpm
- The bean property to return the metadata on.- Returns:
- The metadata.
-
isAddBeanTypes
Description copied from class:Serializer
Add"_type" properties when needed.- Overrides:
isAddBeanTypes
in classSerializer
- Returns:
true if"_type" properties added to beans if their type cannot be inferred through reflection.- See Also:
-
properties
Description copied from class:Context
Returns the properties on this bean as a map for debugging.- Overrides:
properties
in classOutputStreamSerializer
- Returns:
- The properties on this bean as a map for debugging.
-