com.thoughtworks.qdox.directorywalker

Class DirectoryScanner

java.lang.Object

com.thoughtworks.qdox.directorywalker.DirectoryScanner

public class DirectoryScanner
extends java.lang.Object

A directory scanner, which can scan files based on optional filters.

Constructor Summary

Constructors

Constructor and Description
DirectoryScanner(java.io.File file)

Method Summary

Modifier and Type	Method and Description
void	addFilter(Filter filter) Add a filter to this scanner.
java.util.List<java.io.File>	scan()
void	scan(FileVisitor fileVisitor) Scans the directory.

Methods inherited from class java.lang.Object

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

Constructor Detail

DirectoryScanner

public DirectoryScanner(java.io.File file)

Parameters:

file - the directory (or file) to scan

Method Detail

addFilter

public void addFilter(Filter filter)

Add a filter to this scanner.

Parameters:

filter - the filter

scan

public java.util.List<java.io.File> scan()

Returns:

a list of files matching the filters, never null

scan

public void scan(FileVisitor fileVisitor)

Scans the directory. Every file not filtered out by a filter fill be passed to the fileVisitor

Parameters:

fileVisitor - handler for matching files.