W3cubDocs

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

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 java.lang.Object

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

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)

© 1993, 2023, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
https://docs.oracle.com/en/java/javase/21/docs/api/java.xml.crypto/javax/xml/crypto/dsig/spec/XPathFilterParameterSpec.html