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:
37: package org.custommonkey.xmlunit;
38:
39: import org.w3c.dom.Element;
40:
41: /**
42: * Interface used by the DifferenceEngine class to determine which elements can
43: * be compared within a NodeList of child nodes.
44: *
45: * <br />Examples and more at
46: * <a href="http://xmlunit.sourceforge.net"/>xmlunit.sourceforge.net</a>
47: * @see DifferenceEngine#compareNodeList(NodeList, NodeList, int, DifferenceListener, ElementQualifier)
48: * @see Diff#overrideElementQualifier(ElementQualifier)
49: */
50:
51: public interface ElementQualifier {
52: /**
53: * Determine whether two elements are comparable
54: * @param control an Element from the control XML NodeList
55: * @param test an Element from the test XML NodeList
56: * @return true if the elements are comparable, false otherwise
57: */
58: boolean qualifyForComparison(Element control, Element test);
59: }
|