org.vishia.util

Class TreeWalkerPathCheck

java.lang.Object

org.vishia.util.TreeWalkerPathCheck

Type Parameters:

Type -

All Implemented Interfaces:

SortedTreeWalkerCallback<java.lang.String,java.lang.Object>

public class TreeWalkerPathCheck
extends java.lang.Object
implements SortedTreeWalkerCallback<java.lang.String,java.lang.Object>

This class is a tree walker which checks the names of nodes with a mask path.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private class	TreeWalkerPathCheck.CurrDirChildren Data chained from a first parent to deepness of dir tree for each level.

Nested classes/interfaces inherited from interface org.vishia.util.SortedTreeWalkerCallback

SortedTreeWalkerCallback.Result

Field Summary

Fields

Modifier and Type	Field and Description
(package private) PathCheck	check
private TreeWalkerPathCheck.CurrDirChildren	curr
static java.lang.String	sVersion Version, history and license.

Fields inherited from interface org.vishia.util.SortedTreeWalkerCallback

callbackTemplate

Constructor Summary

Constructors

Constructor and Description
TreeWalkerPathCheck(java.lang.String sPathCheck)

Method Summary

Modifier and Type	Method and Description
void	finished(java.lang.String startNode) Invoked after finishing the walking through.
SortedTreeWalkerCallback.Result	finishedParentNode(java.lang.String parentNode, java.lang.Object oPath, java.lang.Object oWalkInfo) Invoked on end of walking through a parent node.
SortedTreeWalkerCallback.Result	offerLeafNode(java.lang.String sName, java.lang.Object info) 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(java.lang.String sName, java.lang.Object data, java.lang.Object walkInfo) 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(java.lang.String startNode, java.lang.Object info) Invoked before start of a walk through the tree.

Methods inherited from class java.lang.Object

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

Field Detail

sVersion

public static final java.lang.String sVersion

Version, history and license.

• 2023-07-15 adapted to changed SortedTreeWalkerCallback
• 2015-05-25 Hartmut created for walking through a file tree but with universal approach.

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

check

final PathCheck check

curr

private TreeWalkerPathCheck.CurrDirChildren curr

Constructor Detail

TreeWalkerPathCheck

public TreeWalkerPathCheck(java.lang.String sPathCheck)

Method Detail

start

public void start(java.lang.String startNode,
                  java.lang.Object info)

Description copied from interface: SortedTreeWalkerCallback

Invoked before start of a walk through the tree.

Specified by:

start in interface SortedTreeWalkerCallback<java.lang.String,java.lang.Object>

offerParentNode

public SortedTreeWalkerCallback.Result offerParentNode(java.lang.String sName,
                                                       java.lang.Object data,
                                                       java.lang.Object walkInfo)

Description copied from interface: SortedTreeWalkerCallback

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.

Specified by:

offerParentNode in interface SortedTreeWalkerCallback<java.lang.String,java.lang.Object>

data - Specific data presentation of the node

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

Returns:

information to abort, maybe boolean.

finishedParentNode

public SortedTreeWalkerCallback.Result finishedParentNode(java.lang.String parentNode,
                                                          java.lang.Object oPath,
                                                          java.lang.Object oWalkInfo)

Description copied from interface: SortedTreeWalkerCallback

Invoked on end of walking through a parent node.

Specified by:

finishedParentNode in interface SortedTreeWalkerCallback<java.lang.String,java.lang.Object>

Parameters:

parentNode - the node which was walked through

oPath - Specific data presentation of the node

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

offerLeafNode

public SortedTreeWalkerCallback.Result offerLeafNode(java.lang.String sName,
                                                     java.lang.Object info)

Description copied from interface: SortedTreeWalkerCallback

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.

Specified by:

offerLeafNode in interface SortedTreeWalkerCallback<java.lang.String,java.lang.Object>

Returns:

information to abort or continue.

finished

public void finished(java.lang.String startNode)

Description copied from interface: SortedTreeWalkerCallback

Invoked after finishing the walking through.

Specified by:

finished in interface SortedTreeWalkerCallback<java.lang.String,java.lang.Object>

shouldAborted

public boolean shouldAborted()

Description copied from interface: SortedTreeWalkerCallback

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.

Specified by:

shouldAborted in interface SortedTreeWalkerCallback<java.lang.String,java.lang.Object>

Returns:

true if should terminated.