XPathFactory

DEFAULT_OBJECT_MODEL_URI

static val DEFAULT_OBJECT_MODEL_URI: String

Default Object Model URI.

Value: "http://java.sun.com/jaxp/xpath/dom"

DEFAULT_PROPERTY_NAME

static val DEFAULT_PROPERTY_NAME: String

The default property name according to the JAXP spec.

Value: "javax.xml.xpath.XPathFactory"

XPathFactory

protected XPathFactory()

Protected constructor as newInstance(), newInstance(java.lang.String) or newInstance(java.lang.String,java.lang.String,java.lang.ClassLoader) should be used to create a new instance of an XPathFactory.

getFeature

abstract fun getFeature(name: String!): Boolean

Get the state of the named feature.

Feature names are fully qualified java.net.URIs. Implementations may define their own features. An XPathFactoryConfigurationException is thrown if this XPathFactory or the XPaths it creates cannot support the feature. It is possible for an XPathFactory to expose a feature value but be unable to change its state.

isObjectModelSupported

abstract fun isObjectModelSupported(objectModel: String!): Boolean

Is specified object model supported by this XPathFactory?

newInstance

static fun newInstance(): XPathFactory!

Get a new XPathFactory instance using the default object model, DEFAULT_OBJECT_MODEL_URI, the W3C DOM.

This method is functionally equivalent to:

newInstance(DEFAULT_OBJECT_MODEL_URI)
  

Since the implementation for the W3C DOM is always available, this method will never fail.

newInstance

static fun newInstance(uri: String!): XPathFactory!

Get a new XPathFactory instance using the specified object model.

To find a XPathFactory object, this method looks the following places in the following order where "the class loader" refers to the context class loader:

1. If the system property DEFAULT_PROPERTY_NAME + ":uri" is present, where uri is the parameter to this method, then its value is read as a class name. The method will try to create a new instance of this class by using the class loader, and returns it if it is successfully created.
2. ${java.home}/lib/jaxp.properties is read and the value associated with the key being the system property above is looked for. If present, the value is processed just like above.
3. The class loader is asked for service provider provider-configuration files matching javax.xml.xpath.XPathFactory in the resource directory META-INF/services. See the JAR File Specification for file format and parsing rules. Each potential service provider is required to implement the method:

   <code><a docref="javax.xml.xpath.XPathFactory$isObjectModelSupported(kotlin.String)">#isObjectModelSupported(java.lang.String)</a></code>

   The first service provider found in class loader order that supports the specified object model is returned.
4. Platform default XPathFactory is located in a platform specific way. There must be a platform default XPathFactory for the W3C DOM, i.e. DEFAULT_OBJECT_MODEL_URI.

If everything fails, an XPathFactoryConfigurationException will be thrown.

Tip for Trouble-shooting:

See java.util.Properties#load(java.io.InputStream) for exactly how a property file is parsed. In particular, colons ':' need to be escaped in a property file, so make sure the URIs are properly escaped in it. For example:

http\://java.sun.com/jaxp/xpath/dom=org.acme.DomXPathFactory
  

newInstance

open static fun newInstance(
    uri: String!, 
    factoryClassName: String!, 
    classLoader: ClassLoader!
): XPathFactory!

newXPath

abstract fun newXPath(): XPath!

Return a new XPath using the underlying object model determined when the XPathFactory was instantiated.

setFeature

abstract fun setFeature(
    name: String!, 
    value: Boolean
): Unit

Set a feature for this XPathFactory and XPaths created by this factory.

Feature names are fully qualified java.net.URIs. Implementations may define their own features. An XPathFactoryConfigurationException is thrown if this XPathFactory or the XPaths it creates cannot support the feature. It is possible for an XPathFactory to expose a feature value but be unable to change its state.

All implementations are required to support the javax.xml.XMLConstants#FEATURE_SECURE_PROCESSING feature. When the feature is true, any reference to an external function is an error. Under these conditions, the implementation must not call the XPathFunctionResolver and must throw an XPathFunctionException.

setXPathFunctionResolver

abstract fun setXPathFunctionResolver(resolver: XPathFunctionResolver!): Unit

Establish a default function resolver.

Any XPath objects constructed from this factory will use the specified resolver by default.

A NullPointerException is thrown if resolver is null.

setXPathVariableResolver

abstract fun setXPathVariableResolver(resolver: XPathVariableResolver!): Unit

Establish a default variable resolver.

Any XPath objects constructed from this factory will use the specified resolver by default.

A NullPointerException is thrown if resolver is null.