com.github.jjYBdx4IL.utils.io

Class FileScanner

java.lang.Object

org.apache.commons.io.DirectoryWalker<File>

com.github.jjYBdx4IL.utils.io.FileScanner

public class FileScanner
extends org.apache.commons.io.DirectoryWalker<File>

Author:

Github jjYBdx4IL Projects

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.commons.io.DirectoryWalker

org.apache.commons.io.DirectoryWalker.CancelException

Constructor Summary

Constructors

Constructor and Description
FileScanner()
FileScanner(boolean relativize)
FileScanner(Pattern regex)
FileScanner(Pattern regex, boolean relativize)
FileScanner(String regex)
FileScanner(String regex, boolean relativize)

Method Summary

Modifier and Type	Method and Description
FileScanner	disableFileListPopulation()
List<File>	getFiles(File startDirectory) Returns a list of files.
void	handleFile(File file) Overwrite this method to process files on the fly.
protected void	handleFile(File file, int depth, Collection<File> results)
List<File>	scanFiles(File startDirectory)

Methods inherited from class org.apache.commons.io.DirectoryWalker

checkIfCancelled, filterDirectoryContents, handleCancelled, handleDirectory, handleDirectoryEnd, handleDirectoryStart, handleEnd, handleIsCancelled, handleRestricted, handleStart, walk

Methods inherited from class java.lang.Object

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

Constructor Detail

FileScanner

public FileScanner()

FileScanner

public FileScanner(String regex)

FileScanner

public FileScanner(Pattern regex)

FileScanner

public FileScanner(boolean relativize)

FileScanner

public FileScanner(String regex,
                   boolean relativize)

FileScanner

public FileScanner(Pattern regex,
                   boolean relativize)

Method Detail

disableFileListPopulation

public FileScanner disableFileListPopulation()

scanFiles

public List<File> scanFiles(File startDirectory)
                     throws IOException

Throws:

IOException

getFiles

public List<File> getFiles(File startDirectory)
                    throws IOException

Returns a list of files.

Parameters:

startDirectory - the root directory for the search

Returns:

the list of matching files

Throws:

IOException - if there is a problem with I/O

handleFile

protected void handleFile(File file,
                          int depth,
                          Collection<File> results)
                   throws IOException

Overrides:

handleFile in class org.apache.commons.io.DirectoryWalker<File>

Throws:

IOException

handleFile

public void handleFile(File file)
                throws IOException

Overwrite this method to process files on the fly.

Parameters:

file - the file

Throws:

IOException - if the is an I/O problem