biz.onixs.sbe

Class Message

java.lang.Object

biz.onixs.sbe.Message

All Implemented Interfaces:

IFieldSet, IMessage, Cloneable

public abstract class Message
extends Object
implements IMessage

Base class for the FIX message.

Exact implementation of the class is generated on the base of the SBE template.

Field Summary

Fields inherited from interface biz.onixs.sbe.IFieldSet

DefaultSeparator

Constructor Summary

Constructors

Constructor and Description
Message() Constructor.

Method Summary

Modifier and Type	Method and Description
IMessage	clone() Creates a copy of the message instance, including part of underlying byte array with message data.
ScaledDecimal	createNullDecimal(int tag, ScaledDecimal ref) Create null value for the given field.
MonthYear	createNullMonthYear(int tag, MonthYear ref) Creates null MonthYear object.
SbeTimestamp	createNullTimestamp(int tag, SbeTimestamp ref) Creates null MonthYear object.
int	getBinarySize() Size of the message/
boolean	getBoolean(int tag) Gets field value by tag.
byte[]	getBuffer() Binary data of the message.
char	getChar(int tag) Gets field value by tag.
<T> T	getCustomComposite(int tag, T ref) Gets custom composite field value by tag.
ScaledDecimal	getDecimal(int tag) Gets field value by tag.
int	getDynamicOffset() Offset of dynamic part of hte message.
MonthYear	getMonthYear(int tag) Gets date field value by tag.
abstract int	getMsgSize() Gets message size.
int	getOffset() Offset on the binary buffer.
IFieldSet	getParent() Returns field set parent.
SbeTimestamp	getTimestamp(int tag)
BigInteger	getUnsignedLong(int tag) Gets field value by tag.
int	getVersion()
boolean	isNullDecimal(int tag, ScaledDecimal value) Checks if the value represents null for the field with the given tag.
boolean	isNullMonthYear(int tag, MonthYear value) Checks if the value represents null for the field with the given tag.
boolean	isNullTimestamp(int tag, SbeTimestamp value) Checks if the value represents null for the field with the given tag.
void	notifyBufferUpdate(byte[] data, int pointOfModify, int sizeDelta) Internally-used method.
abstract void	notifyFieldSetBufferUpdate(byte[] data, int pointOfModify, int sizeDelta)
void	setBoolean(int tag, boolean value) Sets field value by tag.
void	setByte(int tag, int value) Sets field value by tag.
void	setChar(int tag, char value) Sets field value by tag.
<T> void	setCustomComposite(int tag, T value) Sets field value by tag.
void	setShort(int tag, int value) Sets field value by tag.
void	setUnsignedLong(int tag, BigInteger value) Sets field value by tag.
String	toFixString(char separator) String representation of the SBE message in FIX-compliant format.
String	toString()
String	toString(char separator, boolean useTagNames) String reresentation of the FIX message.
<T> boolean	tryGetCustomComposite(int tag, T ref) Tries to get composite field value by tag.
BigInteger	tryGetUnsignedLong(int tag) Gets field value by tag.

Methods inherited from class java.lang.Object

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

Methods inherited from interface biz.onixs.sbe.IMessage

getFixedBlockLength, getMessageHeader, getMessageName, getSemanticType, getTemplateId, getVersion, load

Methods inherited from interface biz.onixs.sbe.IFieldSet

contains, createEmptyStandardComposite, createNullDecimal, createNullMonthYear, createNullTimestamp, dataTags, fieldTags, getBoolean, getByte, getBytes, getChar, getCustomComposite, getDecimal, getDecimal, getGroup, getInt, getLong, getMonthYear, getMonthYear, getParent, getShort, getStatelessComposite, getString, getTimestamp, getTimestamp, getUnsignedByte, getUnsignedInt, getUnsignedLong, getUnsignedShort, getValuePtr, getVarData, groupTags, hasFieldTag, hasGroupTag, hasTag, hasVarDataTag, init, isNullDecimal, isNullMonthYear, isNullStandardComposite, isNullTimestamp, load, reset, setBoolean, setByte, setByte, setBytes, setChar, setCustomComposite, setDecimal, setInt, setLong, setMonthYear, setShort, setShort, setString, setTimestamp, setUnsignedByte, setUnsignedByte, setUnsignedInt, setUnsignedLong, setUnsignedShort, setVarData, tagName, tryGetBoolean, tryGetByte, tryGetBytes, tryGetChar, tryGetCustomComposite, tryGetDecimal, tryGetGroup, tryGetInt, tryGetLong, tryGetMonthYear, tryGetShort, tryGetString, tryGetTimestamp, tryGetUnsignedByte, tryGetUnsignedInt, tryGetUnsignedLong, tryGetUnsignedShort, tryGetValuePtr, tryGetVarData

Constructor Detail

Message

public Message()

Constructor.

Method Detail

getBinarySize

