javax.xml.crypto.dsig.spec
class XPathFilterParameterSpec

java.lang.Object javax.xml.crypto.dsig.spec.XPathFilterParameterSpec

All Implemented Interfaces:

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

XPathFilterParameterSpec

public XPathFilterParameterSpec(String xPath)

Creates an XPathFilterParameterSpec with the specified XPath expression.

Parameters:

xPath - the XPath expression to be evaluated

XPathFilterParameterSpec

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.

getNamespaceMap

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 {@link Collections#unmodifiableMap unmodifiable map}.

Returns:

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

getXPath

public String getXPath()

Returns the XPath expression to be evaluated.

Returns:

the XPath expression to be evaluated