org.vishia.fileLocalAccessor

Class FileCallbackLocalCopy

java.lang.Object

org.vishia.fileLocalAccessor.FileCallbackLocalCopy

All Implemented Interfaces:

FileRemoteWalkerCallback, SortedTreeWalkerCallback<FileRemote,FileRemoteCmdEventData>

public class FileCallbackLocalCopy
extends java.lang.Object
implements FileRemoteWalkerCallback

This class contains the callback operations used for FileRemoteAccessor#walkFileTreeCheck(FileRemote, boolean, boolean, boolean, String, long, int, FileRemoteWalkerCallback) to copy the content of a directory tree called in FileRemote#copyDirTreeTo(FileRemote, int, String, int, FileRemoteProgressEvData).

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	aborted
(package private) byte[]	buffer
private FileRemoteWalkerCallback	callbackUser
private FileRemote	dirDst
private EventWithDst<FileRemoteProgressEvData,?>	evBack Event instance for user callback.
(package private) int	mode
private FileRemoteProgressEvData	progress
static java.lang.String	sVersion Version, history and license.

Fields inherited from interface org.vishia.util.SortedTreeWalkerCallback

callbackTemplate

Constructor Summary

Constructors

Constructor and Description
FileCallbackLocalCopy(FileRemote dirDstStart, FileRemoteWalkerCallback callbackUser, EventWithDst<FileRemoteProgressEvData,?> evBack) Constructs an instance to execute a comparison of directory trees.

Method Summary

Modifier and Type	Method and Description
void	finished(FileRemote startDir) Invoked after finishing the walking through.
SortedTreeWalkerCallback.Result	finishedParentNode(FileRemote file, java.lang.Object oPath, java.lang.Object oWalkInfo) Checks whether all files are compared or whether there are alone files.
SortedTreeWalkerCallback.Result	offerLeafNode(FileRemote file, java.lang.Object info) This method creates a new file in the current dst directory with the same name as the given file.
SortedTreeWalkerCallback.Result	offerParentNode(FileRemote dir, java.lang.Object oPath, java.lang.Object filter) 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 startDir, 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

sVersion

public static final java.lang.String sVersion

Version, history and license.

• 2023-07-15 The exclusion of the first directory level with 'bFirst' is now no more necessary due to change in FileAccessorLocalJava7.WalkFileTreeVisitor.preVisitDirectory(Path, java.nio.file.attribute.BasicFileAttributes). There the first level does not call the offerParentNode(FileRemote, Object, Object) as general solution. It was obviously while working on delete, should not delete the src directory itself, then the bFirst was removed here (as another, but now seen as scratch, solution).
• 2023-04-09 improve: #offerLeafNode: Use Files#copy(Path, Path, CopyOption...) if possible. It is faster if both files are in network on the same drive. No network data transmission clarified by OS level.
• 2014-12-12 Hartmut new: {@link CompareCtrl}: Comparison with suppressed parts especially comments.
• 2013-09-19 created. Comparison in callback routine of walkThroughFiles instead in the graphic thread.

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

dirDst

private FileRemote dirDst

evBack

private final EventWithDst<FileRemoteProgressEvData,?> evBack

Event instance for user callback.

progress

private final FileRemoteProgressEvData progress

callbackUser

private final FileRemoteWalkerCallback callbackUser

mode

int mode

buffer

byte[] buffer

aborted

boolean aborted

Constructor Detail

FileCallbackLocalCopy

public FileCallbackLocalCopy(FileRemote dirDstStart,
                             FileRemoteWalkerCallback callbackUser,
                             EventWithDst<FileRemoteProgressEvData,?> evBack)

Constructs an instance to execute a comparison of directory trees.

Parameters:

dir1 -

dirDst -

evCallback - maybe null, if given, this event will be sent to show the progression of the comparison

Method Detail

start

public void start(FileRemote startDir,
                  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 dir,
                                                       java.lang.Object oPath,
                                                       java.lang.Object filter)

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

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

Returns:

information to abort, maybe boolean.

finishedParentNode

public SortedTreeWalkerCallback.Result finishedParentNode(FileRemote file,
                                                          java.lang.Object oPath,
                                                          java.lang.Object oWalkInfo)

Checks whether all files are compared or whether there are alone files.

Specified by:

finishedParentNode in interface SortedTreeWalkerCallback<FileRemote,FileRemoteCmdEventData>

Parameters:

file - 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 file,
                                                     java.lang.Object info)

This method creates a new file in the current dst directory with the same name as the given file. Note: because the FileRemote concept the file can be located on any remote device.

Specified by:

offerLeafNode in interface SortedTreeWalkerCallback<FileRemote,FileRemoteCmdEventData>

Returns:

information to abort or continue.

See Also:

org.vishia.util.SortedTreeWalkerCallback#offerLeafNode(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<FileRemote,FileRemoteCmdEventData>

Returns:

true if should terminated.

finished

public void finished(FileRemote startDir)

Description copied from interface: SortedTreeWalkerCallback

Invoked after finishing the walking through.

Specified by:

finished in interface SortedTreeWalkerCallback<FileRemote,FileRemoteCmdEventData>