net.lecousin.framework.util

Class DirectoryWalker<T>

java.lang.Object

net.lecousin.framework.util.DirectoryWalker<T>

Type Parameters:

T - the type of object returned by directoryFound

public abstract class DirectoryWalker<T>
extends Object

Utility class to go through a file system directory, calling methods when a directory or file is found.
When a directory is found, the method directoryFound is called and can return an object that will be passed to the subsequent calls to directoryFound and fileFound inside this directory. When a file or directory is found inside the root directory, the object is the one given in the constructor.
If the method directoryFound returns a null object, the directory won't be analyzed.
The methods are called inside a CPU task so the drive task manager is made available as soon as possible.

Constructor Summary

Constructors

Constructor and Description
DirectoryWalker(File root, T rootObject, DirectoryReader.Request request) Constructor.

Method Summary

Modifier and Type	Method and Description
protected void	accessDenied(File dir, String path)
protected abstract T	directoryFound(T parent, FileInfo dir, String path)
protected abstract void	fileFound(T parent, FileInfo file, String path)
IAsync<IOException>	start(byte priority, WorkProgress progress, long work) Start the directory analysis.

Methods inherited from class java.lang.Object

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

Constructor Detail

DirectoryWalker

public DirectoryWalker(File root,
                       T rootObject,
                       DirectoryReader.Request request)

Constructor.

Method Detail

start

public IAsync<IOException> start(byte priority,
                                 WorkProgress progress,
                                 long work)

Start the directory analysis.

accessDenied

protected void accessDenied(File dir,
                            String path)

directoryFound

protected abstract T directoryFound(T parent,
                                    FileInfo dir,
                                    String path)

fileFound

protected abstract void fileFound(T parent,
                                  FileInfo file,
                                  String path)