Class XPathType
java.lang.Object
javax.xml.crypto.dsig.spec.XPathType
public class XPathType extends Object
The XML Schema Definition of the
XPath
element as defined in the W3C Recommendation for XML-Signature XPath Filter 2.0:
<schema xmlns="http://www.w3.org/2001/XMLSchema"
xmlns:xf="http://www.w3.org/2002/06/xmldsig-filter2"
targetNamespace="http://www.w3.org/2002/06/xmldsig-filter2"
version="0.1" elementFormDefault="qualified">
<element name="XPath"
type="xf:XPathType"/>
<complexType name="XPathType">
<simpleContent>
<extension base="string">
<attribute name="Filter">
<simpleType>
<restriction base="string">
<enumeration value="intersect"/>
<enumeration value="subtract"/>
<enumeration value="union"/>
</restriction>
</simpleType>
</attribute>
</extension>
</simpleContent>
</complexType>
- Since:
- 1.6
- See Also:
Nested Class Summary
Modifier and Type | Class | Description |
---|---|---|
static class |
XPathType.Filter |
Represents the filter set operation. |
Constructor Summary
Constructor | Description |
---|---|
XPathType |
Creates an XPathType instance with the specified XPath expression and filter. |
XPathType |
Creates an XPathType instance with the specified XPath expression, filter, and namespace map. |
Method Summary
Modifier and Type | Method | Description |
---|---|---|
String |
getExpression() |
Returns the XPath expression to be evaluated. |
XPathType.Filter |
getFilter() |
Returns the filter operation. |
Map<String, |
getNamespaceMap() |
Returns a map of namespace prefixes. |
Constructor Details
XPathType
public XPathType(String expression, XPathType.Filter filter)
Creates an
XPathType
instance with the specified XPath expression and filter.- Parameters:
-
expression
- the XPath expression to be evaluated -
filter
- the filter operation (XPathType.Filter.INTERSECT
,XPathType.Filter.SUBTRACT
, orXPathType.Filter.UNION
) - Throws:
-
NullPointerException
- ifexpression
orfilter
isnull
XPathType
public XPathType(String expression, XPathType.Filter filter, Map<String,String> namespaceMap)
Creates an
XPathType
instance with the specified XPath expression, filter, and namespace map. The map is copied to protect against subsequent modification.- Parameters:
-
expression
- the XPath expression to be evaluated -
filter
- the filter operation (XPathType.Filter.INTERSECT
,XPathType.Filter.SUBTRACT
, orXPathType.Filter.UNION
) -
namespaceMap
- the map of namespace prefixes. Each key is a namespace prefixString
that maps to a corresponding namespace URIString
. - Throws:
-
NullPointerException
- ifexpression
,filter
ornamespaceMap
arenull
-
ClassCastException
- if any of the map's keys or entries are not of typeString
Method Details
getExpression
public String getExpression()
Returns the XPath expression to be evaluated.
- Returns:
- the XPath expression to be evaluated
getFilter
public XPathType.Filter getFilter()
Returns the filter operation.
- Returns:
- the filter operation
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 nevernull
)
© 1993, 2021, 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/17/docs/api/java.xml.crypto/javax/xml/crypto/dsig/spec/XPathType.html