com.netflix.msl.io

Class DefaultMslEncoderFactory

java.lang.Object

com.netflix.msl.io.MslEncoderFactory

com.netflix.msl.io.DefaultMslEncoderFactory

public class DefaultMslEncoderFactory
extends MslEncoderFactory

Default MslEncoderFactory implementation that supports the following encoder formats:

• JSON: backed by org.json.

Constructor Summary

Constructors

Constructor and Description
DefaultMslEncoderFactory()

Method Summary

Modifier and Type	Method and Description
byte[]	encodeObject(MslObject object, MslEncoderFormat format) Encode a MslObject into the specified encoder format.
protected MslTokenizer	generateTokenizer(java.io.InputStream source, MslEncoderFormat format) Create a new MslTokenizer of the specified encoder format.
MslEncoderFormat	getPreferredFormat(java.util.Set<MslEncoderFormat> formats) Returns the most preferred encoder format from the provided set of formats.
MslObject	parseObject(byte[] encoding) Parse a MslObject from encoded data.

Methods inherited from class com.netflix.msl.io.MslEncoderFactory

createArray, createArray, createObject, createObject, createTokenizer, parseFormat

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultMslEncoderFactory

public DefaultMslEncoderFactory()

Method Detail

getPreferredFormat

public MslEncoderFormat getPreferredFormat(java.util.Set<MslEncoderFormat> formats)

Description copied from class: MslEncoderFactory

Returns the most preferred encoder format from the provided set of formats.

Specified by:

getPreferredFormat in class MslEncoderFactory

Parameters:

formats - the set of formats to choose from. May be null or empty.

Returns:

the preferred format from the provided set or the default format if format set is null or empty.

generateTokenizer

protected MslTokenizer generateTokenizer(java.io.InputStream source,
                                         MslEncoderFormat format)
                                  throws MslEncoderException

Description copied from class: MslEncoderFactory

Create a new MslTokenizer of the specified encoder format.

Specified by:

generateTokenizer in class MslEncoderFactory

Parameters:

source - the binary data to tokenize.

format - the encoder format.

Returns:

the MslTokenizer.

Throws:

MslEncoderException - if the encoder format is not supported.

parseObject

public MslObject parseObject(byte[] encoding)
                      throws MslEncoderException

Description copied from class: MslEncoderFactory

Parse a MslObject from encoded data. The encoder format will be determined by inspecting the byte stream identifier located in the first byte.

Specified by:

parseObject in class MslEncoderFactory

Parameters:

encoding - the encoded data to parse.

Returns:

the MslObject.

Throws:

MslEncoderException - if the encoder format is not supported or there is an error parsing the encoded data.

encodeObject

public byte[] encodeObject(MslObject object,
                           MslEncoderFormat format)
                    throws MslEncoderException

Description copied from class: MslEncoderFactory

Encode a MslObject into the specified encoder format.

Specified by:

encodeObject in class MslEncoderFactory

Parameters:

object - the MslObject to encode.

format - the encoder format.

Returns:

the encoded data.

Throws:

MslEncoderException - if the encoder format is not supported or there is an error encoding the object.