Package com.helger.xml.xpath

Class XPathHelper

java.lang.Object

com.helger.xml.xpath.XPathHelper

@NotThreadSafe
public final class XPathHelper
extends Object

Utility class to create XPath and XPathExpression objects more easily.

Author:

Philip Helger

Method Summary

Modifier and Type	Method	Description
static XPath	createNewXPath()	Create a new XPath without any special settings using the default XPathFactory.
static XPath	createNewXPath(NamespaceContext aNamespaceContext)	Create a new XPath with the passed namespace context using the default XPathFactory.
static XPath	createNewXPath(XPathFactory aXPathFactory)	Create a new XPath without any special settings.
static XPath	createNewXPath(XPathFactory aXPathFactory, NamespaceContext aNamespaceContext)	Create a new XPath with the passed namespace context.
static XPath	createNewXPath(XPathFactory aXPathFactory, XPathFunctionResolver aFunctionResolver)	Create a new XPath with the passed function resolver.
static XPath	createNewXPath(XPathFactory aXPathFactory, XPathVariableResolver aVariableResolver)	Create a new XPath with the passed variable resolver.
static XPath	createNewXPath(XPathFactory aXPathFactory, XPathVariableResolver aVariableResolver, XPathFunctionResolver aFunctionResolver, NamespaceContext aNamespaceContext)	Create a new XPath with the passed variable resolver, function resolver and namespace context.
static XPath	createNewXPath(XPathFunctionResolver aFunctionResolver)	Create a new XPath with the passed function resolver using the default XPathFactory.
static XPath	createNewXPath(XPathVariableResolver aVariableResolver)	Create a new XPath with the passed variable resolver using the default XPathFactory.
static XPath	createNewXPath(XPathVariableResolver aVariableResolver, NamespaceContext aNamespaceContext)	Create a new XPath with the passed variable resolver and namespace context using the default XPathFactory.
static XPath	createNewXPath(XPathVariableResolver aVariableResolver, XPathFunctionResolver aFunctionResolver, NamespaceContext aNamespaceContext)	Create a new XPath with the passed variable resolver, function resolver and namespace context using the default XPathFactory.
static XPathExpression	createNewXPathExpression(String sXPath)	Create a new XPath expression for evaluation using the default XPathFactory.
static XPathExpression	createNewXPathExpression(NamespaceContext aNamespaceContext, String sXPath)	Create a new XPath expression for evaluation using the default XPathFactory.
static XPathExpression	createNewXPathExpression(XPathFunctionResolver aFunctionResolver, String sXPath)	Create a new XPath expression for evaluation using the default XPathFactory.
static XPathExpression	createNewXPathExpression(XPath aXPath, String sXPath)	Create a new XPath expression for evaluation.
static XPathExpression	createNewXPathExpression(XPathVariableResolver aVariableResolver, String sXPath)	Create a new XPath expression for evaluation using the default XPathFactory.
static XPathExpression	createNewXPathExpression(XPathVariableResolver aVariableResolver, XPathFunctionResolver aFunctionResolver, NamespaceContext aNamespaceContext, String sXPath)	Create a new XPath expression for evaluation using the default XPathFactory.
static XPathFactory	createXPathFactorySaxonFirst()	Create a new XPathFactory trying to instantiate Saxon class net.sf.saxon.xpath.XPathFactoryImpl first.
static XPathFactory	getDefaultXPathFactory()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getDefaultXPathFactory

@Nonnull
public static XPathFactory getDefaultXPathFactory()

Returns:

The default XPath factory. Be careful when manipulating this object! Never null.

createXPathFactorySaxonFirst

@Nonnull
public static XPathFactory createXPathFactorySaxonFirst()

Create a new XPathFactory trying to instantiate Saxon class net.sf.saxon.xpath.XPathFactoryImpl first. If that fails, the default XPathFactory is created.

Returns:

A new XPathFactory and never null.

