public final class

XPathFilterParameterSpec

extends Object
implements TransformParameterSpec
java.lang.Object
   ↳ javax.xml.crypto.dsig.spec.XPathFilterParameterSpec

Class Overview

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"/>

See Also

Summary

Public Constructors
XPathFilterParameterSpec(String xPath)
Creates an XPathFilterParameterSpec with the specified XPath expression.
XPathFilterParameterSpec(String xPath, Map namespaceMap)
Creates an XPathFilterParameterSpec with the specified XPath expression and namespace map.
Public Methods
Map getNamespaceMap()
Returns a map of namespace prefixes.
String getXPath()
Returns the XPath expression to be evaluated.
[Expand]
Inherited Methods
From class java.lang.Object

Public Constructors

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

public XPathFilterParameterSpec (String xPath, Map 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

Public Methods

public Map 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)

public String getXPath ()

Returns the XPath expression to be evaluated.

Returns
  • the XPath expression to be evaluated