org.apache.axiom.om.impl.traverse
Class OMChildrenQNameIterator

java.lang.Object
  org.apache.axiom.om.impl.traverse.OMFilterIterator
      org.apache.axiom.om.impl.traverse.OMChildrenQNameIterator

All Implemented Interfaces:

java.util.Iterator

Direct Known Subclasses:

OMChildrenLegacyQNameIterator, OMChildrenLocalNameIterator, OMChildrenNamespaceIterator

public class OMChildrenQNameIterator
extends OMFilterIterator

Class OMChildrenQNameIterator This iterator returns the elements that have a matching QName. This class can be extended to customize the QName equality.

Constructor Summary

OMChildrenQNameIterator(OMNode currentChild, javax.xml.namespace.QName givenQName)
Constructor OMChildrenQNameIterator.

Method Summary

boolean	isEqual(javax.xml.namespace.QName searchQName, javax.xml.namespace.QName currentQName) Returns true if the qnames are equal.
static boolean	isEquals_Legacy(javax.xml.namespace.QName searchQName, javax.xml.namespace.QName currentQName) Deprecated.
protected boolean	matches(OMNode node) Determine whether the given node matches the filter criteria.

Methods inherited from class org.apache.axiom.om.impl.traverse.OMFilterIterator

hasNext, next, remove

Methods inherited from class java.lang.Object

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

Constructor Detail

OMChildrenQNameIterator

public OMChildrenQNameIterator(OMNode currentChild,
                               javax.xml.namespace.QName givenQName)

Constructor OMChildrenQNameIterator.

Parameters:

currentChild -

givenQName -

Method Detail

isEqual

public boolean isEqual(javax.xml.namespace.QName searchQName,
                       javax.xml.namespace.QName currentQName)

Returns true if the qnames are equal. The default algorithm is to use the QName equality (which examines the namespace and localPart). You can extend this class to provide your own equality algorithm.

Parameters:

searchQName -

currentQName -

Returns:

true if qnames are equal.

matches

protected boolean matches(OMNode node)

Description copied from class: OMFilterIterator

Determine whether the given node matches the filter criteria.

Specified by:

matches in class OMFilterIterator

Parameters:

node - the node to test

Returns:

true if the node matches, i.e. if it should be returned by a call to OMFilterIterator.next()

isEquals_Legacy

public static boolean isEquals_Legacy(javax.xml.namespace.QName searchQName,
                                      javax.xml.namespace.QName currentQName)

Deprecated.

Prior versions of the OMChildrenQNameIterator used the following logic to check equality. This algorithm is incorrect; however some customers have dependency on this behavior. This method is retained (but deprecated) to allow them an opportunity to use the old algorithm.

Parameters:

searchQName -

currentQName -

Returns:

true using legacy equality match