org.pf.file
Class FileFinder

java.lang.Object
  org.pf.file.FileFinder

All Implemented Interfaces:

FileHandler

public class FileFinder
extends Object
implements FileHandler

Helper class with convenient methods to find files.

Version:

1.2

Author:

Manfred Duchrow

Constructor Summary

protected

FileFinder() Initialize the new instance with default values.

Method Summary

protected File[]	collectFiles(String dir, String pattern, boolean recursive, Character digitWildcard)
boolean	directoryEnd(File dir) This method is called for each directory, that a FileWalker finished to walk through.
boolean	directoryStart(File dir, int count) This method is called for each directory, that a FileWalker starts to walk through.
static File	findFile(String filename) Tries to find the file with the given Name.
static File	findFileOnClasspath(String filename) Tries to find the file with the given Name on the classpath.
static File[]	findFiles(String dir, String pattern) Return all files that match the given pattern(s) start searching in the specified dir.
static File[]	findFiles(String dir, String pattern, boolean recursive) Return all files that match the given pattern(s) start searching in the specified dir.
static File[]	findFiles(String dir, String pattern, boolean recursive, char digitWildcard) Return all files that match the given pattern(s) start searching in the specified dir.
protected List	getCollectedFiles()
boolean	handleException(Exception ex, File file) This method is called for whenever an exception occurs in walking through the directories.
boolean	handleFile(File file) This method is called for each file, that a FileWalker instance finds.
protected void	setCollectedFiles(List newValue)

Methods inherited from class java.lang.Object

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

Constructor Detail

FileFinder

protected FileFinder()

Initialize the new instance with default values.

Method Detail

getCollectedFiles

protected List getCollectedFiles()

setCollectedFiles

protected void setCollectedFiles(List newValue)

findFileOnClasspath

public static File findFileOnClasspath(String filename)

Tries to find the file with the given Name on the classpath. If the file was found and really exists, then it will be returned. In all other cases null will be returned.

findFile

public static File findFile(String filename)

Tries to find the file with the given Name. First it looks if the file exists directly under the given name. If not, it searches the classpath to find it. If the file was found and really exists, then it will be returned. In all other cases null will be returned.

findFiles

public static File[] findFiles(String dir,
                               String pattern)

Return all files that match the given pattern(s) start searching in the specified dir. Searches in all sub directories as well. More than one pattern can be specified in parameter pattern. They have to be separated by ';'.

Parameters:

dir - The directory to start searching (must not be null)

pattern - The pattern(s) the filenames must match (must not be null )

Returns:

All file found that matched to at least one of the patterns

Throws:

IllegalArgumentException - If dir or pattern is null

findFiles

public static File[] findFiles(String dir,
                               String pattern,
                               boolean recursive)

Return all files that match the given pattern(s) start searching in the specified dir. Look into sub directories if recursive is true. More than one pattern can be specified in parameter pattern. They have to be separated by ';'.

Parameters:

dir - The directory to start searching (must not be null)

pattern - The pattern(s) the filenames must match (must not be null )

recursive - If false, only dir is searched, otherwise all sub directories as well

Returns:

All file found that matched to at least one of the patterns

Throws:

IllegalArgumentException - If dir or pattern is null

findFiles

public static File[] findFiles(String dir,
                               String pattern,
                               boolean recursive,
                               char digitWildcard)

Return all files that match the given pattern(s) start searching in the specified dir. Look into sub directories if recursive is true. Use the given digit wildcard in patterns to match single digits in filenames.
More than one pattern can be specified in parameter pattern. They have to be separated by ';'.

Parameters:

dir - The directory to start searching (must not be null)

pattern - The pattern(s) the filenames must match (must not be null )

recursive - If false, only dir is searched, otherwise all sub directories as well

digitWildcard - The wildcard character for digit representation in the pattern(s)

Returns:

All file found that matched to at least one of the patterns

Throws:

IllegalArgumentException - If dir or pattern is null

handleFile

public boolean handleFile(File file)

This method is called for each file, that a FileWalker instance finds. It must return true, if the FileWalker should continue. To stop the calling FileWalker it can return false.

Specified by:

handleFile in interface FileHandler

Parameters:

The - file, currently found by the FileWalker instance

Returns:

true to continue, false to terminate processing of files

handleException

public boolean handleException(Exception ex,
                               File file)

This method is called for whenever an exception occurs in walking through the directories.
The method must return true, if the FileWalker should continue. To stop the calling FileWalker it can return false.

Specified by:

handleException in interface FileHandler

Parameters:

ex - The exception to handle

The - file, currently found by the FileWalker instance

Returns:

true to continue, false to terminate processing of files

directoryEnd

public boolean directoryEnd(File dir)

This method is called for each directory, that a FileWalker finished to walk through. It must return true, if the FileWalker should continue. To stop the calling FileWalker it can return false.

Specified by:

directoryEnd in interface FileHandler

Parameters:

dir - The directory, the FileWalker has finished to walk through

Returns:

true to continue, false to terminate processing of files

directoryStart

public boolean directoryStart(File dir,
                              int count)

This method is called for each directory, that a FileWalker starts to walk through. It must return true, if the FileWalker should continue. To stop the calling FileWalker it can return false.

Specified by:

directoryStart in interface FileHandler

Parameters:

dir - The directory, the FileWalker is starting to walk through

count - The number of files and directories the FileWalker found in the directory

Returns:

true to continue, false to terminate processing of files

collectFiles

protected File[] collectFiles(String dir,
                              String pattern,
                              boolean recursive,
                              Character digitWildcard)