org.apache.xpath.jaxp

## Class XPathFactoryImpl

- java.lang.Object
- - javax.xml.xpath.XPathFactory
  - - org.apache.xpath.jaxp.XPathFactoryImpl

-     public class XPathFactoryImpl
      extends javax.xml.xpath.XPathFactory

  The XPathFactory builds XPaths.
  Version:
    $Revision$
  Author:
    Ramesh Mandava

- - ### Field Summary

    - ### Fields inherited from class javax.xml.xpath.XPathFactory

      `DEFAULT_OBJECT_MODEL_URI, DEFAULT_PROPERTY_NAME`

  - ### Constructor Summary

    Constructors
    Constructor and Description
    `XPathFactoryImpl()`

  - ### Method Summary

    All Methods Instance Methods Concrete Methods
    Modifier and Type | Method and Description
    --- | ---
    `boolean` | `getFeature(java.lang.String name)` Get the state of the named feature.
    `boolean` | `isObjectModelSupported(java.lang.String objectModel)` Is specified object model supported by this `XPathFactory`?
    `javax.xml.xpath.XPath` | `newXPath()` Returns a new `XPath` object using the underlying object model determined when the factory was instantiated.
    `void` | `setFeature(java.lang.String name, boolean value)` Set a feature for this `XPathFactory` and `XPath`s created by this factory.
    `void` | `setXPathFunctionResolver(javax.xml.xpath.XPathFunctionResolver resolver)` Establish a default function resolver.
    `void` | `setXPathVariableResolver(javax.xml.xpath.XPathVariableResolver resolver)` Establish a default variable resolver.

    - ### Methods inherited from class javax.xml.xpath.XPathFactory

      `newInstance, newInstance, newInstance`

    - ### Methods inherited from class java.lang.Object

      `equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

- - ### Constructor Detail

    - #### XPathFactoryImpl

          public XPathFactoryImpl()

  - ### Method Detail

    - #### isObjectModelSupported

          public boolean isObjectModelSupported(java.lang.String objectModel)

      Is specified object model supported by this `XPathFactory`?

      Specified by:
        `isObjectModelSupported` in class `javax.xml.xpath.XPathFactory`
      Parameters:
        `objectModel` - Specifies the object model which the returned `XPathFactory` will understand.
      Returns:
        `true` if `XPathFactory` supports `objectModel`, else `false`.
      Throws:
        `java.lang.NullPointerException` - If `objectModel` is `null`.
        `java.lang.IllegalArgumentException` - If `objectModel.length() == 0`.

    - #### newXPath

          public javax.xml.xpath.XPath newXPath()

      Returns a new `XPath` object using the underlying object model determined when the factory was instantiated.

      Specified by:
        `newXPath` in class `javax.xml.xpath.XPathFactory`
      Returns:
        New `XPath`

    - #### setFeature

          public void setFeature(java.lang.String name,
                                 boolean value)
                          throws javax.xml.xpath.XPathFactoryConfigurationException

      Set a feature for this `XPathFactory` and `XPath`s created by this factory.

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

      See `XPathFactory` for full documentation of specific features.

      Specified by:
        `setFeature` in class `javax.xml.xpath.XPathFactory`
      Parameters:
        `name` - Feature name.
        `value` - Is feature state `true` or `false`.
      Throws:
        `javax.xml.xpath.XPathFactoryConfigurationException` - if this `XPathFactory` or the `XPath`s it creates cannot support this feature.
        `java.lang.NullPointerException` - if `name` is `null`.

    - #### getFeature

          public boolean getFeature(java.lang.String name)
                             throws javax.xml.xpath.XPathFactoryConfigurationException

      Get the state of the named feature.

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

      Specified by:
        `getFeature` in class `javax.xml.xpath.XPathFactory`
      Parameters:
        `name` - Feature name.
      Returns:
        State of the named feature.
      Throws:
        `javax.xml.xpath.XPathFactoryConfigurationException` - if this `XPathFactory` or the `XPath`s it creates cannot support this feature.
        `java.lang.NullPointerException` - if `name` is `null`.

    - #### setXPathFunctionResolver

          public void setXPathFunctionResolver(javax.xml.xpath.XPathFunctionResolver resolver)

      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`.

      Specified by:
        `setXPathFunctionResolver` in class `javax.xml.xpath.XPathFactory`
      Parameters:
        `resolver` - XPath function resolver.
      Throws:
        `java.lang.NullPointerException` - If `resolver` is `null`.

    - #### setXPathVariableResolver

          public void setXPathVariableResolver(javax.xml.xpath.XPathVariableResolver resolver)

      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`.

      Specified by:
        `setXPathVariableResolver` in class `javax.xml.xpath.XPathFactory`
      Parameters:
        `resolver` - Variable resolver.
      Throws:
        `java.lang.NullPointerException` - If `resolver` is `null`.

Copyright © 2023 Apache XML Project. All Rights Reserved.