FindFile (Jodd API Documentation)

java.lang.Object
- jodd.io.findfile.FindFile<T>

Direct Known Subclasses:

RegExpFindFile, WildcardFindFile
```
public class FindFile<T extends FindFile>
extends java.lang.Object
```
Generic iterative file finder. Searches all files on specified search path. By default, it starts in whitelist mode, where everything is excluded. To search, you need to explicitly set include patterns. If no pattern is set, then the search starts in blacklist mode, where everything is included (search all).

See Also:
WildcardFindFile, RegExpFindFile, InExRules

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`FindFile.FileExtensionComparator`
`static class`	`FindFile.FileLastModifiedTimeComparator`
`static class`	`FindFile.FileNameComparator`
`protected class`	`FindFile.FilesIterator` Files iterator simply walks over files array.
`static class`	`FindFile.FolderFirstComparator`
`static class`	`FindFile.Match` Match type.

Field Summary

Fields
Modifier and Type	Field and Description
`protected boolean`	`includeDirs`
`protected boolean`	`includeFiles`
`protected java.io.File`	`lastFile`
`protected FindFile.Match`	`matchType`
`protected JoddArrayList<java.io.File>`	`pathList`
`protected JoddArrayList<java.io.File>`	`pathListOriginal`
`protected boolean`	`recursive`
`protected java.io.File`	`rootFile`
`protected java.lang.String`	`rootPath`
`protected InExRules<java.lang.String,java.lang.String>`	`rules`
`protected java.util.List<java.util.Comparator<java.io.File>>`	`sortComparators`
`protected JoddArrayList<FindFile.FilesIterator>`	`todoFiles`
`protected JoddArrayList<java.io.File>`	`todoFolders`
`protected boolean`	`walking`

Constructor Summary

Constructors
Constructor and Description

FindFile()

Constructors
Constructor and Description
`FindFile()`

Method Summary

Methods
Modifier and Type	Method and Description
`protected boolean`	`acceptFile(java.io.File file)` Determine if file is accepted, based on include and exclude rules.
`protected void`	`addComparator(java.util.Comparator<java.io.File> comparator)`
`protected void`	`addPath(java.io.File path)` Adds existing search path to the file list.
`protected InExRules`	`createRulesEngine()` Creates rule engine.
`T`	`exclude(java.lang.String... patterns)` Defines exclude patterns.
`T`	`exclude(java.lang.String pattern)` Defines exclude pattern.
`T`	`excludeAll()` Enables whitelist mode.
`void`	`find()` Performs scanning.
`void`	`find(FileConsumer fileConsumer)` Finds a file.
`protected java.lang.String`	`getMatchingFilePath(java.io.File file)` Resolves file path depending on `matching type` Returned path is formatted in unix style.
`FindFile.Match`	`getMatchType()`
`T`	`include(java.lang.String... patterns)` Defines include patterns.
`T`	`include(java.lang.String pattern)` Defines include pattern.
`T`	`includeAll()` Enables blacklist mode.
`protected void`	`init()` Initializes file walking.
`boolean`	`isIncludeDirs()`
`boolean`	`isIncludeFiles()`
`boolean`	`isRecursive()`
`boolean`	`isWalking()`
`java.util.Iterator<java.io.File>`	`iterator()` Returns file walking iterator.
`java.io.File`	`lastFile()` Returns last founded file.
`java.io.File`	`nextFile()` Finds the next file.
`void`	`reset()` Reset the search so it can be run again with very same parameters (and sorting options).
`T`	`searchPath(java.io.File... searchPath)` Specifies a set of search paths.
`T`	`searchPath(java.io.File searchPath)` Specifies single search path.
`T`	`searchPath(java.lang.String... searchPaths)` Specifies search paths.
`T`	`searchPath(java.lang.String searchPath)` Specifies the search path.
`T`	`searchPath(java.net.URI... searchPath)` Specifies the search path.
`T`	`searchPath(java.net.URI searchPath)` Specifies the search path.
`T`	`searchPath(java.net.URL... searchPath)` Specifies the search path.
`T`	`searchPath(java.net.URL searchPath)` Specifies the search path.
`T`	`setIncludeDirs(boolean includeDirs)` Include directories in search.
`T`	`setIncludeFiles(boolean includeFiles)` Include files in search.
`T`	`setMatchType(FindFile.Match match)` Set `matching type`.
`T`	`setRecursive(boolean recursive)` Activates recursive search.
`T`	`setWalking(boolean walking)` Sets the walking recursive mode.
`T`	`sortByExtension()` Sorts files by file extension.
`T`	`sortByExtensionDesc()` Sorts files by file extension descending.
`T`	`sortByName()` Sorts files by file name, using natural sort.
`T`	`sortByNameDesc()` Sorts files by file names descending, using natural sort.
`T`	`sortByTime()` Sorts files by last modified time.
`T`	`sortByTimeDesc()` Sorts files by last modified time descending.
`T`	`sortFoldersFirst()` Puts folders before files.
`T`	`sortFoldersLast()` Puts files before folders.
`T`	`sortNone()` Removes ALL sorting options.
`T`	`sortWith(java.util.Comparator<java.io.File> fileComparator)` Adds generic sorting.

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

