Rational QualityArchitect/Java API
Version 1.0

com.rational.test.vp
Interface VerificationPointComparator

All Known Implementing Classes:
DatabaseVPComparator

public interface VerificationPointComparator

A class implementing this interface provides a method that compares two VerificationPointData objects to determine if the comparison succeeds or fails. The comparison can test for equality between the expected and actual data, or it can test for some other condition (for example, that the actual data falls within a given range).

This class is passed into the constructor of the abstract VerificationPoint class and is used when that verification point needs to perform its comparison.

The VerificationPointComparator interface is part of the verification point framework that you use to implement your own verification point classes. The verification point framework also includes:

Since:
QualityArchitect 0.1
See Also:
Implementing a New Verification Point

Method Summary
 boolean compare(VerificationPointData vpsExpected, VerificationPointData vpsActual, java.lang.Object objOptions, java.lang.StringBuffer sFailureDescription)
          This method compares an expected data object and an actual data object, both of type VerificationPointData, and determines whether the test succeeds or fails.
 

Method Detail

compare

public boolean compare(VerificationPointData vpsExpected,
                       VerificationPointData vpsActual,
                       java.lang.Object objOptions,
                       java.lang.StringBuffer sFailureDescription)

This method compares an expected data object and an actual data object, both of type VerificationPointData, and determines whether the test succeeds or fails.

Parameters:
vpsExpected - The expected data object.
vpsActual - The actual data object.
objOptions - Options that are passed from the Verification Point class to qualify the comparison. Options can include the pre-defined COMPARE_CASESENSITIVE and COMPARE_CASEINSENSITIVE options plus any user-defined options.
sFailureDescription - An output parameter that contains the differences between the expected and actual data objects in a failed verification point. The failure description is written to the log.
Returns:
boolean A value indicating whether the test passed or failed.

30-Jun-2003

Rational QualityArchitect/Java Support Home Page
Copyright (c) 2000, Rational Software Corporation