biz.onixs.sbe

Class ByteDecoder

java.lang.Object

biz.onixs.sbe.ByteDecoder

public abstract class ByteDecoder
extends Object

Base for decoder implementation.

Constructor Summary

Constructors

Constructor and Description
ByteDecoder()

Method Summary

Modifier and Type	Method and Description
abstract Object	createEmptyComposite(String sbeCompositeTypeName, Object ref) Creates or fills empty instance of the class that represents standard composite type.
abstract <T> T	createEmptyCustomComposite(Class<T> cls) Creates empty instance of the class that implements given custom composite interface.
abstract IMessage	decode(byte[] data, int offset, int size) This function does the following: 1.
abstract IMessage	decodePreCreatedMessage(byte[] data, int offset, int size) This function does the following: 1.
abstract IMessage	encode(byte[] data, int offset, int size, int templateId) This function does the following: 1.
abstract IMessage	encodePreCreatedMessage(byte[] data, int offset, int size, int templateId) This function does the following: 1.
abstract boolean	isNullComposite(String sbeCompositeTypeName, Object ref) Checks the object of the standard composite type if it is null.

Methods inherited from class java.lang.Object

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

Constructor Detail

ByteDecoder

public ByteDecoder()

Method Detail

decode

public abstract IMessage decode(byte[] data,
                                int offset,
                                int size)

This function does the following: 1. Loads header of the message. if header size field > size then returns null: can't read the message 2. Uses generated code my messageHeader to read messageHeader 3. Creates message template 4. Points this template to data buffer 5. Returns message template

Parameters:

data - - byte buffer with data

offset - - start offset of the message.

size - available data in buffer to decode.

Returns:

decoded message or null if not enough data or message cannot be decoded

decodePreCreatedMessage

public abstract IMessage decodePreCreatedMessage(byte[] data,
                                                 int offset,
                                                 int size)

This function does the following: 1. Loads header of the message. if header size field > size then returns null: can't read the message 2. Uses generated code my messageHeader to read messageHeader 3. Selects right message template (templates are already created) 4. Points this template to data buffer 5. Returns message template WARNING: in next call of this method, returned message object can be reused. If you need to use returned message in another thread, please clone it or use decode method.

Parameters:

data - - byte buffer with data

offset - - start offset of the message.

size - available data in buffer to decode.

Returns:

decoded message or null if not enough data or message cannot be decoded

encode

public abstract IMessage encode(byte[] data,
                                int offset,
                                int size,
                                int templateId)

This function does the following: 1. Creates message template 1. Set up message header fields. 2. Initialize empty repeating groups.

Parameters:

data - - byte buffer with data

offset - - start offset of the message.

size - available data in buffer to decode.

templateId - message template id.

Returns:

decoded message or null if not enough data or message cannot be decoded

encodePreCreatedMessage

public abstract IMessage encodePreCreatedMessage(byte[] data,
                                                 int offset,
                                                 int size,
                                                 int templateId)

This function does the following: 1. Selects right message template (templates are already created). 2. Set up message header fields. 3. Initialize empty repeating groups. WARNING: in next call of this method, returned message object can be reused. If you need to use returned message in another thread, please clone it or use decode method.

Parameters:

data - - byte buffer with data

offset - - start offset of the message.

size - available data in buffer to decode.

templateId - message template id.

Returns:

decoded message or null if not enough data or message cannot be decoded

createEmptyCustomComposite

public abstract <T> T createEmptyCustomComposite(Class<T> cls)

Creates empty instance of the class that implements given custom composite interface. This interface must be provided to the ByteDecoderFactory.create(MessageSchema, Class[]) method when the decoder was created.

Type Parameters:

T - Class of the custom composite.

Parameters:

cls - Class of the custom composite.

Returns:

New instance of the object.

createEmptyComposite

public abstract Object createEmptyComposite(String sbeCompositeTypeName,
                                            Object ref)

Creates or fills empty instance of the class that represents standard composite type. The result object will be created if ref == null. When ref != null a new object is not created but the input object is filled with the default values. The result type can be selected by its name if the ref == null. Otherwise, type of the ref parameter must correspond to the SBE composite type: ScaledDecimal to the decimal kind of type, etc. The returned value contains null value for the given type if this type provides such ability. When the type has no optional fields, the returned object

Parameters:

sbeCompositeTypeName - Name of the type as it mentioned in the SBE template.

ref - Object of suitable standard composite type to fill with null value, or null/

Returns:

New instance of the object if ref == null or the original ref.

isNullComposite

public abstract boolean isNullComposite(String sbeCompositeTypeName,
                                        Object ref)

Checks the object of the standard composite type if it is null.

Parameters:

sbeCompositeTypeName - SBE type name that is used to check content of the object.

ref - Object to check.

Returns:

Result of the checking: true if the object is null data, false - otherwise.