org.vishia.util

Interface TreeNodeCallback<DerivedNode extends TreeNodeBase<DerivedNode,?,?>>

All Known Implementing Classes:

CallbackTemplate

public interface TreeNodeCallback<DerivedNode extends TreeNodeBase<DerivedNode,?,?>>

This interface is used as callback for any walk action through a tree structure. It is similar like the concept of Files.walkFileTree(java.nio.file.Path, java.nio.file.FileVisitor) with its visitor interface. But it is used for more as file access.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	TreeNodeCallback.Result It is similar FileVisitResult.

Method Summary

Modifier and Type	Method and Description
void	finished() Invoked after finishing a .
TreeNodeCallback.Result	finishedChildren(DerivedNode node) Invoked on end of walking through children of its parent.
TreeNodeCallback.Result	offerLeaf(DerivedNode node) Invoked for any node which has no children.
TreeNodeCallback.Result	offerParent(DerivedNode node) Invoked for any parent which has children.
boolean	shouldAborted() Checks whether the tree walking should be terminated respectively aborted.
void	start() Invoked before start of Files.walkFileTree(java.nio.file.Path, java.util.Set, int, java.nio.file.FileVisitor).

Method Detail

start

void start()

Invoked before start of Files.walkFileTree(java.nio.file.Path, java.util.Set, int, java.nio.file.FileVisitor). or an adequate communication.

offerParent

TreeNodeCallback.Result offerParent(DerivedNode node)

Invoked for any parent which has children.

Parameters:

node - a node which has children.

Returns:

information to abort

finishedChildren

TreeNodeCallback.Result finishedChildren(DerivedNode node)

Invoked on end of walking through children of its parent.

Parameters:

node - a node which has children.

Returns:

information to abort

offerLeaf

TreeNodeCallback.Result offerLeaf(DerivedNode node)

Invoked for any node which has no children.

Parameters:

node - a node which has children.

Returns:

information to abort

finished

void finished()

Invoked after finishing a .

shouldAborted

boolean shouldAborted()

Checks whether the tree walking should be terminated respectively aborted. This routine is called in any walk tree routine. The aborted state should be set from outside in the implementation classes.

Returns:

true if should terminated.