01: /*
02: ******************************************************************
03: Copyright (c) 2001, Jeff Martin, Tim Bacon
04: All rights reserved.
05:
06: Redistribution and use in source and binary forms, with or without
07: modification, are permitted provided that the following conditions
08: are met:
09:
10: * Redistributions of source code must retain the above copyright
11: notice, this list of conditions and the following disclaimer.
12: * Redistributions in binary form must reproduce the above
13: copyright notice, this list of conditions and the following
14: disclaimer in the documentation and/or other materials provided
15: with the distribution.
16: * Neither the name of the xmlunit.sourceforge.net nor the names
17: of its contributors may be used to endorse or promote products
18: derived from this software without specific prior written
19: permission.
20:
21: THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
22: "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
23: LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
24: FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
25: COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
26: INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
27: BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
28: LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
29: CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
30: LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
31: ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
32: POSSIBILITY OF SUCH DAMAGE.
33:
34: ******************************************************************
35: */
36: package org.custommonkey.xmlunit;
37:
38: /**
39: * Callback interface used by DifferenceEngine to determine whether to halt the
40: * node-by-node comparison of two pieces of XML
41: */
42: public interface ComparisonController {
43: /**
44: * Determine whether a Difference that the listener has been notified of
45: * should halt further XML comparison. Default behaviour for a Diff
46: * instance is to halt if the Difference is not recoverable.
47: * @see Difference#isRecoverable
48: * @param afterDifference the last Difference passed to <code>differenceFound</code>
49: * @return true to halt further comparison, false otherwise
50: */
51: boolean haltComparison(Difference afterDifference);
52:
53: }
|