public int getBinarySize()

Size of the message/

Specified by:

getBinarySize in interface IMessage

Returns:

Size of the SBE message.

getOffset

public int getOffset()

Offset on the binary buffer.

Specified by:

getOffset in interface IMessage

Returns:

Offset of message begin in the binary buffer.

getBuffer

public byte[] getBuffer()

Binary data of the message.

Specified by:

getBuffer in interface IMessage

Returns:

Binary buffer where the message is composed or parsed from.

getMsgSize

public abstract int getMsgSize()

Gets message size.

Specified by:

getMsgSize in interface IMessage

Returns:

message size.

toFixString

public String toFixString(char separator)

String representation of the SBE message in FIX-compliant format.

Specified by:

toFixString in interface IFieldSet

Parameters:

separator - for fields

Returns:

String representation of the SBE message in the FIX-compliant format: tag=value pair for each field with the provided separator between fields.

toString

public String toString(char separator,
                       boolean useTagNames)

String reresentation of the FIX message.

Specified by:

toString in interface IFieldSet

Parameters:

separator - for fields.

useTagNames - true to use tag names, false - to use tag identifiers.

Returns:

String representation of the message.

getDynamicOffset

public int getDynamicOffset()

Offset of dynamic part of hte message.

Specified by:

getDynamicOffset in interface IMessage

Returns:

Offset of the data behind of the fixed-size block of the message.

clone

public IMessage clone()

Creates a copy of the message instance, including part of underlying byte array with message data.

Specified by:

clone in interface IMessage

Overrides:

clone in class Object

Returns:

a copy of the message.

notifyBufferUpdate

public void notifyBufferUpdate(byte[] data,
                               int pointOfModify,
                               int sizeDelta)

Internally-used method.

This method used internally and is a subject for update in further releases without special notifications.

Parameters:

data - Data.

pointOfModify - Starting point of the modification.

sizeDelta - Size delta.

getParent

public IFieldSet getParent()

Description copied from interface: IFieldSet

Returns field set parent. For Message always returns null; For message's groups returns Message instance For sub-groups returns their owner.

Specified by:

getParent in interface IFieldSet

Returns:

parent of the field set

setBoolean

public void setBoolean(int tag,
                       boolean value)

Description copied from interface: IFieldSet

Sets field value by tag. Executes only for fields, which are able to contain boolean type (up to 1 byte).

Specified by:

setBoolean in interface IFieldSet

Parameters:

tag - - integer tag id of the field.

value - - value of the field.

getBoolean

public boolean getBoolean(int tag)

Description copied from interface: IFieldSet

Gets field value by tag. Returns only fields, which are able to fit into boolean type (up to 1 byte).

Specified by:

getBoolean in interface IFieldSet

Parameters:

tag - - integer tag id of the field.

Returns:

boolean value of the field

setChar

public void setChar(int tag,
                    char value)

Description copied from interface: IFieldSet

Sets field value by tag. Executes only for fields, which are able to contain char type (up to 1 byte).

Specified by:

setChar in interface IFieldSet

Parameters:

tag - - integer tag id of the field.

value - - value of the field.

getChar

public char getChar(int tag)

Description copied from interface: IFieldSet

Gets field value by tag. Returns only fields, which are able to fit into char type (up to 1 byte).

Specified by:

getChar in interface IFieldSet

Parameters:

tag - - integer tag id of the field.

Returns:

char value of the field

setByte

public void setByte(int tag,
                    int value)

Description copied from interface: IFieldSet

Sets field value by tag. Executes only for fields, which are able to contain byte type (up to 1 byte).

Specified by:

setByte in interface IFieldSet

Parameters:

tag - - integer tag id of the field.

value - - value of the field.

setShort

public void setShort(int tag,
                     int value)

Description copied from interface: IFieldSet

Sets field value by tag. Executes only for fields, which are able to contain short type (up to 2 bytes).

Specified by:

setShort in interface IFieldSet

Parameters:

tag - - integer tag id of the field.

value - - value of the field.

getUnsignedLong

public BigInteger getUnsignedLong(int tag)

Description copied from interface: IFieldSet

Gets field value by tag. Returns only fields, which are able to fit into long type (up to 8 bytes). Creates new BigInteger object.

Specified by:

getUnsignedLong in interface IFieldSet

Parameters:

tag - - integer tag id of the field.

Returns:

long value of the field

tryGetUnsignedLong

public BigInteger tryGetUnsignedLong(int tag)

Description copied from interface: IFieldSet

Gets field value by tag. Returns only fields, which are able to fit into unsigned long type (up to 8 bytes). Creates new BigInteger object.

Specified by:

tryGetUnsignedLong in interface IFieldSet

Parameters:

tag - - integer tag id of the field

Returns:

null if tag is absent, or is optional and has NULL value, or cannot be casted to unsigned long type. Otherwise, returns unsigned long representation of the field