Throws:

IllegalStateException - In case neither Saxon nor default factory could be instantiated!

createNewXPath

@Nonnull
public static XPath createNewXPath()

Create a new XPath without any special settings using the default XPathFactory.

Returns:

The created non-null XPath object

createNewXPath

@Nonnull
public static XPath createNewXPath(@Nonnull
                                   XPathFactory aXPathFactory)

Create a new XPath without any special settings.

Parameters:

aXPathFactory - The XPath factory object to use. May not be null.

Returns:

The created non-null XPath object

createNewXPath

@Nonnull
public static XPath createNewXPath(@Nullable
                                   XPathVariableResolver aVariableResolver)

Create a new XPath with the passed variable resolver using the default XPathFactory.

Parameters:

aVariableResolver - Variable resolver to be used. May be null.

Returns:

The created non-null XPath object

createNewXPath

@Nonnull
public static XPath createNewXPath(@Nonnull
                                   XPathFactory aXPathFactory,
                                   @Nullable
                                   XPathVariableResolver aVariableResolver)

Create a new XPath with the passed variable resolver.

Parameters:

aXPathFactory - The XPath factory object to use. May not be null.

aVariableResolver - Variable resolver to be used. May be null.

Returns:

The created non-null XPath object

createNewXPath

@Nonnull
public static XPath createNewXPath(@Nullable
                                   XPathFunctionResolver aFunctionResolver)

Create a new XPath with the passed function resolver using the default XPathFactory.

Parameters:

aFunctionResolver - Function resolver to be used. May be null.

Returns:

The created non-null XPath object

createNewXPath

@Nonnull
public static XPath createNewXPath(@Nonnull
                                   XPathFactory aXPathFactory,
                                   @Nullable
                                   XPathFunctionResolver aFunctionResolver)

Create a new XPath with the passed function resolver.

Parameters:

aXPathFactory - The XPath factory object to use. May not be null.

aFunctionResolver - Function resolver to be used. May be null.

Returns:

The created non-null XPath object

createNewXPath

@Nonnull
public static XPath createNewXPath(@Nullable
                                   NamespaceContext aNamespaceContext)

Create a new XPath with the passed namespace context using the default XPathFactory.

Parameters:

aNamespaceContext - Namespace context to be used. May be null.

Returns:

The created non-null XPath object

createNewXPath

@Nonnull
public static XPath createNewXPath(@Nonnull
                                   XPathFactory aXPathFactory,
                                   @Nullable
                                   NamespaceContext aNamespaceContext)

Create a new XPath with the passed namespace context.

Parameters:

aXPathFactory - The XPath factory object to use. May not be null.

aNamespaceContext - Namespace context to be used. May be null.

Returns:

The created non-null XPath object

createNewXPath

@Nonnull
public static XPath createNewXPath(@Nullable
                                   XPathVariableResolver aVariableResolver,
                                   @Nullable
                                   NamespaceContext aNamespaceContext)

Create a new XPath with the passed variable resolver and namespace context using the default XPathFactory.

Parameters:

aVariableResolver - Variable resolver to be used. May be null.

aNamespaceContext - Namespace context to be used. May be null.

Returns:

The created non-null XPath object

createNewXPath

@Nonnull
public static XPath createNewXPath(@Nullable
                                   XPathVariableResolver aVariableResolver,
                                   @Nullable
                                   XPathFunctionResolver aFunctionResolver,
                                   @Nullable
                                   NamespaceContext aNamespaceContext)

Create a new XPath with the passed variable resolver, function resolver and namespace context using the default XPathFactory.

Parameters:

aVariableResolver - Variable resolver to be used. May be null.

aFunctionResolver - Function resolver to be used. May be null.

aNamespaceContext - Namespace context to be used. May be null.

Returns:

The created non-null XPath object

createNewXPath

