| java.lang.Object | |
| ↳ | javax.xml.xpath.XPathFactory |
An XPathFactory instance can be used to create
XPath objects.
See newInstance(String) for lookup mechanism.
| Constants | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| String | DEFAULT_OBJECT_MODEL_URI |
Default Object Model URI. |
|||||||||
| String | DEFAULT_PROPERTY_NAME |
The default property name according to the JAXP spec. |
|||||||||
| Protected Constructors | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
Protected constructor as | |||||||||||
| Public Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
Get the state of the named feature. | |||||||||||
Is specified object model supported by this | |||||||||||
Get a new | |||||||||||
Get a new | |||||||||||
Return a new | |||||||||||
Set a feature for this | |||||||||||
Establish a default function resolver. | |||||||||||
Establish a default variable resolver. | |||||||||||
|
[Expand]
Inherited Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
From class
java.lang.Object
| |||||||||||
Default Object Model URI.
The default property name according to the JAXP spec.
Protected constructor as newInstance(), newInstance(String)
or newInstance(String, String, ClassLoader)
should be used to create a new instance of an XPathFactory.
Get the state of the named feature.
Feature names are fully qualified 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.
| name | Feature name. |
|---|
| XPathFactoryConfigurationException | if this XPathFactory or the XPaths
it creates cannot support this feature. |
|---|---|
| NullPointerException | if name is null.
|
Is specified object model supported by this XPathFactory?
| objectModel | Specifies the object model which the returned XPathFactory will understand. |
|---|
Developers
true if XPathFactory supports objectModel, else false.| NullPointerException | If objectModel is null. |
|---|---|
| IllegalArgumentException | If objectModel.length() == 0.
|
XPathFactory.| XPathFactoryConfigurationException | If the specified object model is unavailable. |
|---|---|
| NullPointerException | If uri is null. |
| IllegalArgumentException | If uri.length() == 0.
|
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:
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.
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:
isObjectModelSupported(String)
The first service provider found in class loader order that supports the specified object model is returned.
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 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
| uri | Identifies the underlying object model.
The specification only defines the URI DEFAULT_OBJECT_MODEL_URI,
http://java.sun.com/jaxp/xpath/dom for the W3C DOM,
the org.w3c.dom package, and implementations are free to introduce other URIs for other object models. |
|---|
XPathFactory.| XPathFactoryConfigurationException | If the specified object model is unavailable. |
|---|---|
| NullPointerException | If uri is null. |
| IllegalArgumentException | If uri.length() == 0.
|
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.
XPathFactory.
Return a new XPath using the underlying object
model determined when the XPathFactory was instantiated.
XPath.
Set a feature for this XPathFactory and XPaths created by this factory.
Feature names are fully qualified 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 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.
| name | Feature name. |
|---|---|
| value | Is feature state true or false. |
| XPathFactoryConfigurationException | if this XPathFactory or the XPaths
it creates cannot support this feature. |
|---|---|
| NullPointerException | if name is null.
|
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.
| resolver | XPath function resolver. |
|---|
| NullPointerException | If resolver is null.
|
|---|
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.
| resolver | Variable resolver. |
|---|
| NullPointerException | If resolver is null.
|
|---|