Implements org.w3c.dom.traversal.NodeIterator.detach.

Doc from org.w3c.dom.traversal.NodeIterator.detach.

Detaches the NodeIterator from the set which it iterated over, releasing any computational resources and placing the NodeIterator in the INVALID state. After detach has been invoked, calls to nextNode or previousNode will raise the exception INVALID_STATE_ERR.

Overrides java.lang.Object.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

• It is reflexive: for any non-null reference value x, x.equals(x) should return true.
• It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
• It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
• It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
• For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters

that:Object

the reference object with which to compare.

Returns:boolean

true if this object is the same as the obj argument; false otherwise.

Annotations

@Override

Implements org.w3c.dom.traversal.NodeIterator.getExpandEntityReferences.

Doc from org.w3c.dom.traversal.NodeIterator.getExpandEntityReferences.

The value of this flag determines whether the children of entity reference nodes are visible to the NodeIterator. If false, these children and their descendants will be rejected. Note that this rejection takes precedence over whatToShow and the filter. Also note that this is currently the only situation where NodeIterators may reject a complete subtree rather than skipping individual nodes.

To produce a view of the document that has entity references expanded and does not expose the entity reference node itself, use the whatToShow flags to hide the entity reference node and set expandEntityReferences to true when creating the NodeIterator. To produce a view of the document that has entity reference nodes but no entity expansion, use the whatToShow flags to show the entity reference node and set expandEntityReferences to false.

Implements org.w3c.dom.traversal.NodeIterator.getFilter.

Doc from org.w3c.dom.traversal.NodeIterator.getFilter.

The NodeFilter used to screen nodes.

Implements org.w3c.dom.traversal.NodeIterator.getRoot.

Doc from org.w3c.dom.traversal.NodeIterator.getRoot.

The root node of the NodeIterator, as specified when it was created.

Implements org.w3c.dom.traversal.NodeIterator.getWhatToShow.

Doc from org.w3c.dom.traversal.NodeIterator.getWhatToShow.

This attribute determines which node types are presented via the NodeIterator. The available set of constants is defined in the NodeFilter interface. Nodes not accepted by whatToShow will be skipped, but their children may still be considered. Note that this skip takes precedence over the filter, if any.

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

• Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
• If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
• It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

Returns:int

a hash code value for this object

Annotations

@Override

Implements org.w3c.dom.traversal.NodeIterator.nextNode.

Doc from org.w3c.dom.traversal.NodeIterator.nextNode.

Returns the next node in the set and advances the position of the NodeIterator in the set. After a NodeIterator is created, the first call to nextNode() returns the first node in the set.

Returns:Node

The next Node in the set being iterated over, or null if there are no more members in that set.

Implements org.w3c.dom.traversal.NodeIterator.previousNode.

Doc from org.w3c.dom.traversal.NodeIterator.previousNode.

Returns the previous node in the set and moves the position of the NodeIterator backwards in the set.

Returns:Node

The previous Node in the set being iterated over, or null if there are no more members in that set.