bradleyross.library.helpers

Class DirWalker

java.lang.Object

bradleyross.library.helpers.DirWalker

All Implemented Interfaces:

Iterator<File>

public class DirWalker
extends Object
implements Iterator<File>

Generates an Iterator that will contain all of the files belonging to a directory file structure.

Author:

Bradley Ross

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	DirWalker.DirectoriesOnly FileFilter that only accepts directories.
protected class	DirWalker.DirIterator This iterates through the directories.
protected class	DirWalker.DummyFilter Dummy file filter that accepts all files and directories.
protected class	DirWalker.FilesOnly FileFilter that only accepts files.
class	DirWalker.Level This represents a level at a single depth in the tree search.
protected class	DirWalker.LocalIterator Iterator returning the files in a directory.

Field Summary

Fields

Modifier and Type	Field and Description
int	debugLevel Controls amount of diagnostic listing.
protected DirWalker.DirIterator	directories Instance of iterator for going through directories.
protected FileFilter	directoriesOnly Instance of directories only file filter.
protected boolean	done Set to true when no more items to be returned.
protected DirWalker.LocalIterator	files Instance of iterator for going through files in directory.
protected FileFilter	filesOnly Instance of files only file filter.
protected FileFilter	filter FileFilter to be applied against files before returning through iterator.
protected int	maxCount Maximum number of files to be returned.
protected File	root Root directory of directory structure.

Constructor Summary

Constructors

Constructor and Description
DirWalker(File rootValue) Constructor that results in list of all files that are children of root directory.
DirWalker(File rootValue, FileFilter filterValue) Constructor that results in a list that contains all files that are descendants of the root directory and satisfy the conditions contained in the file filter.

Method Summary

Methods

Modifier and Type	Method and Description
int	getDebugLevel() Getter for debugLevel property.
int	getMaxCount() Getter for maxCount property.
protected boolean	hasDirectories(File value) Indicates if a directory contains subdirectories.
protected boolean	hasFiles(File value) Indicates whether a directory contains files.
boolean	hasNext() Indicates whether there are more files in the list.
static void	main(String[] args) Test driver.
File	next() Returns next file in list.
void	remove() This is an optional method that is not implemented for this class.
void	setDebugLevel(int value) Setter for debugLevel property.
void	setMaxCount(int value) Setter for maxCount property.
void	test1(File value) Test program for Level class.
Iterator<File>	test2(File value) Test iterator for DirWalker class.

Methods inherited from class java.lang.Object

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

Field Detail

debugLevel

public int debugLevel

Controls amount of diagnostic listing.

The default value is zero. Higher values result in more information.

root

protected File root

Root directory of directory structure.

filter

protected FileFilter filter

FileFilter to be applied against files before returning through iterator.

done

protected boolean done

Set to true when no more items to be returned.

maxCount

protected int maxCount

Maximum number of files to be returned.

filesOnly

protected FileFilter filesOnly

Instance of files only file filter.

directoriesOnly

protected FileFilter directoriesOnly

Instance of directories only file filter.

directories

protected DirWalker.DirIterator directories

Instance of iterator for going through directories.

files

protected DirWalker.LocalIterator files

Instance of iterator for going through files in directory.

Constructor Detail

DirWalker

public DirWalker(File rootValue)
          throws IOException

Constructor that results in list of all files that are children of root directory.

Parameters:

rootValue - root directory

Throws:

IOException

DirWalker

public DirWalker(File rootValue,
         FileFilter filterValue)
          throws IOException

Constructor that results in a list that contains all files that are descendants of the root directory and satisfy the conditions contained in the file filter.

Parameters:

rootValue - root directory

filterValue - file filter

Throws:

IOException

Method Detail

getDebugLevel

public int getDebugLevel()

Getter for debugLevel property.

Returns:

value of property

setDebugLevel

public void setDebugLevel(int value)

Setter for debugLevel property.

Parameters:

value - value for property

getMaxCount

public int getMaxCount()

Getter for maxCount property.

Returns:

value of property

setMaxCount

public void setMaxCount(int value)

Setter for maxCount property.

Parameters:

value - value for property

hasFiles

protected boolean hasFiles(File value)

Indicates whether a directory contains files.

Parameters:

value - directory

Returns:

true if it contains files

hasDirectories

protected boolean hasDirectories(File value)

Indicates if a directory contains subdirectories.

Parameters:

value - directory

Returns:

true if it contains subdirectories

hasNext

public boolean hasNext()

Indicates whether there are more files in the list.

Specified by:

hasNext in interface Iterator<File>

Returns:

true if there are more items

next

public File next()

Returns next file in list.

Specified by:

next in interface Iterator<File>

Returns:

next file

remove

public void remove()

This is an optional method that is not implemented for this class.

Specified by:

remove in interface Iterator<File>

test1

public void test1(File value)
           throws IOException

Test program for Level class.

Parameters:

value - root directory

Throws:

IOException

test2

public Iterator<File> test2(File value)
                     throws IOException

Test iterator for DirWalker class.

Parameters:

value - root of directory structure

Returns:

iterator

Throws:

IOException

main

public static void main(String[] args)

Test driver.

Parameters:

args - - not used