org.vishia.fileRemote

Class FileRemoteWalkerCallbackLog

java.lang.Object

org.vishia.fileRemote.FileRemoteWalkerCallbackLog

All Implemented Interfaces:

FileRemoteWalkerCallback, SortedTreeWalkerCallback<FileRemote,FileRemoteCmdEventData>

public class FileRemoteWalkerCallbackLog
extends java.lang.Object
implements FileRemoteWalkerCallback

This class can be used to log all activity on walking through a file tree. It can be used also as template for own similar walkers, or to set for breakpoints.

Nested Class Summary

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

SortedTreeWalkerCallback.Result

Field Summary

Fields

Modifier and Type	Field and Description
(package private) boolean	bAnyFile
(package private) LogMessageStream	logout

Fields inherited from interface org.vishia.util.SortedTreeWalkerCallback

callbackTemplate, sVersion

Constructor Summary

Constructors

Constructor and Description
FileRemoteWalkerCallbackLog(java.io.File fOut, java.io.OutputStream out2, java.lang.Appendable out3, boolean bAnyFile)
FileRemoteWalkerCallbackLog(java.io.OutputStream out1, java.io.OutputStream out2, java.lang.Appendable out3, boolean bAnyFile)

Method Summary

Modifier and Type	Method and Description
void	finished(FileRemote startNode) Invoked after finishing the walking through.
SortedTreeWalkerCallback.Result	finishedParentNode(FileRemote parentNode, java.lang.Object oPath, java.lang.Object oWalkInfo) Invoked on end of walking through a parent node.
SortedTreeWalkerCallback.Result	offerLeafNode(FileRemote leafNode, 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(FileRemote parentNode, java.lang.Object oPath, 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(FileRemote startNode, FileRemoteCmdEventData co) 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

logout

final LogMessageStream logout

bAnyFile

final boolean bAnyFile

Constructor Detail

FileRemoteWalkerCallbackLog

public FileRemoteWalkerCallbackLog(java.io.OutputStream out1,
                                   java.io.OutputStream out2,
                                   java.lang.Appendable out3,
                                   boolean bAnyFile)

FileRemoteWalkerCallbackLog

public FileRemoteWalkerCallbackLog(java.io.File fOut,
                                   java.io.OutputStream out2,
                                   java.lang.Appendable out3,
                                   boolean bAnyFile)
                            throws java.io.IOException

Throws:

java.io.IOException

Method Detail

start

public void start(FileRemote startNode,
                  FileRemoteCmdEventData co)

Description copied from interface: SortedTreeWalkerCallback

Invoked before start of a walk through the tree.

Specified by:

start in interface SortedTreeWalkerCallback<FileRemote,FileRemoteCmdEventData>

offerParentNode

public SortedTreeWalkerCallback.Result offerParentNode(FileRemote parentNode,
                                                       java.lang.Object oPath,
                                                       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<FileRemote,FileRemoteCmdEventData>

oPath - 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(FileRemote 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<FileRemote,FileRemoteCmdEventData>

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(FileRemote leafNode,
                                                     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<FileRemote,FileRemoteCmdEventData>

Returns:

information to abort or continue.

finished

public void finished(FileRemote startNode)

Description copied from interface: SortedTreeWalkerCallback

Invoked after finishing the walking through.

Specified by:

finished in interface SortedTreeWalkerCallback<FileRemote,FileRemoteCmdEventData>

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<FileRemote,FileRemoteCmdEventData>

Returns:

true if should terminated.