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:

• XPathFilter2ParameterSpec

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	XPathType.Filter	Represents the filter set operation.

Constructor Summary

Constructors

Constructor	Description
XPathType(String expression, XPathType.Filter filter)	Creates an XPathType instance with the specified XPath expression and filter.
XPathType(String expression, XPathType.Filter filter, Map<String,String> namespaceMap)	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,String>	getNamespaceMap()	Returns a map of namespace prefixes.

Methods declared in class Object

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

Modifier and Type	Method	Description
protected Object	clone()	Creates and returns a copy of this object.
boolean	equals(Object obj)	Indicates whether some other object is "equal to" this one.
protected void	finalize()	Deprecated, for removal: This API element is subject to removal in a future version. Finalization is deprecated and subject to removal in a future release.
final Class<?>	getClass()	Returns the runtime class of this Object.
int	hashCode()	Returns a hash code value for this object.
final void	notify()	Wakes up a single thread that is waiting on this object's monitor.
final void	notifyAll()	Wakes up all threads that are waiting on this object's monitor.
String	toString()	Returns a string representation of the object.
final void	wait()	Causes the current thread to wait until it is awakened, typically by being notified or interrupted.
final void	wait(long timeoutMillis)	Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
final void	wait(long timeoutMillis, int nanos)	Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.

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, or XPathType.Filter.UNION)

Throws:

NullPointerException - if expression or filter is null

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, or XPathType.Filter.UNION)

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

Throws:

NullPointerException - if expression, filter or namespaceMap are null

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

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 never null)