org.vishia.util

Interface SortedTreeWalkerCallback<TypeNode,TypeStartInfo>

Type Parameters:

TypeNode - The type of a node which may have children or it is a leaf.

TypeStartInfo - this is a specific type of data which describes the condition of walking

All Known Subinterfaces:

FileRemoteWalkerCallback

All Known Implementing Classes:

FileCallbackLocalCmp, FileCallbackLocalCopy, FileCallbackLocalDelete, FileRemoteCallbackCopyDispersedFiles, FileRemoteCallbackSearch, FileRemoteTestCallback, FileRemoteWalkerCallbackCopy, FileRemoteWalkerCallbackDelete, FileRemoteWalkerCallbackLog, TreeWalkerPathCheck

public interface SortedTreeWalkerCallback<TypeNode,TypeStartInfo>

A Callback interface for walking through any tree with more as one children per node. The concept is similar the Files.walkFileTree(java.nio.file.Path, java.nio.file.FileVisitor) callback interface. but with a more universal approach and concept.

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field and Description
static SortedTreeWalkerCallback<java.lang.Object,java.lang.Object>	callbackTemplate Use this as template for anonymous implementation.
static java.lang.String	sVersion Version, history and license.

Method Summary

Modifier and Type	Method and Description
void	finished(TypeNode startNode) Invoked after finishing the walking through.
SortedTreeWalkerCallback.Result	finishedParentNode(TypeNode parentNode, java.lang.Object data, java.lang.Object oWalkInfo) Invoked on end of walking through a parent node.
SortedTreeWalkerCallback.Result	offerLeafNode(TypeNode leafNode, java.lang.Object leafNodeData) Invoked for any node which has no children or which is not processed because the depth of walking through the tree is reached.
SortedTreeWalkerCallback.Result	offerParentNode(TypeNode parentNode, java.lang.Object data, java.lang.Object oWalkInfo) Invoked on start on walking through a parent node which have children.
boolean	shouldAborted() Returns true if the tree walking should be terminated respectively aborted.
void	start(TypeNode startNode, TypeStartInfo startInfo) Invoked before start of a walk through the tree.

Field Detail

sVersion

static final java.lang.String sVersion

Version, history and license.

• 2023-07-15 Hartmut enhanced with TypeStartInfo and Object data for offerLeafNode(Object, Object) etc. It is used for FileRemoteWalkerCallback to inform about the implementation data java.nio.file.Path
• 2014-12-24 Hartmut created from the more special interface FileRemoteWalkerCallback.

Copyright/Copyleft: For this source the LGPL Lesser General Public License, published by the Free Software Foundation is valid. It means:

1. You can use this source without any restriction for any desired purpose.
2. You can redistribute copies of this source to everybody.
3. Every user of this source, also the user of redistribute copies with or without payment, must accept this license for further using.
4. But the LPGL is not appropriate for a whole software product, if this source is only a part of them. It means, the user must publish this part of source, but don't need to publish the whole source of the own product.
5. You can study and modify (improve) this source for own using or for redistribution, but you have to license the modified sources likewise under this LGPL Lesser General Public License. You mustn't delete this Copyright/Copyleft inscription in this source file.

If you are intent to use this sources without publishing its usage, you can get a second license subscribing a special contract with the author.

See Also:

Constant Field Values

callbackTemplate

static final SortedTreeWalkerCallback<java.lang.Object,java.lang.Object> callbackTemplate

Use this as template for anonymous implementation. Frequently without 'static'.

Method Detail

start

void start(TypeNode startNode,
           TypeStartInfo startInfo)

Invoked before start of a walk through the tree.

offerParentNode

SortedTreeWalkerCallback.Result offerParentNode(TypeNode parentNode,
                                                java.lang.Object data,
                                                java.lang.Object oWalkInfo)

Invoked on start on walking through a parent node which have children. It may be a directory inside a file tree. If this method is invoked for a node, the #offerLeafNode(TypeNode) is not invoked.

Parameters:

parentNode -

data - Specific data presentation of the node

oWalkInfo - internal possible information about walking, depending on usage.

Returns:

information to abort, maybe boolean.

finishedParentNode

SortedTreeWalkerCallback.Result finishedParentNode(TypeNode parentNode,
                                                   java.lang.Object data,
                                                   java.lang.Object oWalkInfo)

Invoked on end of walking through a parent node.

Parameters:

parentNode - the node which was walked through

data - Specific data presentation of the node

oWalkInfo - internal possible information about walking, depending on usage.

offerLeafNode

SortedTreeWalkerCallback.Result offerLeafNode(TypeNode leafNode,
                                              java.lang.Object leafNodeData)

Invoked for any node which has no children or which is not processed because the depth of walking through the tree is reached. It is called in opposite to #offerLeafNode(Object), only one of both is called for a node. For example it is invoked for a sub directory only if the depth is reached and #offerParentNode(TypeNode) is not called.

Parameters:

leafNode -

data - Specific data presentation of the node

Returns:

information to abort or continue.

finished

void finished(TypeNode startNode)

Invoked after finishing the walking through.

shouldAborted

boolean shouldAborted()

Returns true if the tree walking should be terminated respectively aborted. This routine should be called in any walk tree routine. The aborted state should be set from outside in the implementation classes.

Returns:

true if should terminated.