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 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 null.
Two additional methods are called at the beginning (startDirectory) and at the end (endDirectory) of a directory. If the startDirectory method returns false, nothing more is done for this directory.
It is important to note that methods are called inside a drive task, so it can call methods to retrieve information about the discovered file or directory, but must not do CPU consuming computing, else a separate CPU task must be used.

Constructor Summary

Constructors

Constructor and Description
DirectoryWalker(File root) Constructor.

Method Summary

Modifier and Type	Method and Description
protected void	accessDenied(File dir)
protected T	directoryFound(T parent, File dir)
protected void	endDirectory(File dir, T dirObj)
protected void	fileFound(T parent, File file)
ISynchronizationPoint<IOException>	start(byte priority) Start the directory analysis.
protected boolean	startDirectory(File dir, T dirObj)

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)

Constructor.

Method Detail

start

public ISynchronizationPoint<IOException> start(byte priority)

Start the directory analysis.

startDirectory

protected boolean startDirectory(File dir,
                                 T dirObj)

endDirectory

protected void endDirectory(File dir,
                            T dirObj)

accessDenied

protected void accessDenied(File dir)

directoryFound

protected T directoryFound(T parent,
                           File dir)

fileFound

protected void fileFound(T parent,
                         File file)