FixStructuredMessage (Java FIX Engine Package 2.13.5 API)

java.lang.Object
- biz.onixs.fix.parser.FixStructuredMessage

All Implemented Interfaces:: FixMessage

public class FixStructuredMessage
extends Object
implements FixMessage

FixMessage based on Message.

Constructor Summary

Constructors
Constructor and Description
`FixStructuredMessage(byte[] rawFixMsg, int length, int messageValidationFlags)` Parses raw message as `Message` and initializes frequently used fields values.
`FixStructuredMessage(Version version, byte[] rawFixMsg, int length, int messageValidationFlags)` Parses raw message as `Message` and initializes frequently used fields values.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`compareBeginString(byte[] value)` Returns true if the message contains BeginString(8) same as the specified value, false otherwise.
`boolean`	`compareSenderCompId(byte[] value)` Returns true if the message contains SenderCompID(49) same as the specified value, false otherwise.
`boolean`	`compareTargetCompId(byte[] value)` Returns true if the message contains TargetCompID(56) same as the specified value, false otherwise.
`boolean`	`compareTestReqID(ValuePtr testReqId)` Returns true if the message contains TestReqID(112) same as the specified value, false otherwise.
`FixMessage`	`copy()` Returns copy of the `FixMessage`.
`long`	`getBeginSeqNo()` Returns BeginSeqNo(7).
`String`	`getBeginString()` Returns BeginString(9)
`long`	`getEndSeqNo()` Returns EndSeqNo(16).
`FlatMessage`	`getFlatMessage()` Returns the `FlatMessage` object.
`int`	`getHeartBtInt()` Returns HeartBtInt(108).
`ValuePtr`	`getMsgType()` Returns MsgType(35).
`byte`	`getMsgTypeFirstByte()` Returns first byte of MsgType(35).
`long`	`getNewSeqNo()` Returns NewSeqNo(36).
`long`	`getNextExpectedMsgSeqNum()` Returns NextExpectedMsgSeqNum(789).
`String`	`getSenderCompID()` Returns SenderCompID(49).
`long`	`getSeqNum()` Returns MsgSeqNum(34).
`Message`	`getStructuredMessage(Version version)` Returns the `Message` object created based on internal `FlatMessage` object.
`String`	`getTargetCompID()` Returns TargetCompID(56).
`boolean`	`getTestReqID(ValuePtr testReqId)` Returns TestReqID(112).
`String`	`getText()` Returns Text(58).
`Version`	`getVersion()` Returns Fix version parsed from the message.
`boolean`	`hasBeginSeqNo()` Returns whether the message contains BeginSeqNo(7).
`boolean`	`hasEndSeqNo()` Returns whether the message contains EndSeqNo(16).
`boolean`	`hasGapFillFlag()` Returns whether the message contains GapFillFlag(123).
`boolean`	`hasHeartBtInt()` Returns whether the message contains HeartBtInt(108).
`boolean`	`hasNewSeqNo()` Returns whether the message contains NewSeqNo(36).
`boolean`	`hasNextExpectedMsgSeqNum()` Returns whether the message contains NextExpectedMsgSeqNum(789).
`boolean`	`hasResetSeqNumFlag()` Returns whether the message contains ResetSeqNumFlag(141).
`boolean`	`hasSenderCompID()` Returns whether the message contains SenderCompID(49).
`boolean`	`hasTargetCompID()` Returns whether the message contains TargetCompID(56).
`boolean`	`hasText()` Returns whether the message contains Text(58).
`boolean`	`isOriginal()` Returns whether the message is original or not.
`boolean`	`isSessionLevel()` Returns whether fix message is session level or not.
`void`	`reset(byte[] rawFixMsg, int length)` Resets the fix message with the given raw FIX message, allows to re-use internal data structures.
`String`	`toString()`
`void`	`validate(int inboundMsgValidFlags)` Validates the fix message according to the given validation flags.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - FixStructuredMessage
```
public FixStructuredMessage(byte[] rawFixMsg,
                            int length,
                            int messageValidationFlags)
```
    Parses raw message as Message and initializes frequently used fields values.
    
    Parameters:
    
    rawFixMsg - raw FIX message in the tag=value form
    
    length - raw FIX message length in bytes
    
    messageValidationFlags - message validation flags
  - FixStructuredMessage
