raccoon.api.eai.uitest
Interface IComparator

All Known Implementing Classes:
TibrvCompare

public interface IComparator

A message comparator service. Compares the contents of an expected message to a provided message. It is possible to ignore various elements of the message by adding ignore rules via addIgnore(UiIgnore).

Since:
Raccoon v1.0
Version:
$Id: IComparator.java,v 1.1 2004/08/08 20:25:56 crouvrais Exp $
Author:
Cedric ROUVRAIS

Method Summary
 void addIgnore(UiIgnore pIgnore)
          Adds a new ignore rule before undertaking the comparaison.
 void clearDifferences()
          Clears the results of the previous comparaison.
 boolean compareTo(java.lang.Object pObject)
          Compares the expected message to the given object.
 java.util.HashMap getDifferences()
          The list of differences identified.
 void setExpected(IMessage pExpected)
          The expected message to compare to.
 

Method Detail

setExpected

void setExpected(IMessage pExpected)
The expected message to compare to.

Parameters:
pExpected - the message.

compareTo

boolean compareTo(java.lang.Object pObject)
Compares the expected message to the given object.

Parameters:
pObject - the reference object with which to compare.
Returns:
true if this object is the same as the pObject argument; false otherwise.

getDifferences

java.util.HashMap getDifferences()
The list of differences identified.

Returns:
the differences.

clearDifferences

void clearDifferences()
Clears the results of the previous comparaison.


addIgnore

void addIgnore(UiIgnore pIgnore)
Adds a new ignore rule before undertaking the comparaison.

Parameters:
pIgnore - the new ignore rule to add.


Copyright null null. All Rights Reserved.