com.steelypip.powerups.minxml

Class MinXMLSearcher

java.lang.Object

com.steelypip.powerups.minxml.MinXMLSearcher

public abstract class MinXMLSearcher
extends java.lang.Object

A convenience class for implementing a recursive walk of a tree with some control over the branches explored.

Constructor Summary

Constructors

Constructor and Description
MinXMLSearcher()

Method Summary

Modifier and Type	Method and Description
abstract boolean	endSearch(MinXML subject, boolean cutoff) endSearch is called at the end of the tree-walk of the subject and its children.
java.lang.Iterable<MinXML>	postOrder(MinXML subject)
java.lang.Iterable<MinXML>	preOrder(MinXML subject)
@Nullable MinXML	search(MinXML subject) The search method is used to implement basic recursive scans over a tree of elements.
abstract boolean	startSearch(MinXML subject) startSearch is called at the start of the tree-walk of the subject and its children.

Methods inherited from class java.lang.Object

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

Constructor Detail

MinXMLSearcher

public MinXMLSearcher()

Method Detail

startSearch

public abstract boolean startSearch(MinXML subject)

startSearch is called at the start of the tree-walk of the subject and its children. Return false if you want the the child elements to be visited, true otherwise.

Parameters:

subject - the MinXML element to be visited

Returns:

flag saying if the children were cutoff.

endSearch

public abstract boolean endSearch(MinXML subject,
                                  boolean cutoff)

endSearch is called at the end of the tree-walk of the subject and its children. Return false normally but true to signal to the parent that the iteration over the child nodes can be stopped early. The found flag indicates if any child search found the goal, it is the short-circuit OR of all the flags returned by the children's endVisits.

Parameters:

subject - the MinXML element to be visited.

cutoff - flag indicating if any child search was cutoff.

Returns:

boolean a flag saying if sibling-search should be cutoff.

search

public @Nullable MinXML search(MinXML subject)

The search method is used to implement basic recursive scans over a tree of elements. It is typically used to search a tree or to implement a series of in-place updates.

Parameters:

subject - the element tree to be searched

Returns:

a successful node, otherwise null.

preOrder

public java.lang.Iterable<MinXML> preOrder(MinXML subject)

postOrder

public java.lang.Iterable<MinXML> postOrder(MinXML subject)