quickfix

Class Message

java.lang.Object

quickfix.FieldMap

quickfix.Message

All Implemented Interfaces:

Serializable, Iterable<Field<?>>

public class Message
extends FieldMap

Represents a FIX message.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Message.Header
static class	Message.Trailer

Field Summary

Fields

Modifier and Type	Field and Description
protected Message.Header	header
protected Message.Trailer	trailer

Fields inherited from class quickfix.FieldMap

fields, groups

Constructor Summary

Constructors

Modifier	Constructor and Description
	Message()
protected	Message(int[] fieldOrder)
	Message(String string)
	Message(String string, boolean validate)
	Message(String string, DataDictionary dd)
	Message(String string, DataDictionary sessionDictionary, DataDictionary applicationDictionary, ValidationSettings validationSettings, boolean validate)
	Message(String string, DataDictionary dd, ValidationSettings dds)
	Message(String string, DataDictionary dd, ValidationSettings dds, boolean validate)

Method Summary

Modifier and Type	Method and Description
int	bodyLength()
void	clear()
Object	clone()
void	fromString(String messageData, DataDictionary sessionDictionary, DataDictionary applicationDictionary, ValidationSettings validationSettings, boolean doValidation)
void	fromString(String messageData, DataDictionary sessionDictionary, DataDictionary applicationDictionary, ValidationSettings validationSettings, boolean doValidation, boolean validateChecksum)
void	fromString(String messageData, DataDictionary dd, ValidationSettings validationSettings, boolean doValidation)
void	fromString(String messageData, DataDictionary dd, ValidationSettings dds, boolean doValidation, boolean validateChecksum)
FieldException	getException()
Message.Header	getHeader()
Message.Trailer	getTrailer()
void	headerAddGroup(Group group)
Group	headerGetGroup(int num, Group group)
boolean	headerHasGroup(Group group)
boolean	headerHasGroup(int field)
boolean	headerHasGroup(int num, Group group)
boolean	headerHasGroup(int num, int field)
void	headerRemoveGroup(Group group)
void	headerReplaceGroup(int num, Group group)
static MsgType	identifyType(String message) Returns the msg type specified in a FIX message string.
static boolean	InitializeXML(String url)
boolean	isAdmin()
boolean	isApp()
boolean	isEmpty()
protected Message.Header	newHeader()
void	pushBack(StringField field)
void	reset()
void	reverseRoute(Message.Header header)
String	toRawString() Return the raw message data as it was passed to the Message class.
String	toString() Do not call this method concurrently while modifying the contents of the message.
String	toXML() Converts the message into a simple XML format.
String	toXML(boolean indent) Converts the message into a simple XML format.
String	toXML(DataDictionary dataDictionary) Converts the message into a simple XML format.
String	toXML(DataDictionary dataDictionary, boolean indent) Converts the message into a simple XML format.
void	trailerAddGroup(Group group)
Group	trailerGetGroup(int num, Group group)
boolean	trailerHasGroup(Group group)
boolean	trailerHasGroup(int field)
boolean	trailerHasGroup(int num, Group group)
boolean	trailerHasGroup(int num, int field)
void	trailerRemoveGroup(Group group)
void	trailerReplaceGroup(int num, Group group)

Methods inherited from class quickfix.FieldMap

addGroup, addGroupRef, calculateString, getBoolean, getChar, getChars, getComponent, getDecimal, getDouble, getField, getField, getField, getField, getField, getField, getField, getField, getField, getField, getFieldOrder, getGroup, getGroup, getGroupCount, getGroups, getInt, getOptionalDecimal, getOptionalString, getString, getUtcDateOnly, getUtcTimeOnly, getUtcTimeStamp, groupKeyIterator, groupKeys, hasGroup, hasGroup, hasGroup, hasGroup, indexOf, initializeFrom, isSetField, isSetField, iterator, removeField, removeGroup, removeGroup, removeGroup, removeGroup, replaceGroup, setBoolean, setBytes, setChar, setChars, setComponent, setDecimal, setDecimal, setDouble, setDouble, setField, setField, setField, setField, setField, setField, setField, setField, setField, setField, setField, setFields, setGroupCount, setGroups, setGroups, setInt, setString, setUtcDateOnly, setUtcTimeOnly, setUtcTimeOnly, setUtcTimeOnly, setUtcTimeStamp, setUtcTimeStamp, setUtcTimeStamp

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Detail

header

protected Message.Header header

trailer

protected Message.Trailer trailer

Constructor Detail

Message

public Message()

Message

protected Message(int[] fieldOrder)

Message

public Message(String string)
        throws InvalidMessage

Throws:

InvalidMessage

Message

public Message(String string,
               boolean validate)
        throws InvalidMessage

Throws:

InvalidMessage

Message

public Message(String string,
               DataDictionary dd)
        throws InvalidMessage

Throws:

InvalidMessage

Message

public Message(String string,
               DataDictionary dd,
               ValidationSettings dds)
        throws InvalidMessage

Throws:

InvalidMessage

Message

public Message(String string,
               DataDictionary dd,
               ValidationSettings dds,
               boolean validate)
        throws InvalidMessage

Throws:

InvalidMessage

Message

public Message(String string,
               DataDictionary sessionDictionary,
               DataDictionary applicationDictionary,
               ValidationSettings validationSettings,
               boolean validate)
        throws InvalidMessage

Throws:

InvalidMessage

Method Detail

newHeader

protected Message.Header newHeader()

InitializeXML

public static boolean InitializeXML(String url)

clone

public Object clone()

Overrides:

clone in class Object

toString

public String toString()

Do not call this method concurrently while modifying the contents of the message. This is likely to produce unexpected results or will fail with a ConcurrentModificationException since FieldMap.calculateString() is iterating over the TreeMap of fields. Use toRawString() to get the raw message data.

Overrides:

toString in class Object

Returns:

Message as String with calculated body length and checksum.

toRawString

public String toRawString()

Return the raw message data as it was passed to the Message class. This is only available after Message has been parsed via constructor or Message.fromString(). Otherwise this method will return NULL. This method neither does change fields nor calculate body length or checksum. Use toString() for that purpose.

Returns:

Message as String without recalculating body length and checksum.

bodyLength

public int bodyLength()

headerAddGroup

public void headerAddGroup(Group group)

headerReplaceGroup

public void headerReplaceGroup(int num,
                               Group group)

headerGetGroup

public Group headerGetGroup(int num,
                            Group group)
                     throws FieldNotFound

Throws:

FieldNotFound

headerRemoveGroup

public void headerRemoveGroup(Group group)

headerHasGroup

public boolean headerHasGroup(int field)

headerHasGroup

public boolean headerHasGroup(int num,
                              int field)

headerHasGroup

public boolean headerHasGroup(int num,
                              Group group)

headerHasGroup

public boolean headerHasGroup(Group group)

trailerAddGroup

public void trailerAddGroup(Group group)

trailerGetGroup

public Group trailerGetGroup(int num,
                             Group group)
                      throws FieldNotFound

Throws:

FieldNotFound

trailerReplaceGroup

public void trailerReplaceGroup(int num,
                                Group group)

trailerRemoveGroup

public void trailerRemoveGroup(Group group)

trailerHasGroup

public boolean trailerHasGroup(int field)

trailerHasGroup

public boolean trailerHasGroup(int num,
                               int field)

trailerHasGroup

public boolean trailerHasGroup(int num,
                               Group group)

trailerHasGroup

public boolean trailerHasGroup(Group group)

toXML

public String toXML()

Converts the message into a simple XML format. This format is probably not sufficient for production use, but is more intended for diagnostics and debugging. THIS IS NOT FIXML. To get names instead of tag number, use toXML(DataDictionary) instead.

Returns:

an XML representation of the message.

See Also:

toXML(DataDictionary)

toXML

public String toXML(boolean indent)

Converts the message into a simple XML format. This format is probably not sufficient for production use, but is more intended for diagnostics and debugging. THIS IS NOT FIXML. To get names instead of tag number, use toXML(DataDictionary, boolean) instead.

Parameters:

indent - specifies whether the Transformer may add additional whitespace when outputting the result tree

Returns:

an XML representation of the message.

See Also:

toXML(DataDictionary, boolean)

toXML

public String toXML(DataDictionary dataDictionary)

Converts the message into a simple XML format. This format is probably not sufficient for production use, but is more intended for diagnostics and debugging. THIS IS NOT FIXML.

Parameters:

dataDictionary -

Returns:

the XML representation of the message

toXML

public String toXML(DataDictionary dataDictionary,
                    boolean indent)

Converts the message into a simple XML format. This format is probably not sufficient for production use, but is more intended for diagnostics and debugging. THIS IS NOT FIXML.

Parameters:

indent - specifies whether the Transformer may add additional whitespace when outputting the result tree

dataDictionary -

Returns:

the XML representation of the message

getHeader

public Message.Header getHeader()

getTrailer

public final Message.Trailer getTrailer()

isAdmin

public boolean isAdmin()

isApp

public boolean isApp()

isEmpty

public boolean isEmpty()

Overrides:

isEmpty in class FieldMap

clear

public void clear()

Overrides:

clear in class FieldMap

reset

public void reset()

Overrides:

reset in class FieldMap

reverseRoute

public void reverseRoute(Message.Header header)
                  throws FieldNotFound

Throws:

FieldNotFound

fromString

public void fromString(String messageData,
                       DataDictionary dd,
                       ValidationSettings validationSettings,
                       boolean doValidation)
                throws InvalidMessage

Throws:

InvalidMessage

fromString

public void fromString(String messageData,
                       DataDictionary dd,
                       ValidationSettings dds,
                       boolean doValidation,
                       boolean validateChecksum)
                throws InvalidMessage

Throws:

InvalidMessage

fromString

public void fromString(String messageData,
                       DataDictionary sessionDictionary,
                       DataDictionary applicationDictionary,
                       ValidationSettings validationSettings,
                       boolean doValidation)
                throws InvalidMessage

Throws:

InvalidMessage

fromString

public void fromString(String messageData,
                       DataDictionary sessionDictionary,
                       DataDictionary applicationDictionary,
                       ValidationSettings validationSettings,
                       boolean doValidation,
                       boolean validateChecksum)
                throws InvalidMessage

Throws:

InvalidMessage

pushBack

public void pushBack(StringField field)

getException

public FieldException getException()

identifyType

public static MsgType identifyType(String message)
                            throws MessageParseError

Returns the msg type specified in a FIX message string.

Parameters:

message - the FIX message string

Returns:

the message type

Throws:

MessageParseError - (QF JNI compatibility)