FileWalker (PF-All 7.4.0 API)

java.lang.Object
- org.pfsw.file.FileWalker

```
public class FileWalker
extends java.lang.Object
```
This class provides services to navigate through a file directory and handle files that match a name filter.
It can be used either with a FileHandler or an IFileProcessor.

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`PATTERN_SEPARATOR` The character to be used to separate filename patterns (';') as String.
`static char`	`PATTERN_SEPARATOR_CHAR` The character to be used to separate filename patterns (';').
`static java.lang.String`	`RECURSIVE_DIR_WILDCARD` The wildcard pattern that indicates a recursive walk-through in a single string definition (i.e.

Constructor Summary

Constructors
Constructor and Description
`FileWalker(FileHandler handler)` Initialize the new instance with a file handler.
`FileWalker(FileHandler handler, char digitWildcard)` Initialize the new instance with a file handler and a wildcard character for digits.
`FileWalker(IFileProcessor processor)` Initialize the new instance with a file processor.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static FileWalker`	`create(FileHandler handler)` Creates a new instance with a file handler.
`static FileWalker`	`create(IFileProcessor processor)` Creates a new instance with a file processor.
`protected ExtendedFileFilter`	`createFileFilter()`
`protected boolean`	`directoryEnd(java.io.File dir)`
`protected boolean`	`directoryStart(java.io.File dir, int count)`
`protected java.lang.Character`	`getDigitWildcard()`
`protected char`	`getDigitWildcardChar()`
`protected FileHandler`	`getFileHandler()`
`protected IFileProcessor`	`getFileProcessor()`
`protected boolean`	`getGoOn()`
`boolean`	`getHandleContentBeforeDirectory()` Returns whether or not the contents of a directory should be walked through before the directory is passed to the file processor.
`static long`	`handleAll(java.lang.String startDir, FileHandler handler)` Creates a new instance and handles with the given file handler all files under the given start directory and its sub-directories.
`protected boolean`	`handleFile(java.io.File file)`
`protected boolean`	`hasDigitWildcard()`
`static long`	`processAll(java.lang.String startDir, IFileProcessor processor)` Creates a new instance and processes with the given file processor all files under the given start directory and its sub-directories.
`protected boolean`	`restrictedWilcardMatch()` Returns true to define that '*' wildcards don't match empty strings.
`protected long`	`scanDirectories(java.io.File startDir, java.io.FilenameFilter filter, boolean recursive, boolean subDirsFirst)`
`protected void`	`setDigitWildcard(java.lang.Character newValue)`
`FileWalker`	`setDigitWildcardChar(char digitWildcard)` Sets the given character as a wildcard character to match digits ('0'-'9') only.
`protected void`	`setFileHandler(FileHandler newValue)`
`protected void`	`setFileProcessor(IFileProcessor newValue)`
`protected void`	`setGoOn(boolean newValue)`
`FileWalker`	`setHandleContentBeforeDirectory(boolean newValue)` Defines whether or not the contents of a directory should be walked through before the directory is passed to the file handler.
`long`	`walkThrough(java.lang.String searchPattern)` Walks through all directories specified by the given pattern and calls the file handler or file processor for each file that matches the file part in the given pattern.
`long`	`walkThrough(java.lang.String dir, java.io.FilenameFilter filter, boolean recursive)` Walks through the given directory and optionally through all its sub-directories as well.
`long`	`walkThrough(java.lang.String dir, java.lang.String pattern, boolean recursive)` This method starts in the given directory to search for all files matching the given pattern(s).
`long`	`walkThroughAllRecursive(java.lang.String dir)` Walks through the given directory and all its sub-directories as well.
`long`	`walkThroughDirectories(java.lang.String startDir, java.io.FilenameFilter filter, boolean recursive)` Walks through the given start directory and optionally through all its sub-directories as well.
`long`	`walkThroughDirectoriesSubDirsFirst(java.lang.String startDir, java.io.FilenameFilter filter)` Walks through the given start directory and recursively through all its sub-directories.

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

- Field Detail
  - PATTERN_SEPARATOR_CHAR
```
public static final char PATTERN_SEPARATOR_CHAR
```
    The character to be used to separate filename patterns (';').
    
    See Also:
    
    Constant Field Values
  - PATTERN_SEPARATOR
```
public static final java.lang.String PATTERN_SEPARATOR
```
    The character to be used to separate filename patterns (';') as String.
    
    See Also:
    
    Constant Field Values
  - RECURSIVE_DIR_WILDCARD
```
public static final java.lang.String RECURSIVE_DIR_WILDCARD
```
    The wildcard pattern that indicates a recursive walk-through in a single string definition (i.e. "**").
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - FileWalker
```
public FileWalker(IFileProcessor processor)
```
    Initialize the new instance with a file processor.
  - FileWalker
```
public FileWalker(FileHandler handler)
```
    Initialize the new instance with a file handler.
  - FileWalker
```
public FileWalker(FileHandler handler,
                  char digitWildcard)
```
    Initialize the new instance with a file handler and a wildcard character for digits.
    
    Parameters:
    
    handler - The file handler that gets all found files
    
    digitWildcard - A character that is used as wildcard for digits in filname patterns
- Method Detail
  - create
```
public static FileWalker create(IFileProcessor processor)
```
    Creates a new instance with a file processor.
  - create
```
public static FileWalker create(FileHandler handler)
```
    Creates a new instance with a file handler.
  - processAll
```
public static long processAll(java.lang.String startDir,
                              IFileProcessor processor)
```
    Creates a new instance and processes with the given file processor all files under the given start directory and its sub-directories.
  - handleAll
```
public static long handleAll(java.lang.String startDir,
                             FileHandler handler)
```
    Creates a new instance and handles with the given file handler all files under the given start directory and its sub-directories.
  - walkThrough
```
public long walkThrough(java.lang.String dir,
                        java.lang.String pattern,
                        boolean recursive)
```
    This method starts in the given directory to search for all files matching the given pattern(s).
    There can be more than one pattern in the pattern parameter. They have to be separated by the PATTERN_SEPARATOR (';').
    If recursive is true it goes down to each subdirectory and doing the same there.
    For each matching file (non-directory) the defined FileHandler.handle() is called.
    
    Parameters:
    
    dir - The directory where to start
    
    pattern - The file name pattern(s) for filtering out the correct files ( wildcards '*' and '?' )
    
    recursive - If set to true, the file selection is going down to all subdirectories
    
    Returns:
    
    the number of found files, that have matched the given pattern.
  - walkThrough
```
public long walkThrough(java.lang.String searchPattern)
```
    Walks through all directories specified by the given pattern and calls the file handler or file processor for each file that matches the file part in the given pattern.
    The pattern may contain '**' in the path to define recursive walk through. The file part of the pattern may contain '*' and '?' and optionally the digit wildcard character for the files to be passed to the file handler or processor.
    Examples:
    "prog/lib\/**\/a*.jar" ==> Starts in directory prog\lib and walks recursive through all sub-directories to pass all files that match pattern "a*.jar" to the file handler.
    "d:/temp/tmp???.doc" ==> Passes all files that match pattern "tmp???.doc" to the file handler.
    
    Parameters:
    
    searchPattern - The pattern that specifies the path and files to walk through
  - walkThroughAllRecursive
```
public long walkThroughAllRecursive(java.lang.String dir)
```
    Walks through the given directory and all its sub-directories as well. Calls the file handler's handleFile() method or the file processor's processFile() for each file (not directory) found.
    
    Parameters:
    
    dir - The directory to start from.
    
    Returns:
    
    The number of files that have been processed.
  - walkThrough
```
public long walkThrough(java.lang.String dir,
                        java.io.FilenameFilter filter,
                        boolean recursive)
```
    Walks through the given directory and optionally through all its sub-directories as well. Calls the file handler's handleFile() method or the file processor's processFile() for each file (not directory) that matches the given filter.
    
    Parameters:
    
    dir - The directory to start from.
    
    filter - The filter that decides whether or not a file is passed to the FileHandler.
    
    recursive - If true all sub-directories are scanned as well.
    
    Returns:
    
    The number of files that have matched the filter and have been processed.
  - walkThroughDirectories
```
public long walkThroughDirectories(java.lang.String startDir,
                                   java.io.FilenameFilter filter,
                                   boolean recursive)
```
    Walks through the given start directory and optionally through all its sub-directories as well. Calls the file handler or file processor for each directory (not files) that match the given filter. However, it scans all directories, even those that do not match the filter.
    
    Parameters:
    
    startDir - The directory to start from.
    
    filter - The filter that decides whether or not a directory is passed to the FileHandler.
    
    recursive - If true all sub-directories are scanned as well.
    
    See Also:
    
    walkThroughDirectoriesSubDirsFirst(String, FilenameFilter)
  - walkThroughDirectoriesSubDirsFirst
```
public long walkThroughDirectoriesSubDirsFirst(java.lang.String startDir,
                                               java.io.FilenameFilter filter)
```
    Walks through the given start directory and recursively through all its sub-directories. Calls the file handler or file processor for each directory (not files) that matches the given filter. It walks down the hierarchy of sub-directories before it calls the handler/processor. That can be used for directory deletion. See FileDeleteProcessor. However, it scans all directories, even those that do not match the filter.
    
    Parameters:
    
    startDir - The directory to start from.
    
    filter - The filter that decides whether or not a directory is passed to the FileHandler.
    
    See Also:
    
    walkThroughDirectories(String, FilenameFilter, boolean)
  - setDigitWildcardChar
```
public FileWalker setDigitWildcardChar(char digitWildcard)
```
    Sets the given character as a wildcard character to match digits ('0'-'9') only.
    
    Parameters:
    
    digitWildcard - The placeholder character for digits
  - getHandleContentBeforeDirectory
```
public boolean getHandleContentBeforeDirectory()
```
    Returns whether or not the contents of a directory should be walked through before the directory is passed to the file processor.
    The default is false.
  - setHandleContentBeforeDirectory
```
public FileWalker setHandleContentBeforeDirectory(boolean newValue)
```
    Defines whether or not the contents of a directory should be walked through before the directory is passed to the file handler.
  - scanDirectories
```
protected long scanDirectories(java.io.File startDir,
                               java.io.FilenameFilter filter,
                               boolean recursive,
                               boolean subDirsFirst)
```
  - getDigitWildcardChar
```
protected char getDigitWildcardChar()
```
  - hasDigitWildcard
```
protected boolean hasDigitWildcard()
```
  - createFileFilter
```
protected ExtendedFileFilter createFileFilter()
```
  - restrictedWilcardMatch
```
protected boolean restrictedWilcardMatch()
```
    Returns true to define that '*' wildcards don't match empty strings. The default result is false. Subclasses may override this method to return true.
  - handleFile
```
protected boolean handleFile(java.io.File file)
```
  - directoryEnd
```
protected boolean directoryEnd(java.io.File dir)
```
  - directoryStart
```
protected boolean directoryStart(java.io.File dir,
                                 int count)
```
  - getFileHandler
```
protected FileHandler getFileHandler()
```
  - setFileHandler
```
protected void setFileHandler(FileHandler newValue)
```
  - getFileProcessor
```
protected IFileProcessor getFileProcessor()
```
  - setFileProcessor
```
protected void setFileProcessor(IFileProcessor newValue)
```
  - getGoOn
```
protected boolean getGoOn()
```
  - setGoOn
```
protected void setGoOn(boolean newValue)
```
  - getDigitWildcard
```
protected java.lang.Character getDigitWildcard()
```
  - setDigitWildcard
```
protected void setDigitWildcard(java.lang.Character newValue)
```

Class FileWalker

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

PATTERN_SEPARATOR_CHAR

PATTERN_SEPARATOR

RECURSIVE_DIR_WILDCARD

Constructor Detail

FileWalker

FileWalker

FileWalker

Method Detail

create

create

processAll

handleAll

walkThrough

walkThrough

walkThroughAllRecursive

walkThrough

walkThroughDirectories

walkThroughDirectoriesSubDirsFirst

setDigitWildcardChar

getHandleContentBeforeDirectory

setHandleContentBeforeDirectory

scanDirectories

getDigitWildcardChar

hasDigitWildcard

createFileFilter

restrictedWilcardMatch

handleFile

directoryEnd

directoryStart

getFileHandler

setFileHandler

getFileProcessor

setFileProcessor

getGoOn

setGoOn

getDigitWildcard

setDigitWildcard