com.xmlmind.xml.load

Class InclusionTraversal

java.lang.Object

com.xmlmind.xml.load.InclusionTraversal

public final class InclusionTraversal
extends Object

Utility class used to visit all the Inclusions found in a document subtree. Note that nested inclusions are not visited. Only top inclusions are.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	InclusionTraversal.Handler Interface implemented by an Object wishing to visit all the Inclusions found in a document subtree.

Method Summary

Modifier and Type	Method and Description
static Object	traverse(Tree tree, InclusionTraversal.Handler handler) Traverse specified document subtree, invoking specified handler for each found inclusion.

Methods inherited from class java.lang.Object

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

Method Detail

traverse

public static Object traverse(Tree tree,
                              InclusionTraversal.Handler handler)

Traverse specified document subtree, invoking specified handler for each found inclusion.

Parameters:

tree - Document subtree to be traversed.

handler - Invoked each time an inclusion is found.

Returns:

First non null Object returned by handler (this has the effect to stop the traversal); otherwise null.