com.xmlmind.xml.load

Interface InclusionTraversal.Handler

All Known Implementing Classes:

InclusionUpdater, UpdateInclusions, UpdateInclusionsCmd

Enclosing class:

InclusionTraversal

public 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
Object	processInclusion(Inclusion inclusion, Node firstIncludedNode, Node lastIncludedNode) Invoked during the traversal of a document subtree for each inclusion encountered.

Method Detail

processInclusion

Object processInclusion(Inclusion inclusion,
                        Node firstIncludedNode,
                        Node lastIncludedNode)

Invoked during the traversal of a document subtree for each inclusion encountered.

Parameters:

inclusion - The currently visited inclusion.

firstIncludedNode - First included node.

lastIncludedNode - Last included node. Often the same node as firstIncludedNode.

Returns:

null to proceed; any other value to stop the traversal. In the later case, the Object returned by this method is the Object returned by InclusionTraversal.traverse(com.xmlmind.xml.doc.Tree, com.xmlmind.xml.load.InclusionTraversal.Handler).