- Field Detail
  - recursive
```
protected boolean recursive
```
  - includeDirs
```
protected boolean includeDirs
```
  - includeFiles
```
protected boolean includeFiles
```
  - walking
```
protected boolean walking
```
  - matchType
```
protected FindFile.Match matchType
```
  - rules
```
protected final InExRules<java.lang.String,java.lang.String> rules
```
  - pathList
```
protected JoddArrayList<java.io.File> pathList
```
  - pathListOriginal
```
protected JoddArrayList<java.io.File> pathListOriginal
```
  - todoFolders
```
protected JoddArrayList<java.io.File> todoFolders
```
  - todoFiles
```
protected JoddArrayList<FindFile.FilesIterator> todoFiles
```
  - lastFile
```
protected java.io.File lastFile
```
  - rootFile
```
protected java.io.File rootFile
```
  - rootPath
```
protected java.lang.String rootPath
```
  - sortComparators
```
protected java.util.List<java.util.Comparator<java.io.File>> sortComparators
```
- Constructor Detail
  - FindFile
```
public FindFile()
```
- Method Detail
  - isRecursive
```
public boolean isRecursive()
```
  - setRecursive
```
public T setRecursive(boolean recursive)
```
    Activates recursive search.
  - isIncludeDirs
```
public boolean isIncludeDirs()
```
  - setIncludeDirs
```
public T setIncludeDirs(boolean includeDirs)
```
    Include directories in search.
  - isIncludeFiles
```
public boolean isIncludeFiles()
```
  - setIncludeFiles
```
public T setIncludeFiles(boolean includeFiles)
```
    Include files in search.
  - isWalking
```
public boolean isWalking()
```
  - setWalking
```
public T setWalking(boolean walking)
```
    Sets the walking recursive mode. When walking mode is on (by default), folders are walked immediately. Although natural, for large set of files, this is not memory-optimal approach, since many files are held in memory, when going deeper.
    When walking mode is turned off, folders are processed once all files are processed, one after the other. The order is not natural, but memory consumption is optimal.
    
    See Also:
    setRecursive(boolean)
  - getMatchType
```
public FindFile.Match getMatchType()
```
  - setMatchType
```
public T setMatchType(FindFile.Match match)
```
    Set matching type.
  - searchPath
```
public T searchPath(java.io.File searchPath)
```
    Specifies single search path.
  - searchPath
```
public T searchPath(java.io.File... searchPath)
```
    Specifies a set of search paths.
  - searchPath
```
public T searchPath(java.lang.String searchPath)
```
    Specifies the search path. If provided path contains File.pathSeparator than string will be tokenized and each part will be added separately as a search path.
  - searchPath
```
public T searchPath(java.lang.String... searchPaths)
```
    Specifies search paths.
    
    See Also:
    searchPath(String)
  - searchPath
```
public T searchPath(java.net.URI searchPath)
```
    Specifies the search path. Throws an exception if URI is invalid.
  - searchPath
```
public T searchPath(java.net.URI... searchPath)
```
    Specifies the search path.
  - searchPath
