javax.xml.crypto.dsig.spec

Class XPathFilterParameterSpec

java.lang.Object

javax.xml.crypto.dsig.spec.XPathFilterParameterSpec

All Implemented Interfaces:

java.security.spec.AlgorithmParameterSpec, TransformParameterSpec

public final class XPathFilterParameterSpec
extends java.lang.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"/>
 

Author:

Sean Mullan, JSR 105 Expert Group

See Also:

Transform

Constructor Summary

Constructors

Constructor and Description
XPathFilterParameterSpec(java.lang.String xPath) Creates an XPathFilterParameterSpec with the specified XPath expression.
XPathFilterParameterSpec(java.lang.String xPath, java.util.Map namespaceMap) Creates an XPathFilterParameterSpec with the specified XPath expression and namespace map.

Method Summary

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

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

XPathFilterParameterSpec

public XPathFilterParameterSpec(java.lang.String xPath)

Creates an XPathFilterParameterSpec with the specified XPath expression.

Parameters:

xPath - the XPath expression to be evaluated

Throws:

java.lang.NullPointerException - if xPath is null

XPathFilterParameterSpec

public XPathFilterParameterSpec(java.lang.String xPath,
                                java.util.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:

java.lang.NullPointerException - if xPath or namespaceMap are null

java.lang.ClassCastException - if any of the map's keys or entries are not of type String

Method Detail

getXPath

public java.lang.String getXPath()

Returns the XPath expression to be evaluated.

Returns:

the XPath expression to be evaluated

getNamespaceMap

public java.util.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)