Java XPath Expression compile(String expression)

Description

Returns a compiled XPath expression.

License

Open Source License

Parameter

Parameter	Description
expression	The XPath expression as a String.

Exception

Parameter	Description
XPathExpressionException	If a parsing error occurs.

Return

The compiled XPathExpression.

Declaration

public static XPathExpression compile(String expression) throws XPathExpressionException 

Method Source Code

//package com.java2s;
/*//from www  .j a v  a 2s .  c  o m
 * The MIT License (MIT)
 *
 * Copyright (c) 2016 Lachlan Dowding
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */

import javax.xml.namespace.NamespaceContext;
import javax.xml.xpath.XPath;

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

public class Main {
    /**
     * Returns a compiled XPath expression.
     *
     * @param expression                The XPath expression as a String.
     * @return                          The compiled XPathExpression.
     * @throws XPathExpressionException If a parsing error occurs.
     */
    public static XPathExpression compile(String expression) throws XPathExpressionException {
        return compile(expression, (NamespaceContext) null);
    }

    /**
     * Returns a compiled XPath expression.
     *
     * @param expression                The XPath expression as a String.
     * @param namespaceContext          The namespace context used by the XPath expression.
     * @return                          The compiled XPathExpression.
     * @throws XPathExpressionException If a parsing error occurs.
     */
    public static XPathExpression compile(String expression, NamespaceContext namespaceContext)
            throws XPathExpressionException {
        XPath compiler = XPathFactory.newInstance().newXPath();
        if (namespaceContext != null)
            compiler.setNamespaceContext(namespaceContext);
        return compiler.compile(expression);
    }
}

Related

1. asBoolean(String expression, Node node)
2. asLong(String expression, Node node)
3. compile(String expression)
4. compile(String path)
5. compileXPathExpression(String xPathExpression)
6. constructXPathForElement(Element inElem, String xPathRest)