biz.onixs.fix.parser

Class MessageDiff

java.lang.Object

biz.onixs.fix.parser.MessageDiff

public class MessageDiff
extends Object

Compares two FIX messages and reports the first difference.

The comparison checks message version, message type, field values and repeating groups. Use isSimilar() for a strict comparison, where repeating group instances must be in the same order, or isLogicallySimilar() when repeating group instance order should be ignored.

The comparison can be customized with a MessageDiffListener to ignore selected tag/value differences.

Field Summary

Fields

Modifier and Type	Field and Description
static String	NO_DIFF Returned when two messages are equal according to the strict comparison.
static String	NO_DIFF_LOGICALLY Returned when two messages are equal according to the logical comparison.
static String	UNKNOWN_ERROR Fallback description used when the comparison cannot classify the difference more precisely.

Constructor Summary

Constructors

Constructor and Description
MessageDiff(Message message1, Message message2) Creates a diff helper for the supplied messages.

Method Summary

Modifier and Type	Method and Description
MessageDiffListener	getDiffListener() Returns the listener used to ignore selected differences.
boolean	isLogicallySimilar() Compares the messages using the logical comparison mode.
static boolean	isLogicallySimilar(Message message1, Message message2) Compares the messages using the logical comparison mode.
boolean	isSimilar() Compares the messages using the strict comparison mode.
static boolean	isSimilar(Message message1, Message message2) Compares the messages using the strict comparison mode.
void	setDiffListener(MessageDiffListener diffListener) Sets the listener used to ignore selected differences.
String	toString() Returns the description of the last comparison result.

Methods inherited from class java.lang.Object

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

Field Detail

NO_DIFF

public static final String NO_DIFF

Returned when two messages are equal according to the strict comparison.

See Also:

Constant Field Values

NO_DIFF_LOGICALLY

public static final String NO_DIFF_LOGICALLY

Returned when two messages are equal according to the logical comparison.

See Also:

Constant Field Values

UNKNOWN_ERROR

public static final String UNKNOWN_ERROR

Fallback description used when the comparison cannot classify the difference more precisely.

See Also:

Constant Field Values

Constructor Detail

MessageDiff

public MessageDiff(Message message1,
                   Message message2)

Creates a diff helper for the supplied messages.

Parameters:

message1 - first message to compare

message2 - second message to compare

Throws:

NullPointerException - if message1 or message2 is null

Method Detail

getDiffListener

public MessageDiffListener getDiffListener()

Returns the listener used to ignore selected differences.

Returns:

current diff listener

setDiffListener

public void setDiffListener(MessageDiffListener diffListener)

Sets the listener used to ignore selected differences.

Parameters:

diffListener - listener to use

Throws:

NullPointerException - if diffListener is null

isSimilar

public boolean isSimilar()

Compares the messages using the strict comparison mode.

The strict comparison checks message version, message type, field values and repeating group instance order.

Returns:

true if the messages are strictly similar, false otherwise

isSimilar

public static boolean isSimilar(Message message1,
                                Message message2)

Compares the messages using the strict comparison mode.

Parameters:

message1 - first message to compare

message2 - second message to compare

Returns:

true if the messages are strictly similar, false otherwise

Throws:

NullPointerException - if message1 or message2 is null

isLogicallySimilar

public boolean isLogicallySimilar()

Compares the messages using the logical comparison mode.

The logical comparison ignores repeating group instance order and compares group contents by value.

Returns:

true if the messages are logically similar, false otherwise

isLogicallySimilar

public static boolean isLogicallySimilar(Message message1,
                                         Message message2)

Compares the messages using the logical comparison mode.

Parameters:

message1 - first message to compare

message2 - second message to compare

Returns:

true if the messages are logically similar, false otherwise

Throws:

NullPointerException - if message1 or message2 is null

toString

public String toString()

Returns the description of the last comparison result.

If no comparison has been performed yet, a strict comparison is executed first.

Overrides:

toString in class Object

Returns:

comparison description or one of the predefined no-diff constants