org.vishia.fileRemote

Class FileRemoteWalker

java.lang.Object

org.vishia.fileRemote.FileRemoteWalker

public class FileRemoteWalker
extends java.lang.Object

This class offers a walker similar as FileTreeWalker but it does only deal with the FileRemote instances. The access to the file system can be done in some callback operations.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	FileRemoteWalker.WalkInfo Data used for walk.
(package private) class	FileRemoteWalker.WalkThread Class to build a Thread instance to execute FileRemote#walkFileTree(int, FileRemoteWalkerCallback) in an extra thread.

Field Summary

Fields

Modifier and Type	Field and Description
(package private) FileRemoteWalkerCallback	callback
(package private) FileRemoteCmdEventData	co
(package private) EventWithDst<FileRemoteProgressEvData,?>	evBack
static java.lang.String	sVersion Version, history and license.
private FileRemoteWalker.WalkInfo	walkInfo

Constructor Summary

Constructors

Constructor and Description
FileRemoteWalker(FileRemoteCmdEventData co, EventWithDst<FileRemoteProgressEvData,?> evBack)

Method Summary

Modifier and Type	Method and Description
private SortedTreeWalkerCallback.Result	postVisitDirectory(FileRemote dir)
private SortedTreeWalkerCallback.Result	preVisitDirectory(FileRemote dir) pre visit a new found directory before enter all children Note: this is similar FileAccessorLocalJava7.WalkFileTreeVisitor#preVisitDirectory(Path, java.nio.file.attribute.BasicFileAttributes) but improved.
private SortedTreeWalkerCallback.Result	visitFile(FileRemote file)
protected void	walkFileTree()
static void	walkFileTree(FileRemoteCmdEventData co, EventWithDst<FileRemoteProgressEvData,?> evBack) Walks to the tree of children with given files, without synchronization with the device.
static void	walkFileTreeThread(FileRemoteCmdEventData co, EventWithDst<FileRemoteProgressEvData,?> evBack) Walks to the tree of children with given files, without synchronization with the device.
private SortedTreeWalkerCallback.Result	walkSubTree(FileRemote dir, int depth) See #walkFileTree(int, FileRemoteWalkerCallback), invoked internally recursively.

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. Changes:

• 2023-07-22 improved while test.
• 2023-07-18 Hartmut created with a new class, does only work with FileRemote instances.
• 201x Hartmut created as part of FileRemote. But the concept of separation of a remote file system in a device and the mapping to FileRemote instances was never consequently developed. Usual a mix of access to the local file system first via java.lang.File and then via Files was present.

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 ist 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

walkInfo

private FileRemoteWalker.WalkInfo walkInfo

co

final FileRemoteCmdEventData co

callback

final FileRemoteWalkerCallback callback

evBack

final EventWithDst<FileRemoteProgressEvData,?> evBack

Constructor Detail

FileRemoteWalker

public FileRemoteWalker(FileRemoteCmdEventData co,
                        EventWithDst<FileRemoteProgressEvData,?> evBack)

Method Detail

walkFileTree

public static void walkFileTree(FileRemoteCmdEventData co,
                                EventWithDst<FileRemoteProgressEvData,?> evBack)

Walks to the tree of children with given files, without synchronization with the device. To run this routine in an extra Thread use #walkFileTreeThread(int, FileRemoteWalkerCallback). This operation is not intent to use working with the real file system. For example #copyDirTreeTo(FileRemote, int, String, int, FileRemoteProgressEvData) calls internally FileRemoteAccessor#walkFileTree(FileRemote, boolean, boolean, boolean, String, long, int, FileRemoteWalkerCallback) which is implemented in the device, for example using java.nio.file.Files operations. This operation iterates only over the children and sub children in the FileRemote directory tree. Whether the FileRemote instances are synchronized with the file device or not, should be clarified in the callback. Note: it should not change the children list, because it uses an iterator.

Parameters:

depth - at least 1 for enter in the first directory. Use 0 if all levels should enter.

callback - contains the quest and operations due to the files.

walkFileTreeThread

public static void walkFileTreeThread(FileRemoteCmdEventData co,
                                      EventWithDst<FileRemoteProgressEvData,?> evBack)

Walks to the tree of children with given files, without synchronization with the device. This routine creates and starts a FileRemoteWalker.WalkThread and runs #walkFileTree(int, FileRemoteWalkerCallback) in that thread. The user is informed about progress and results via the callback instance. Note: The file tree should not be changed outside or inside the callback methods because the walk method uses an iterators. If the children lists are changed concurrently, then the walking procedure may be aborted because an ConcurrentModificationException is thrown.

Parameters:

depth - at least 1. Use 0 to enter all levels.

callback -

walkFileTree

protected void walkFileTree()

walkSubTree

private SortedTreeWalkerCallback.Result walkSubTree(FileRemote dir,
                                                    int depth)

See #walkFileTree(int, FileRemoteWalkerCallback), invoked internally recursively.

preVisitDirectory

private SortedTreeWalkerCallback.Result preVisitDirectory(FileRemote dir)

pre visit a new found directory before enter all children Note: this is similar FileAccessorLocalJava7.WalkFileTreeVisitor#preVisitDirectory(Path, java.nio.file.attribute.BasicFileAttributes) but improved. TODO improve also in Accessor

Parameters:

walkInfo -

co -

Returns:

postVisitDirectory

private SortedTreeWalkerCallback.Result postVisitDirectory(FileRemote dir)

visitFile

private SortedTreeWalkerCallback.Result visitFile(FileRemote file)