org.vishia.fileRemote

Class FileRemoteWalkerCallbackCopy

java.lang.Object

org.vishia.event.EventConsumerAwait<FileRemoteProgressEvData,FileRemoteCmdEventData>

org.vishia.fileRemote.FileRemoteProgressEventConsumer

org.vishia.fileRemote.FileRemoteWalkerCallbackCopy

All Implemented Interfaces:

EventConsumer, FileRemoteWalkerCallback, SortedTreeWalkerCallback<FileRemote,FileRemoteCmdEventData>

public class FileRemoteWalkerCallbackCopy
extends FileRemoteProgressEventConsumer
implements FileRemoteWalkerCallback

This callback operations are used to copy files from walking to the FileRemote instances using FileRemote#walkLocal(org.vishia.fileRemote.FileRemoteCmdEventData.Cmd, FileRemote, int, int, String, int, int, FileRemoteWalkerCallback, FileRemoteCmdEventData, int, org.vishia.event.EventWithDst) An instance of this class is used for callback. For the copy itself it calls an operations of FileRemoteAccessor to copy on the device. Either one file is copied, or the directory tree is created which are designated, and then children should be copied.

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) FileRemote	dstDir
(package private) FileRemote	dstRootDir
(package private) FileRemote	srcRootDir

Fields inherited from class org.vishia.fileRemote.FileRemoteProgressEventConsumer

nrDirAvail, nrFilesAvail, nrofBytesAllAvail, version

Fields inherited from class org.vishia.event.EventConsumerAwait

bDone, cmdData, evBack, evThread, name, progressData, sError

Fields inherited from interface org.vishia.util.SortedTreeWalkerCallback

callbackTemplate, sVersion

Fields inherited from interface org.vishia.event.EventConsumer

mEventConsumed, mEventConsumerException, mEventConsumFinished, mEventDonotRelinquish, mMaskReservedHere

Constructor Summary

Constructors

Constructor and Description
FileRemoteWalkerCallbackCopy()

Method Summary

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

Methods inherited from class org.vishia.fileRemote.FileRemoteProgressEventConsumer

clean, setAvail

Methods inherited from class org.vishia.event.EventConsumerAwait

awaitExecution, done, evThread, processEvent, processEvent, setDone

Methods inherited from class java.lang.Object

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

Field Detail

srcRootDir

FileRemote srcRootDir

dstRootDir

FileRemote dstRootDir

dstDir

FileRemote dstDir

Constructor Detail

FileRemoteWalkerCallbackCopy

public FileRemoteWalkerCallbackCopy()

Method Detail

cleanSetDstDir

public void cleanSetDstDir(FileRemote dstDir)

start

public void start(FileRemote startNode,
                  FileRemoteCmdEventData startInfo)

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 data,
                                                       java.lang.Object oWalkInfo)

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>

data - Specific data presentation of the node

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

Returns:

information to abort, maybe boolean.

finishedParentNode

public SortedTreeWalkerCallback.Result finishedParentNode(FileRemote parentNode,
                                                          java.lang.Object data,
                                                          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

data - 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 leafNodeData)

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.