@Nonnull
public static XPath createNewXPath(@Nonnull
                                   XPathFactory aXPathFactory,
                                   @Nullable
                                   XPathVariableResolver aVariableResolver,
                                   @Nullable
                                   XPathFunctionResolver aFunctionResolver,
                                   @Nullable
                                   NamespaceContext aNamespaceContext)

Create a new XPath with the passed variable resolver, function resolver and namespace context.

Parameters:

aXPathFactory - The XPath factory object to use. May not be null.

aVariableResolver - Variable resolver to be used. May be null.

aFunctionResolver - Function resolver to be used. May be null.

aNamespaceContext - Namespace context to be used. May be null.

Returns:

The created non-null XPath object

createNewXPathExpression

@Nonnull
public static XPathExpression createNewXPathExpression(@Nullable
                                                       XPathVariableResolver aVariableResolver,
                                                       @Nullable
                                                       XPathFunctionResolver aFunctionResolver,
                                                       @Nullable
                                                       NamespaceContext aNamespaceContext,
                                                       @Nonnull @Nonempty
                                                       String sXPath)

Create a new XPath expression for evaluation using the default XPathFactory.

Parameters:

aVariableResolver - Variable resolver to be used. May be null.

aFunctionResolver - Function resolver to be used. May be null.

aNamespaceContext - Namespace context to be used. May be null.

sXPath - The main XPath string to be evaluated

Returns:

The XPathExpression object to be used.

Throws:

IllegalArgumentException - if the XPath cannot be compiled

createNewXPathExpression

@Nonnull
public static XPathExpression createNewXPathExpression(@Nullable
                                                       XPathVariableResolver aVariableResolver,
                                                       @Nonnull @Nonempty
                                                       String sXPath)

Create a new XPath expression for evaluation using the default XPathFactory.

Parameters:

aVariableResolver - Variable resolver to be used. May be null.

sXPath - The main XPath string to be evaluated

Returns:

The XPathExpression object to be used.

Throws:

IllegalArgumentException - if the XPath cannot be compiled

createNewXPathExpression

@Nonnull
public static XPathExpression createNewXPathExpression(@Nullable
                                                       XPathFunctionResolver aFunctionResolver,
                                                       @Nonnull @Nonempty
                                                       String sXPath)

Create a new XPath expression for evaluation using the default XPathFactory.

Parameters:

aFunctionResolver - Function resolver to be used. May be null.

sXPath - The main XPath string to be evaluated

Returns:

The XPathExpression object to be used.

Throws:

IllegalArgumentException - if the XPath cannot be compiled

createNewXPathExpression

@Nonnull
public static XPathExpression createNewXPathExpression(@Nullable
                                                       NamespaceContext aNamespaceContext,
                                                       @Nonnull @Nonempty
                                                       String sXPath)

Create a new XPath expression for evaluation using the default XPathFactory.

Parameters:

aNamespaceContext - Namespace context to be used. May be null.

sXPath - The main XPath string to be evaluated

Returns:

The XPathExpression object to be used.

Throws:

IllegalArgumentException - if the XPath cannot be compiled

createNewXPathExpression

@Nonnull
public static XPathExpression createNewXPathExpression(@Nonnull @Nonempty
                                                       String sXPath)

Create a new XPath expression for evaluation using the default XPathFactory.

Parameters:

sXPath - The main XPath string to be evaluated

Returns:

The XPathExpression object to be used.

Throws:

IllegalArgumentException - if the XPath cannot be compiled

createNewXPathExpression

@Nonnull
public static XPathExpression createNewXPathExpression(@Nonnull
                                                       XPath aXPath,
                                                       @Nonnull @Nonempty
                                                       String sXPath)

Create a new XPath expression for evaluation.

Parameters:

aXPath - The pre-created XPath object. May not be null.

sXPath - The main XPath string to be evaluated

Returns:

The XPathExpression object to be used.

Throws:

IllegalArgumentException - if the XPath cannot be compiled