APIdia Launch Partner
Top Description Fields Constructors Methods
javax.xml.crypto.dsig.spec

public final Class XPathFilterParameterSpec

extends Object
implements TransformParameterSpec
Class Inheritance
All Implemented Interfaces
javax.xml.crypto.dsig.spec.TransformParameterSpec, java.security.spec.AlgorithmParameterSpec
Imports
javax.xml.crypto.dsig.Transform, java.util.Collections, .HashMap, .Iterator, .Map
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"/>
Authors
Sean Mullan, JSR 105 Expert Group
Since
1.6
See Also
Transform

Field Summary

Modifier and TypeField and Description
private final Map<String, String>
nsMap

private final String
xPath

Constructor Summary

AccessConstructor and Description
public
XPathFilterParameterSpec(String
the XPath expression to be evaluated
xPath)

Creates an XPathFilterParameterSpec with the specified XPath expression.

public
XPathFilterParameterSpec(String
the XPath expression to be evaluated
xPath, Map<String, String>
the map of namespace prefixes. Each key is a namespace prefix String that maps to a corresponding namespace URI String.
namespaceMap)

Creates an XPathFilterParameterSpec with the specified XPath expression and namespace map.

Method Summary

Modifier and TypeMethod and Description
public Map<String, String>

Returns:

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

Returns a map of namespace prefixes.

public String

Returns:

the XPath expression to be evaluated
getXPath()

Returns the XPath expression to be evaluated.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

nsMapback to summary
private final Map<String, String> nsMap
xPathback to summary
private final String xPath

Constructor Detail

XPathFilterParameterSpecback to summary
public XPathFilterParameterSpec(String xPath)

Creates an XPathFilterParameterSpec with the specified XPath expression.

Parameters
xPath:String

the XPath expression to be evaluated

Exceptions
NullPointerException:
if xPath is null
XPathFilterParameterSpecback to summary
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:String

the XPath expression to be evaluated

namespaceMap:Map<String, String>

the map of namespace prefixes. Each key is a namespace prefix String that maps to a corresponding namespace URI String.

Exceptions
NullPointerException:
if xPath or namespaceMap are null
ClassCastException:
if any of the map's keys or entries are not of type String

Method Detail

getNamespaceMapback to summary
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:Map<String, String>

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

getXPathback to summary
public String getXPath()

Returns the XPath expression to be evaluated.

Returns:String

the XPath expression to be evaluated