FixMessage (Java FIX Engine Package 2.13.5 API)

All Known Implementing Classes:

FixFlatMessage, FixStructuredMessage
```
public interface FixMessage
```
FixMessage mainly used for caching fields values which are frequently used by the engine.

Method Summary

All Methods Instance Methods Abstract 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.
`void`	`validate(int inboundMsgValidFlags)` Validates the fix message according to the given validation flags.

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

Interface FixMessage

Method Summary

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