setUnsignedLong

public void setUnsignedLong(int tag,
                            BigInteger value)

Description copied from interface: IFieldSet

Sets field value by tag. Executes only for fields, which are able to contain unsigned long type (up to 8 bytes).

Specified by:

setUnsignedLong in interface IFieldSet

Parameters:

tag - - integer tag id of the field.

value - - value of the field.

getDecimal

public ScaledDecimal getDecimal(int tag)

Description copied from interface: IFieldSet

Gets field value by tag. Returns only fields, which are able to fit into ScaledDecimal. Creates new ScaledDecimal object.

Specified by:

getDecimal in interface IFieldSet

Parameters:

tag - - integer tag id of the field.

Returns:

ScaledDecimal representation of the field

getMonthYear

public MonthYear getMonthYear(int tag)

Description copied from interface: IFieldSet

Gets date field value by tag. Creates new MonthYear object.

Specified by:

getMonthYear in interface IFieldSet

Parameters:

tag - - integer tag id of the field.

Returns:

MonthYear representation of the field.

getVersion

public int getVersion()

getTimestamp

public SbeTimestamp getTimestamp(int tag)

Specified by:

getTimestamp in interface IFieldSet

toString

public String toString()

Overrides:

toString in class Object

createNullDecimal

public ScaledDecimal createNullDecimal(int tag,
                                       ScaledDecimal ref)

Description copied from interface: IFieldSet

Create null value for the given field.

Specified by:

createNullDecimal in interface IFieldSet

Parameters:

tag - Tag of the field which null value is requested.

ref - Object to fill (optional)

Returns:

Input object

isNullDecimal

public boolean isNullDecimal(int tag,
                             ScaledDecimal value)

Description copied from interface: IFieldSet

Checks if the value represents null for the field with the given tag.

Specified by:

isNullDecimal in interface IFieldSet

Parameters:

tag - Tag of the field.

value - Value to check.

Returns:

true if the value means null for the given field.

createNullMonthYear

public MonthYear createNullMonthYear(int tag,
                                     MonthYear ref)

Description copied from interface: IFieldSet

Creates null MonthYear object.

Specified by:

createNullMonthYear in interface IFieldSet

Parameters:

tag - field of the MonthYear type.

ref - object to fill with null data.

Returns:

input object filled by null data.

isNullMonthYear

public boolean isNullMonthYear(int tag,
                               MonthYear value)

Description copied from interface: IFieldSet

Checks if the value represents null for the field with the given tag.

Specified by:

isNullMonthYear in interface IFieldSet

Parameters:

tag - Tag of the field.

value - Value to check.

Returns:

true if the value means null for the given field.

createNullTimestamp

public SbeTimestamp createNullTimestamp(int tag,
                                        SbeTimestamp ref)

Description copied from interface: IFieldSet

Creates null MonthYear object.

Specified by:

createNullTimestamp in interface IFieldSet

Parameters:

tag - field of the MonthYear type.

ref - object to fill with null data.

Returns:

input object filled by null data.

isNullTimestamp

public boolean isNullTimestamp(int tag,
                               SbeTimestamp value)

Description copied from interface: IFieldSet

Checks if the value represents null for the field with the given tag.

Specified by:

isNullTimestamp in interface IFieldSet

Parameters:

tag - Tag of the field.

value - Value to check.

Returns:

true if the value means null for the given field.

getCustomComposite

public <T> T getCustomComposite(int tag,
                                T ref)

Description copied from interface: IFieldSet

Gets custom composite field value by tag. Fills object passed via ref argument.

Specified by:

getCustomComposite in interface IFieldSet

Type Parameters:

T - Type of the custom composite.

Parameters:

tag - Tag of teh field

ref - Custom composite object to fill.

Returns:

The ref value.

tryGetCustomComposite

public <T> boolean tryGetCustomComposite(int tag,
                                         T ref)

Description copied from interface: IFieldSet

Tries to get composite field value by tag. Fills passed object.

Specified by:

tryGetCustomComposite in interface IFieldSet

Type Parameters:

T - Type of the custom composite

Parameters:

tag - Integer tag id of the field.

ref - Variable to store the field value. ref cannot be null. Value of ref will be rewritten.

Returns:

false if tag is absent, or is optional and has NULL value or cannot be cast to ScaledDecimal type.

setCustomComposite

public <T> void setCustomComposite(int tag,
                                   T value)

Description copied from interface: IFieldSet

Sets field value by tag. Executes only for fields, which are able to contain the custom composite type.

Specified by:

setCustomComposite in interface IFieldSet

Type Parameters:

T - Type of the custom composite

Parameters:

tag - Integer tag id of the field.

value - Value of the field.

notifyFieldSetBufferUpdate

public abstract void notifyFieldSetBufferUpdate(byte[] data,
                                                int pointOfModify,
                                                int sizeDelta)