hazendaz / httpunit / 755

Committed 14 Feb 2026 07:14PM UTC coverage: 80.526%. Remained the same

Build # 755

Build Type

push

github

Committed by

hazendaz

Commit Message

[ci] Fix badge

Run Details

3213 of 4105 branches covered (78.27%)

Branch coverage included in aggregate %.

8245 of 10124 relevant lines covered (81.44%)

0.81 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

62.5

/src/main/java/com/meterware/httpunit/XPathPredicate.java

/*
 * SPDX-License-Identifier: MIT
 * See LICENSE file for details.
 *
 * Copyright 2000-2026 Russell Gold
 * Copyright 2021-2000 hazendaz
 */
package com.meterware.httpunit;

import javax.xml.xpath.XPathConstants;
import javax.xml.xpath.XPathExpression;
import javax.xml.xpath.XPathExpressionException;
import javax.xml.xpath.XPathFactory;

import org.w3c.dom.Document;
import org.w3c.dom.Node;
import org.w3c.dom.NodeList;

/**
 * Provides an HTMLElement Predicate that is capable of matching based on an XPath node specification. This allows for
 * very advanced matching techniques. THREAD: Instances are not thread safe, each thread should create its own instance
 * with a specific xpath. (The same instance can be used for multiple documents, each change in document will result in
 * its internal caches being flushed).
 */
public class XPathPredicate implements HTMLElementPredicate {

    /** XPath which dictates matching nodes, from root. */
    private XPathExpression xpath;

    /** The path. */
    private String path;

    /** The Constant DEBUG. */
    // set to true for debugging
    public static final boolean DEBUG = false;

    /**
     * Constructs an HTMLElementPredicate that matches only those elements which match the provided XPath.
     *
     * @param path
     *            [in] XPath specification of valid/matching nodes
     *
     * @throws XPathExpressionException
     *             if the xpath is invalid
     */
    public XPathPredicate(String path) throws XPathExpressionException {
        this.path = path;
        this.xpath = XPathFactory.newInstance().newXPath().compile(path);
    }

    /**
     * debug Output for node structure.
     *
     * @param node
     *            the node
     * @param indent
     *            the indent
     */
    private void debugOut(Node node, String indent) {
        System.out.print(indent + node.getNodeName() + ":");
        System.out.println(indent + node.getNodeValue());
        NodeList nl = node.getChildNodes();
        for (int i = 0; i < nl.getLength(); i++) {
            debugOut(nl.item(i), indent + "\t");
        }
    }

    /**
     * check whether the given criteria are matched for the given element
     *
     * @param someElement
     *            - the element to check
     * @param criteria
     *            - the criteria to check
     */
    @Override
    public boolean matchesCriteria(final Object someElement, final Object criteria) {

        // this condition should normally be false
        if (!(someElement instanceof HTMLElement)) {
            return false;
        }

        HTMLElement htmlElement = (HTMLElement) someElement;

        Node htmlNode = htmlElement.getNode();
        Document doc = htmlNode.getOwnerDocument();
        if (DEBUG) {
            debugOut(doc, "");
        }

        NodeList nodes;
        try {
            nodes = (NodeList) xpath.evaluate(doc, XPathConstants.NODESET);
            final int nodeCount = nodes.getLength();
            for (int i = 0; i < nodeCount; i++) {
                if (nodes.item(i).equals(htmlNode)) {
                    return true;
                }
            }
        } catch (XPathExpressionException e) {
            throw new RuntimeException("unable to evaluate xpath '" + path + "'", e);
        }
        return false;
    }

}

1	/*
2	* SPDX-License-Identifier: MIT
3	* See LICENSE file for details.
4	*
5	* Copyright 2000-2026 Russell Gold
6	* Copyright 2021-2000 hazendaz
7	*/
8	package com.meterware.httpunit;
9
10	import javax.xml.xpath.XPathConstants;
11	import javax.xml.xpath.XPathExpression;
12	import javax.xml.xpath.XPathExpressionException;
13	import javax.xml.xpath.XPathFactory;
14
15	import org.w3c.dom.Document;
16	import org.w3c.dom.Node;
17	import org.w3c.dom.NodeList;
18
19	/**
20	* Provides an HTMLElement Predicate that is capable of matching based on an XPath node specification. This allows for
21	* very advanced matching techniques. THREAD: Instances are not thread safe, each thread should create its own instance
22	* with a specific xpath. (The same instance can be used for multiple documents, each change in document will result in
23	* its internal caches being flushed).
24	*/
25	public class XPathPredicate implements HTMLElementPredicate {
26
27	/** XPath which dictates matching nodes, from root. */
28	private XPathExpression xpath;
29
30	/** The path. */
31	private String path;
32
33	/** The Constant DEBUG. */
34	// set to true for debugging
35	public static final boolean DEBUG = false;
36
37	/**
38	* Constructs an HTMLElementPredicate that matches only those elements which match the provided XPath.
39	*
40	* @param path
41	* [in] XPath specification of valid/matching nodes
42	*
43	* @throws XPathExpressionException
44	* if the xpath is invalid
45	*/
46	public XPathPredicate(String path) throws XPathExpressionException {	1✔
47	this.path = path;	1✔
48	this.xpath = XPathFactory.newInstance().newXPath().compile(path);	1✔
49	}	1✔
50
51	/**
52	* debug Output for node structure.
53	*
54	* @param node
55	* the node
56	* @param indent
57	* the indent
58	*/
59	private void debugOut(Node node, String indent) {
60	System.out.print(indent + node.getNodeName() + ":");	×
61	System.out.println(indent + node.getNodeValue());	×
62	NodeList nl = node.getChildNodes();	×
63	for (int i = 0; i < nl.getLength(); i++) {	×
64	debugOut(nl.item(i), indent + "\t");	×
65	}
66	}	×
67
68	/**
69	* check whether the given criteria are matched for the given element
70	*
71	* @param someElement
72	* - the element to check
73	* @param criteria
74	* - the criteria to check
75	*/
76	@Override
77	public boolean matchesCriteria(final Object someElement, final Object criteria) {
78
79	// this condition should normally be false
80	if (!(someElement instanceof HTMLElement)) {	1!
81	return false;	×
82	}
83
84	HTMLElement htmlElement = (HTMLElement) someElement;	1✔
85
86	Node htmlNode = htmlElement.getNode();	1✔
87	Document doc = htmlNode.getOwnerDocument();	1✔
88	if (DEBUG) {
89	debugOut(doc, "");
90	}
91
92	NodeList nodes;
93	try {
94	nodes = (NodeList) xpath.evaluate(doc, XPathConstants.NODESET);	1✔
95	final int nodeCount = nodes.getLength();	1✔
96	for (int i = 0; i < nodeCount; i++) {	1✔
97	if (nodes.item(i).equals(htmlNode)) {	1✔
98	return true;	1✔
99	}
100	}
101	} catch (XPathExpressionException e) {	×
102	throw new RuntimeException("unable to evaluate xpath '" + path + "'", e);	×
103	}	1✔
104	return false;	1✔
105	}
106
107	}

hazendaz / httpunit / 755

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous