DirectoryScanner

java.lang.Object

com.thoughtworks.qdox.directorywalker.DirectoryScanner

public class DirectoryScanner extends Object

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

Field Summary

Fields

Modifier and Type

Field

Description

private File

file

private Collection<Filter>

filters
Constructor Summary

Constructors

Constructor

Description

DirectoryScanner(File file)
Method Summary

Modifier and Type

Method

Description

void

addFilter(Filter filter)

Add a filter to this scanner.

List<File>

scan()

void

scan(FileVisitor fileVisitor)

Scans the directory.

private void

walk(FileVisitor visitor, File current)

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details
- file
  
  private File file
- filters
  
  private Collection<Filter> filters
Constructor Details
- DirectoryScanner
  
  public DirectoryScanner(File file)
  
  Parameters:
  
  file - the directory (or file) to scan
Method Details
- addFilter
  
  public void addFilter(Filter filter)
  
  Add a filter to this scanner.
  
  Parameters:
  
  filter - the filter
- scan
  
  public List<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.
- walk
  
  private void walk(FileVisitor visitor, File current)