Class XPathFilterParameterSpec

java.lang.Object
javax.xml.crypto.dsig.spec.XPathFilterParameterSpec
All Implemented Interfaces:
AlgorithmParameterSpec, TransformParameterSpec
public final class XPathFilterParameterSpec extends Object implements TransformParameterSpec
Parameters for the XPath Filtering Transform Algorithm. The parameters include the XPath expression and an optional Map of additional namespace prefix mappings. The XML Schema Definition of the XPath Filtering transform parameters is defined as: 
<element name="XPath" type="string"/>
Since:
1.6
See Also:

  • Constructor Summary

    Constructors
    Constructor
    Description
    XPathFilterParameterSpec(String xPath)
    Creates an XPathFilterParameterSpec with the specified XPath expression.
    XPathFilterParameterSpec(String xPath, Map<String,String> namespaceMap)
    Creates an XPathFilterParameterSpec with the specified XPath expression and namespace map.

  • Method Summary

    Modifier and Type
    Method
    Description
    Map<String,String>
    getNamespaceMap()
    Returns a map of namespace prefixes.
    String
    getXPath()
    Returns the XPath expression to be evaluated.

    Methods declared in class Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    Modifier and Type
    Method
    Description
    protected Object
    clone()
    Creates and returns a copy of this object.
    boolean
    equals(Object obj)
    Indicates whether some other object is "equal to" this one.
    protected void
    finalize()
    Deprecated, for removal: This API element is subject to removal in a future version.
    Finalization is deprecated and subject to removal in a future release.
    final Class<?>
    getClass()
    Returns the runtime class of this Object.
    int
    hashCode()
    Returns a hash code value for this object.
    final void
    notify()
    Wakes up a single thread that is waiting on this object's monitor.
    final void
    notifyAll()
    Wakes up all threads that are waiting on this object's monitor.
    String
    toString()
    Returns a string representation of the object.
    final void
    wait()
    Causes the current thread to wait until it is awakened, typically by being notified or interrupted.
    final void
    wait(long timeoutMillis)
    Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
    final void
    wait(long timeoutMillis, int nanos)
    Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.

  • Constructor Details

    • XPathFilterParameterSpec

      public XPathFilterParameterSpec(String xPath)
      Creates an XPathFilterParameterSpec with the specified XPath expression.
      Parameters:
      xPath - the XPath expression to be evaluated
      Throws:
      NullPointerException - if xPath is null

    • XPathFilterParameterSpec

      public XPathFilterParameterSpec(String xPath, Map<String,String> namespaceMap)
      Creates an XPathFilterParameterSpec with the specified XPath expression and namespace map. The map is copied to protect against subsequent modification.
      Parameters:
      xPath - the XPath expression to be evaluated
      namespaceMap - the map of namespace prefixes. Each key is a namespace prefix String that maps to a corresponding namespace URI String.
      Throws:
      NullPointerException - if xPath or namespaceMap are null
      ClassCastException - if any of the map's keys or entries are not of type String

  • Method Details

    • getXPath

      public String getXPath()
      Returns the XPath expression to be evaluated.
      Returns:
      the XPath expression to be evaluated

    • getNamespaceMap

      public Map<String,String> getNamespaceMap()
      Returns a map of namespace prefixes. Each key is a namespace prefix String that maps to a corresponding namespace URI String.

      This implementation returns an unmodifiable map.

      Returns:
      a Map of namespace prefixes to namespace URIs (may be empty, but never null)