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()
    Answers a new instance of the same class as the receiver, whose slots have been filled in with the values in the slots of the receiver.
    boolean
    equals(Object o)
    Compares the argument to the receiver, and answers true if they represent the same object using a class specific comparison.
    protected void
    finalize()
    Deprecated, for removal: This API element is subject to removal in a future version.
    May cause performance issues, deadlocks and hangs.
    final Class<? extends Object>
    getClass()
    Answers the unique instance of java.lang.Class which represents the class of the receiver.
    int
    hashCode()
    Answers an integer hash code for the receiver.
    final void
    notify()
    Causes one thread which is waiting on the receiver to be made ready to run.
    final void
    notifyAll()
    Causes all threads which are waiting on the receiver to be made ready to run.
    String
    toString()
    Answers a string containing a concise, human-readable description of the receiver.
    final void
    wait()
    Causes the thread which sent this message to be made not ready to run pending some change in the receiver (as indicated by notify or notifyAll).
    final void
    wait(long time)
    Causes the thread which sent this message to be made not ready to run either pending some change in the receiver (as indicated by notify or notifyAll) or the expiration of the timeout.
    final void
    wait(long time, int frac)
    Causes the thread which sent this message to be made not ready to run either pending some change in the receiver (as indicated by notify or notifyAll) or the expiration of the timeout.

  • 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)