Package org.apache.juneau.msgpack

Class MsgPackParser

java.lang.Object

org.apache.juneau.Context

org.apache.juneau.BeanContextable

org.apache.juneau.parser.Parser

org.apache.juneau.parser.InputStreamParser

org.apache.juneau.msgpack.MsgPackParser

All Implemented Interfaces:

AnnotationProvider, MsgPackMetaProvider

Direct Known Subclasses:

MsgPackParser.Base64, MsgPackParser.SpacedHex

public class MsgPackParser
extends InputStreamParser
implements MsgPackMetaProvider

Parses a MessagePack stream into a POJO model.

Media types

Handles Content-Type types: octal/msgpack

Notes:

• This class is thread safe and reusable.

See Also:

• MessagePack Basics

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	MsgPackParser.Base64	Default parser, string input encoded as BASE64.
static class	MsgPackParser.Builder	Builder class.
static class	MsgPackParser.SpacedHex	Default parser, string input encoded as spaced-hex.

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

Parser.Null

Field Summary

Fields

Modifier and Type	Field	Description
static final MsgPackParser	DEFAULT	Default parser, all default settings.
static final MsgPackParser	DEFAULT_BASE64	Default parser, all default settings, string input encoded as BASE64.
static final MsgPackParser	DEFAULT_SPACED_HEX	Default parser, all default settings, string input encoded as spaced-hex.

Fields inherited from class org.apache.juneau.Context

CONTEXT_APPLY_FILTER

Fields inherited from interface org.apache.juneau.AnnotationProvider

DISABLE_ANNOTATION_CACHING

Constructor Summary

Constructors

Constructor	Description
MsgPackParser(MsgPackParser.Builder builder)	Constructor.

Method Summary

Modifier and Type	Method	Description
MsgPackParser.Builder	copy()	Creates a builder from this context object.
static MsgPackParser.Builder	create()	Creates a new builder for this object.
MsgPackParserSession.Builder	createSession()	Create a session builder based on the properties defined on this context.
MsgPackBeanPropertyMeta	getMsgPackBeanPropertyMeta(BeanPropertyMeta bpm)	Returns the language-specific metadata on the specified bean property.
MsgPackClassMeta	getMsgPackClassMeta(ClassMeta<?> cm)	Returns the language-specific metadata on the specified class.
MsgPackParserSession	getSession()	Returns a session to use for this context.

Methods inherited from class org.apache.juneau.parser.InputStreamParser

getBinaryFormat, isReaderParser, properties

Methods inherited from class org.apache.juneau.parser.Parser

canHandle, createParserBuilder, doParse, getDebugOutputLines, getListener, getMediaTypes, getPrimaryMediaType, isAutoCloseStreams, isStrict, isTrimStrings, isUnbuffered, parse, parse, parse, parse, parse, parse, parseArgs, parseIntoCollection, parseIntoMap

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

public static final MsgPackParser DEFAULT

Default parser, all default settings.

DEFAULT_SPACED_HEX

public static final MsgPackParser DEFAULT_SPACED_HEX

Default parser, all default settings, string input encoded as spaced-hex.

DEFAULT_BASE64

public static final MsgPackParser DEFAULT_BASE64

Default parser, all default settings, string input encoded as BASE64.

Constructor Details

MsgPackParser

public MsgPackParser(MsgPackParser.Builder builder)

Constructor.

Parameters:

builder - The builder for this object.

Method Details

create

public static MsgPackParser.Builder create()

Creates a new builder for this object.

Returns:

A new builder.

copy

public MsgPackParser.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 class Parser

Returns:

A new Builder object.

createSession

public MsgPackParserSession.Builder 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 class InputStreamParser

Returns:

A new session builder.

getSession

public MsgPackParserSession 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 class InputStreamParser

Returns:

A new session object.

getMsgPackClassMeta

public MsgPackClassMeta getMsgPackClassMeta(ClassMeta<?> cm)

Description copied from interface: MsgPackMetaProvider

Returns the language-specific metadata on the specified class.

Specified by:

getMsgPackClassMeta in interface MsgPackMetaProvider

Parameters:

cm - The class to return the metadata on.

Returns:

The metadata.

getMsgPackBeanPropertyMeta

public MsgPackBeanPropertyMeta getMsgPackBeanPropertyMeta(BeanPropertyMeta bpm)

Description copied from interface: MsgPackMetaProvider

Returns the language-specific metadata on the specified bean property.

Specified by:

getMsgPackBeanPropertyMeta in interface MsgPackMetaProvider

Parameters:

bpm - The bean property to return the metadata on.

Returns:

The metadata.