edu.ucla.sspace.util

Class DirectoryWalker

java.lang.Object

edu.ucla.sspace.util.DirectoryWalker

All Implemented Interfaces:

Iterable<File>

public class DirectoryWalker
extends Object
implements Iterable<File>

A utility class that allows for easy iteration over all the files within a directory and its subdirectories (but not returning the directories themselves). This class also provides the ability to limit the returned files on the basis of a suffix, or a custom file file filter. This class enables code such as:

 for (File f : new DirectoryWalker(dirName)) { 
     // process f
 }
 

Constructor Summary

Constructors

Constructor and Description
DirectoryWalker(File baseDir) Creates a DirectoryWalker that will return all files recursively accessible from the directory
DirectoryWalker(File baseDir, FileFilter filter) Creates a DirectoryWalker that will only return files that are acceptable by the filter.
DirectoryWalker(File baseDir, String suffix) Creates a DirectoryWalker that will only return files whose names end in the specified suffix

Method Summary

Methods

Modifier and Type	Method and Description
Iterator<File>	iterator() Returns an iterator over all the files recursively accessible from this FileWalker's base directory

Methods inherited from class java.lang.Object

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

Constructor Detail

DirectoryWalker

public DirectoryWalker(File baseDir)

Creates a DirectoryWalker that will return all files recursively accessible from the directory

Throws:

IllegalArgumentException - if baseDir is not a directory

DirectoryWalker

public DirectoryWalker(File baseDir,
               String suffix)

Creates a DirectoryWalker that will only return files whose names end in the specified suffix

Throws:

IllegalArgumentException - if baseDir is not a directory

DirectoryWalker

public DirectoryWalker(File baseDir,
               FileFilter filter)

Creates a DirectoryWalker that will only return files that are acceptable by the filter.

Parameters:

filter - the filter to use in deciding whether a file should be returned. This filter should always return true for directories

Throws:

IllegalArgumentException - if baseDir is not a directory

Method Detail

iterator

public Iterator<File> iterator()

Returns an iterator over all the files recursively accessible from this FileWalker's base directory

Specified by:

iterator in interface Iterable<File>