```
public T searchPath(java.net.URL searchPath)
```
    Specifies the search path. Throws an exception if URL is invalid.
  - searchPath
```
public T searchPath(java.net.URL... searchPath)
```
    Specifies the search path.
  - createRulesEngine
```
protected InExRules createRulesEngine()
```
    Creates rule engine.
  - include
```
public T include(java.lang.String pattern)
```
    Defines include pattern.
  - include
```
public T include(java.lang.String... patterns)
```
    Defines include patterns.
  - excludeAll
```
public T excludeAll()
```
    Enables whitelist mode.
  - includeAll
```
public T includeAll()
```
    Enables blacklist mode.
  - exclude
```
public T exclude(java.lang.String pattern)
```
    Defines exclude pattern.
  - exclude
```
public T exclude(java.lang.String... patterns)
```
    Defines exclude patterns.
  - acceptFile
```
protected boolean acceptFile(java.io.File file)
```
    Determine if file is accepted, based on include and exclude rules. Called on each file entry (file or directory) and returns true if file passes search criteria. File is matched using matching file path.
    
    See Also:
    InExRules
  - getMatchingFilePath
```
protected java.lang.String getMatchingFilePath(java.io.File file)
```
    Resolves file path depending on matching type Returned path is formatted in unix style.
  - lastFile
```
public java.io.File lastFile()
```
    Returns last founded file. Returns null at the very beginning.
  - addPath
```
protected void addPath(java.io.File path)
```
    Adds existing search path to the file list. Non existing files are ignored. If path is a folder, it will be scanned for all files.
  - reset
```
public void reset()
```
    Reset the search so it can be run again with very same parameters (and sorting options).
  - nextFile
```
public java.io.File nextFile()
```
    Finds the next file. Returns founded file that matches search configuration or null if no more files can be found.
  - find
```
public void find()
```
    Performs scanning.
  - find
```
public void find(FileConsumer fileConsumer)
```
    Finds a file.
  - init
```
protected void init()
```
    Initializes file walking. Separates input files and folders.
  - iterator
```
public java.util.Iterator<java.io.File> iterator()
```
    Returns file walking iterator.
  - addComparator
```
protected void addComparator(java.util.Comparator<java.io.File> comparator)
```
  - sortNone
```
public T sortNone()
```
    Removes ALL sorting options.
  - sortWith
```
public T sortWith(java.util.Comparator<java.io.File> fileComparator)
```
    Adds generic sorting.
  - sortFoldersFirst
```
public T sortFoldersFirst()
```
    Puts folders before files.
  - sortFoldersLast
```
public T sortFoldersLast()
```
    Puts files before folders.
  - sortByName
```
public T sortByName()
```
    Sorts files by file name, using natural sort.
  - sortByNameDesc
```
public T sortByNameDesc()
```
    Sorts files by file names descending, using natural sort.
  - sortByExtension
```
public T sortByExtension()
```
    Sorts files by file extension.
  - sortByExtensionDesc
```
public T sortByExtensionDesc()
```
    Sorts files by file extension descending.
  - sortByTime
```
public T sortByTime()
```
    Sorts files by last modified time.
  - sortByTimeDesc
```
public T sortByTimeDesc()
```
    Sorts files by last modified time descending.

Class FindFile<T extends FindFile>

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

recursive

includeDirs

includeFiles

walking

matchType

rules

pathList

pathListOriginal

todoFolders

todoFiles

lastFile

rootFile

rootPath

sortComparators

Constructor Detail

FindFile

Method Detail

isRecursive

setRecursive

isIncludeDirs

setIncludeDirs

isIncludeFiles

setIncludeFiles

isWalking

setWalking

getMatchType

setMatchType

searchPath

searchPath

searchPath

searchPath

searchPath

searchPath

searchPath

searchPath

createRulesEngine

include

include

excludeAll

includeAll

exclude

exclude

acceptFile

getMatchingFilePath

lastFile

addPath

reset

nextFile

find

find

init

iterator

addComparator

sortNone

sortWith

sortFoldersFirst

sortFoldersLast

sortByName

sortByNameDesc

sortByExtension

sortByExtensionDesc

sortByTime

sortByTimeDesc