```
public FixStructuredMessage(Version version,
                            byte[] rawFixMsg,
                            int length,
                            int messageValidationFlags)
```
    Parses raw message as Message and initializes frequently used fields values.
    
    Parameters:
    
    version - FIX version
    
    rawFixMsg - raw FIX message in the tag=value form
    
    length - raw FIX message length in bytes
    
    messageValidationFlags - message validation flags
- Method Detail
  - reset
```
public void reset(byte[] rawFixMsg,
                  int length)
```
    Description copied from interface: FixMessage
    
    Resets the fix message with the given raw FIX message, allows to re-use internal data structures.
    
    Specified by:
    
    reset in interface FixMessage
    
    Parameters:
    
    rawFixMsg - raw FIX message in the tag=value form
    
    length - raw FIX message length in bytes
  - validate
```
public void validate(int inboundMsgValidFlags)
```
    Description copied from interface: FixMessage
    
    Validates the fix message according to the given validation flags.
    
    Specified by:
    
    validate in interface FixMessage
    
    Parameters:
    
    inboundMsgValidFlags - validation flags MessageValidationFlags
  - copy
```
public FixMessage copy()
```
    Description copied from interface: FixMessage
    
    Returns copy of the FixMessage.
    
    Specified by:
    
    copy in interface FixMessage
    
    Returns:
    
    copy of the FixMessage.
  - getFlatMessage
```
public FlatMessage getFlatMessage()
```
    Description copied from interface: FixMessage
    
    Returns the FlatMessage object.
    
    Specified by:
    
    getFlatMessage in interface FixMessage
    
    Returns:
    
    the FlatMessage object.
  - getStructuredMessage
```
public Message getStructuredMessage(Version version)
```
    Description copied from interface: FixMessage
    
    Returns the Message object created based on internal FlatMessage object.
    
    Specified by:
    
    getStructuredMessage in interface FixMessage
    
    Parameters:
    
    version - FIX version
    
    Returns:
    
    the Message object.
  - isSessionLevel
```
public boolean isSessionLevel()
```
    Description copied from interface: FixMessage
    
    Returns whether fix message is session level or not.
    
    Specified by:
    
    isSessionLevel in interface FixMessage
    
    Returns:
    
    whether fix message is session level or not.
  - getMsgType
```
public ValuePtr getMsgType()
```
    Description copied from interface: FixMessage
    
    Returns MsgType(35).
    
    Specified by:
    
    getMsgType in interface FixMessage
    
    Returns:
    
    MsgType(35).
  - getMsgTypeFirstByte
```
public byte getMsgTypeFirstByte()
```
    Description copied from interface: FixMessage
    
    Returns first byte of MsgType(35).
    
    Specified by:
    
    getMsgTypeFirstByte in interface FixMessage
    
    Returns:
    
    first byte of MsgType(35).
  - getSeqNum
```
public long getSeqNum()
```
    Description copied from interface: FixMessage
    
    Returns MsgSeqNum(34).
    
    Specified by:
    
    getSeqNum in interface FixMessage
    
    Returns:
    
    MsgSeqNum(34).
  - isOriginal
```
public boolean isOriginal()
```
    Description copied from interface: FixMessage
    
    Returns whether the message is original or not.
    
    Specified by:
    
    isOriginal in interface FixMessage
    
    Returns:
    
    whether the message is original or not.
  - compareBeginString
```
public boolean compareBeginString(byte[] value)
```
    Description copied from interface: FixMessage
    
    Returns true if the message contains BeginString(8) same as the specified value, false otherwise.
    
    Specified by:
    
    compareBeginString in interface FixMessage
    
    Parameters:
    
    value - expected BeginString(8)
    
    Returns:
    
    true if the message contains BeginString(8) same as the specified value, false otherwise.
  - getBeginString
```
public String getBeginString()
```
    Description copied from interface: FixMessage
    
    Returns BeginString(9)
    
    Specified by:
    
    getBeginString in interface FixMessage
    
    Returns:
    
    BeginString(9)
  - hasSenderCompID
