Package org.apache.juneau.marshaller

Class MsgPack

java.lang.Object

org.apache.juneau.marshaller.Marshaller

org.apache.juneau.marshaller.StreamMarshaller

org.apache.juneau.marshaller.MsgPack

public class MsgPack
extends StreamMarshaller

A pairing of a MsgPackSerializer and MsgPackParser into a single class with convenience read/write methods.

The general idea is to combine a single serializer and parser inside a simplified API for reading and writing POJOs.

Examples:

// Using instance. MsgPack msgPack = new MsgPack(); MyPojo myPojo = msgPack.read(bytes, MyPojo.class); byte[] bytes = msgPack.write(myPojo);

// Using DEFAULT instance. MyPojo myPojo = MsgPack.DEFAULT.read(bytes, MyPojo.class); byte[] bytes = MsgPack.DEFAULT.write(myPojo);

See Also:

• Marshallers

Field Summary

Fields

Modifier and Type	Field	Description
static final MsgPack	DEFAULT	Default reusable instance.

Constructor Summary

Constructors

Constructor	Description
MsgPack()	Constructor.
MsgPack(MsgPackSerializer s, MsgPackParser p)	Constructor.

Method Summary

Modifier and Type	Method	Description
static byte[]	of(Object object)	Serializes a Java object to a JSON string.
static Object	of(Object object, Object output)	Serializes a Java object to an output.
static <T> T	to(byte[] input, Class<T> type)	Parses a JSON input string to the specified type.
static <T> T	to(byte[] input, Type type, Type... args)	Parses a JSON input string to the specified Java type.
static <T> T	to(Object input, Class<T> type)	Parses a JSON input object to the specified Java type.
static <T> T	to(Object input, Type type, Type... args)	Parses a JSON input object to the specified Java type.

Methods inherited from class org.apache.juneau.marshaller.StreamMarshaller

read, read, write

Methods inherited from class org.apache.juneau.marshaller.Marshaller

getParser, getSerializer, read, read, write

Methods inherited from class java.lang.Object

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

Field Details

DEFAULT

public static final MsgPack DEFAULT

Default reusable instance.

Constructor Details

MsgPack

public MsgPack()

Constructor.

Uses MsgPackSerializer.DEFAULT and MsgPackParser.DEFAULT.

MsgPack

public MsgPack(MsgPackSerializer s,
 MsgPackParser p)

Constructor.

Parameters:

s - The serializer to use for serializing output.
Must not be null.

p - The parser to use for parsing input.
Must not be null.

Method Details

of

public static byte[] of(Object object)
                 throws SerializeException

Serializes a Java object to a JSON string.

A shortcut for calling DEFAULT.write(object).

Parameters:

object - The object to serialize.

Returns:

The serialized object.

Throws:

SerializeException - If a problem occurred trying to convert the output.

of

public static Object of(Object object,
 Object output)
                 throws SerializeException,
IOException

Serializes a Java object to an output.

A shortcut for calling DEFAULT.write(output).

Parameters:

object - The object to serialize.

output - The output object.
Can be any of the following types:

• OutputStream
• File

Returns:

The output object.

Throws:

SerializeException - If a problem occurred trying to convert the output.

IOException - Thrown by underlying stream.

to

public static <T> T to(byte[] input,
 Class<T> type)
                throws ParseException

Parses a JSON input string to the specified type.

A shortcut for calling DEFAULT.read(input, type).

Type Parameters:

T - The class type of the object being created.

Parameters:

input - The input.

type - The object type to create.

Returns:

The parsed object.

Throws:

ParseException - Malformed input encountered.

to

public static <T> T to(byte[] input,
 Type type,
 Type... args)
                throws ParseException

Parses a JSON input string to the specified Java type.

A shortcut for calling DEFAULT.read(input, type, args).

Type Parameters:

T - The class type of the object to create.

Parameters:

input - The input.

type - The object type to create.
Can be any of the following: ClassMeta, Class, ParameterizedType, GenericArrayType

args - The type arguments of the class if it's a collection or map.
Can be any of the following: ClassMeta, Class, ParameterizedType, GenericArrayType
Ignored if the main type is not a map or collection.

Returns:

The parsed object.

Throws:

ParseException - Malformed input encountered.

See Also:

• for argument syntax for maps and collections.

to

public static <T> T to(Object input,
 Class<T> type)
                throws ParseException,
IOException

Parses a JSON input object to the specified Java type.

A shortcut for calling DEFAULT.read(input, type).

Type Parameters:

T - The class type of the object being created.

Parameters:

input - The input.
Can be any of the following types:

• null
• InputStream
• byte[]
• File
• CharSequence containing encoded bytes according to the InputStreamParser.Builder.binaryFormat(BinaryFormat) setting.

type - The object type to create.

Returns:

The parsed object.

Throws:

ParseException - Malformed input encountered.

IOException - Thrown by underlying stream.

to

public static <T> T to(Object input,
 Type type,
 Type... args)
                throws ParseException,
IOException

Parses a JSON input object to the specified Java type.

A shortcut for calling DEFAULT.read(input, type, args).

Type Parameters:

T - The class type of the object to create.

Parameters:

input - The input.
Can be any of the following types:

• null
• InputStream
• byte[]
• File
• CharSequence containing encoded bytes according to the InputStreamParser.Builder.binaryFormat(BinaryFormat) setting.

type - The object type to create.
Can be any of the following: ClassMeta, Class, ParameterizedType, GenericArrayType

args - The type arguments of the class if it's a collection or map.
Can be any of the following: ClassMeta, Class, ParameterizedType, GenericArrayType
Ignored if the main type is not a map or collection.

Returns:

The parsed object.

Throws:

ParseException - Malformed input encountered.

IOException - Thrown by underlying stream.

See Also:

• for argument syntax for maps and collections.