org.apache.xml.security.signature.reference

Class ReferenceSubTreeData

java.lang.Object

org.apache.xml.security.signature.reference.ReferenceSubTreeData

All Implemented Interfaces:

ReferenceData, ReferenceNodeSetData

public class ReferenceSubTreeData
extends Object
implements ReferenceNodeSetData

A representation of a ReferenceNodeSetData type containing a node-set. This is a subtype of NodeSetData that represents a dereferenced same-document URI as the root of a subdocument. The main reason is for efficiency and performance, as some transforms can operate directly on the subdocument and there is no need to convert it first to an XPath node-set.

Constructor Summary

Constructors

Constructor and Description
ReferenceSubTreeData(Node root, boolean excludeComments)

Method Summary

Modifier and Type	Method and Description
boolean	excludeComments()
Node	getRoot()
Iterator<Node>	iterator() Returns a read-only iterator over the nodes contained in this NodeSetData in document order.

Methods inherited from class java.lang.Object

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

Constructor Detail

ReferenceSubTreeData

public ReferenceSubTreeData(Node root,
                            boolean excludeComments)

Method Detail

iterator

public Iterator<Node> iterator()

Description copied from interface: ReferenceNodeSetData

Returns a read-only iterator over the nodes contained in this NodeSetData in document order. Attempts to modify the returned iterator via the remove method throw UnsupportedOperationException.

Specified by:

iterator in interface ReferenceNodeSetData

Returns:

an Iterator over the nodes in this NodeSetData in document order

getRoot

public Node getRoot()

excludeComments

public boolean excludeComments()