```
public boolean hasSenderCompID()
```
    Description copied from interface: FixMessage
    
    Returns whether the message contains SenderCompID(49).
    
    Specified by:
    
    hasSenderCompID in interface FixMessage
    
    Returns:
    
    whether the message contains SenderCompID(49).
  - compareSenderCompId
```
public boolean compareSenderCompId(byte[] value)
```
    Description copied from interface: FixMessage
    
    Returns true if the message contains SenderCompID(49) same as the specified value, false otherwise.
    
    Specified by:
    
    compareSenderCompId in interface FixMessage
    
    Parameters:
    
    value - expected SenderCompID(49)
    
    Returns:
    
    true if the message contains SenderCompID(49) same as the specified value, false otherwise.
  - getSenderCompID
```
public String getSenderCompID()
```
    Description copied from interface: FixMessage
    
    Returns SenderCompID(49).
    
    Specified by:
    
    getSenderCompID in interface FixMessage
    
    Returns:
    
    SenderCompID(49).
  - hasTargetCompID
```
public boolean hasTargetCompID()
```
    Description copied from interface: FixMessage
    
    Returns whether the message contains TargetCompID(56).
    
    Specified by:
    
    hasTargetCompID in interface FixMessage
    
    Returns:
    
    whether the message contains TargetCompID(56).
  - compareTargetCompId
```
public boolean compareTargetCompId(byte[] value)
```
    Description copied from interface: FixMessage
    
    Returns true if the message contains TargetCompID(56) same as the specified value, false otherwise.
    
    Specified by:
    
    compareTargetCompId in interface FixMessage
    
    Parameters:
    
    value - expected TargetCompID(56)
    
    Returns:
    
    true if the message contains TargetCompID(56) same as the specified value, false otherwise.
  - getTargetCompID
```
public String getTargetCompID()
```
    Description copied from interface: FixMessage
    
    Returns TargetCompID(56).
    
    Specified by:
    
    getTargetCompID in interface FixMessage
    
    Returns:
    
    TargetCompID(56).
  - getTestReqID
```
public boolean getTestReqID(ValuePtr testReqId)
```
    Description copied from interface: FixMessage
    
    Returns TestReqID(112).
    
    Specified by:
    
    getTestReqID in interface FixMessage
    
    Parameters:
    
    testReqId - field value reference to be filled
    
    Returns:
    
    true in case the field is found, false otherwise.
  - compareTestReqID
```
public boolean compareTestReqID(ValuePtr testReqId)
```
    Description copied from interface: FixMessage
    
    Returns true if the message contains TestReqID(112) same as the specified value, false otherwise.
    
    Specified by:
    
    compareTestReqID in interface FixMessage
    
    Parameters:
    
    testReqId - expected TargetCompID(56)
    
    Returns:
    
    true if the message contains TestReqID(112) same as the specified value, false otherwise.
  - hasHeartBtInt
```
public boolean hasHeartBtInt()
```
    Description copied from interface: FixMessage
    
    Returns whether the message contains HeartBtInt(108).
    
    Specified by:
    
    hasHeartBtInt in interface FixMessage
    
    Returns:
    
    whether the message contains HeartBtInt(108).
  - getHeartBtInt
```
public int getHeartBtInt()
```
    Description copied from interface: FixMessage
    
    Returns HeartBtInt(108).
    
    Specified by:
    
    getHeartBtInt in interface FixMessage
    
    Returns:
    
    HeartBtInt(108).
  - hasNextExpectedMsgSeqNum
```
public boolean hasNextExpectedMsgSeqNum()
```
    Description copied from interface: FixMessage
    
    Returns whether the message contains NextExpectedMsgSeqNum(789).
    
    Specified by:
    
    hasNextExpectedMsgSeqNum in interface FixMessage
    
    Returns:
    
    whether the message contains NextExpectedMsgSeqNum(789).
  - getNextExpectedMsgSeqNum
```
public long getNextExpectedMsgSeqNum()
```
    Description copied from interface: FixMessage
    
    Returns NextExpectedMsgSeqNum(789).
    
    Specified by:
    
    getNextExpectedMsgSeqNum in interface FixMessage
    
    Returns:
    
    NextExpectedMsgSeqNum(789).
  - hasText
```
public boolean hasText()
```
    Description copied from interface: FixMessage
    
    Returns whether the message contains Text(58).
    
    Specified by:
    
    hasText in interface FixMessage
    
    Returns:
    
    whether the message contains Text(58).
  - getText
```
public String getText()
```
    Description copied from interface: FixMessage
    
    Returns Text(58).
    
    Specified by:
    
    getText in interface FixMessage
    
    Returns:
    
    Text(58).
  - hasBeginSeqNo
```
public boolean hasBeginSeqNo()
```
    Description copied from interface: FixMessage
    
    Returns whether the message contains BeginSeqNo(7).
    
    Specified by:
    
    hasBeginSeqNo in interface FixMessage
    
    Returns:
    
    whether the message contains BeginSeqNo(7).
  - getBeginSeqNo
```
public long getBeginSeqNo()
```
    Description copied from interface: FixMessage
    
    Returns BeginSeqNo(7).
    
    Specified by:
    
    getBeginSeqNo in interface FixMessage
    
    Returns:
    
    BeginSeqNo(7).
  - hasEndSeqNo
```
public boolean hasEndSeqNo()
```
    Description copied from interface: FixMessage
    
    Returns whether the message contains EndSeqNo(16).
    
    Specified by:
    
    hasEndSeqNo in interface FixMessage
    
    Returns:
    
    whether the message contains EndSeqNo(16).
  - getEndSeqNo
```
public long getEndSeqNo()
```
    Description copied from interface: FixMessage
    
    Returns EndSeqNo(16).
    
    Specified by:
    
    getEndSeqNo in interface FixMessage
    
    Returns:
    
    EndSeqNo(16).
  - hasNewSeqNo
```
public boolean hasNewSeqNo()
```
    Description copied from interface: FixMessage
    
    Returns whether the message contains NewSeqNo(36).
    
    Specified by:
    
    hasNewSeqNo in interface FixMessage
    
    Returns:
    
    whether the message contains NewSeqNo(36).
  - getNewSeqNo
```
public long getNewSeqNo()
```
    Description copied from interface: FixMessage
    
    Returns NewSeqNo(36).
    
    Specified by:
    
    getNewSeqNo in interface FixMessage
    
    Returns:
    
    NewSeqNo(36).
  - hasGapFillFlag
```
public boolean hasGapFillFlag()
```
    Description copied from interface: FixMessage
    
    Returns whether the message contains GapFillFlag(123).
    
    Specified by:
    
    hasGapFillFlag in interface FixMessage
    
    Returns:
    
    whether the message contains GapFillFlag(123).
  - hasResetSeqNumFlag
```
public boolean hasResetSeqNumFlag()
```
    Description copied from interface: FixMessage
    
    Returns whether the message contains ResetSeqNumFlag(141).
    
    Specified by:
    
    hasResetSeqNumFlag in interface FixMessage
    
    Returns:
    
    whether the message contains ResetSeqNumFlag(141).
  - getVersion
```
public Version getVersion()
```
    Description copied from interface: FixMessage
    
    Returns Fix version parsed from the message.
    Note: The engine must be initialized.
    
    Specified by:
    
    getVersion in interface FixMessage
    
    Returns:
    
    Fix version parsed from the message.
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class FixStructuredMessage

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

FixStructuredMessage

FixStructuredMessage

Method Detail

reset

validate

copy

getFlatMessage

getStructuredMessage

isSessionLevel

getMsgType

getMsgTypeFirstByte

getSeqNum

isOriginal

compareBeginString

getBeginString

hasSenderCompID

compareSenderCompId

getSenderCompID

hasTargetCompID

compareTargetCompId

getTargetCompID

getTestReqID

compareTestReqID

hasHeartBtInt

getHeartBtInt

hasNextExpectedMsgSeqNum

getNextExpectedMsgSeqNum

hasText

getText

hasBeginSeqNo

getBeginSeqNo

hasEndSeqNo

getEndSeqNo

hasNewSeqNo

getNewSeqNo

hasGapFillFlag

hasResetSeqNumFlag

getVersion

toString