FindFile (Jodd API Documentation)

java.lang.Object
- jodd.io.findfile.FindFile

All Implemented Interfaces:

java.lang.Iterable<java.io.File>

Direct Known Subclasses:

RegExpFindFile, WildcardFindFile
```
public class FindFile
extends java.lang.Object
implements java.lang.Iterable<java.io.File>
```
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

protected class FindFile.FilesIterator
Files iterator simply walks over files array.

static class FindFile.Match
Match type.

Nested Classes
Modifier and Type	Class and Description
`protected class`	`FindFile.FilesIterator` Files iterator simply walks over files array.
`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 java.util.LinkedList<java.io.File>`	`pathList`
`protected java.util.LinkedList<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 java.util.LinkedList<FindFile.FilesIterator>`	`todoFiles`
`protected java.util.LinkedList<java.io.File>`	`todoFolders`
`protected boolean`	`walking`

Constructor Summary

Constructors
Constructor and Description

FindFile()

Constructors
Constructor and Description
`FindFile()`

Method Summary

All Methods Static Methods Instance Methods Concrete 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.
`static FindFile`	`create()`
`static RegExpFindFile`	`createRegExpFF()`
`protected InExRules<java.lang.String,java.lang.String,?>`	`createRulesEngine()` Creates rule engine.
`static WildcardFindFile`	`createWildcardFF()`
`FindFile`	`exclude(java.lang.String... patterns)` Defines exclude patterns.
`FindFile`	`exclude(java.lang.String pattern)` Defines exclude pattern.
`FindFile`	`excludeAll()` Enables whitelist mode.
`java.util.List<java.io.File>`	`findAll()` Finds all files and returns list of founded files.
`protected java.lang.String`	`getMatchingFilePath(java.io.File file)` Resolves file path depending on `matching type` Returned path is formatted in unix style.
`FindFile`	`include(java.lang.String... patterns)` Defines include patterns.
`FindFile`	`include(java.lang.String pattern)` Defines include pattern.
`FindFile`	`includeAll()` Enables blacklist mode.
`FindFile`	`includeDirs(boolean includeDirs)` Include directories in search.
`FindFile`	`includeFiles(boolean includeFiles)` Include files in search.
`protected void`	`init()` Initializes file walking.
`java.util.Iterator<java.io.File>`	`iterator()` Returns file walking iterator.
`java.io.File`	`lastFile()` Returns last founded file.
`FindFile`	`matchFullPath()`
`FindFile`	`matchOnlyFileName()`
`FindFile`	`matchRelativePath()`
`FindFile`	`matchType(FindFile.Match match)` Set `matching type`.
`java.io.File`	`nextFile()` Finds the next file.
`FindFile`	`onFile(java.util.function.Consumer<java.io.File> fileConsumer)` Registers file consumer
`FindFile`	`recursive(boolean recursive)` Activates recursive search.
`void`	`reset()` Reset the search so it can be run again with very same parameters (and sorting options).
`FindFile`	`searchPath(java.io.File... searchPath)` Specifies a set of search paths.
`FindFile`	`searchPath(java.io.File searchPath)` Specifies single search path.
`FindFile`	`searchPath(java.lang.String searchPath)` Specifies the search path.
`FindFile`	`searchPath(java.net.URI searchPath)` Specifies the search path.
`FindFile`	`searchPath(java.net.URL searchPath)` Specifies the search path.
`FindFile`	`searchPaths(java.lang.String... searchPaths)` Specifies search paths.
`FindFile`	`searchPaths(java.net.URI... searchPath)` Specifies the search path.
`FindFile`	`searchPaths(java.net.URL... searchPath)` Specifies the search path.
`FindFile`	`sortByExtension()` Sorts files by file extension.
`FindFile`	`sortByExtensionDesc()` Sorts files by file extension descending.
`FindFile`	`sortByName()` Sorts files by file name, using natural sort.
`FindFile`	`sortByNameDesc()` Sorts files by file names descending, using natural sort.
`FindFile`	`sortByTime()` Sorts files by last modified time.
`FindFile`	`sortByTimeDesc()` Sorts files by last modified time descending.
`FindFile`	`sortFoldersFirst()` Puts folders before files.
`FindFile`	`sortFoldersLast()` Puts files before folders.
`FindFile`	`sortNone()` Removes ALL sorting options.
`FindFile`	`sortWith(java.util.Comparator<java.io.File> fileComparator)` Adds generic sorting.
`FindFile`	`walking(boolean walking)` Sets the walking recursive mode.

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

Methods inherited from interface java.lang.Iterable
forEach, spliterator

- 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 java.util.LinkedList<java.io.File> pathList
```
  - pathListOriginal
```
protected java.util.LinkedList<java.io.File> pathListOriginal
```
  - todoFolders
```
protected java.util.LinkedList<java.io.File> todoFolders
```
  - todoFiles
```
protected java.util.LinkedList<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
  - createWildcardFF
```
public static WildcardFindFile createWildcardFF()
```
  - createRegExpFF
```
public static RegExpFindFile createRegExpFF()
```
  - create
```
public static FindFile create()
```
  - recursive
```
public FindFile recursive(boolean recursive)
```
    Activates recursive search.
  - includeDirs
```
public FindFile includeDirs(boolean includeDirs)
```
    Include directories in search.
  - includeFiles
```
public FindFile includeFiles(boolean includeFiles)
```
    Include files in search.
  - walking
```
public FindFile walking(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:
    
    recursive(boolean)
  - matchType
```
public FindFile matchType(FindFile.Match match)
```
    Set matching type.
  - matchOnlyFileName
```
public FindFile matchOnlyFileName()
```
  - matchFullPath
```
public FindFile matchFullPath()
```
  - matchRelativePath
```
public FindFile matchRelativePath()
```
  - onFile
```
public FindFile onFile(java.util.function.Consumer<java.io.File> fileConsumer)
```
    Registers file consumer
  - searchPath
```
public FindFile searchPath(java.io.File searchPath)
```
    Specifies single search path.
  - searchPath
```
public FindFile searchPath(java.io.File... searchPath)
```
    Specifies a set of search paths.
  - searchPath
```
public FindFile 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.
  - searchPaths
```
public FindFile searchPaths(java.lang.String... searchPaths)
```
    Specifies search paths.
    
    See Also:
    
    searchPath(String)
  - searchPath
```
public FindFile searchPath(java.net.URI searchPath)
```
    Specifies the search path. Throws an exception if URI is invalid.
  - searchPaths
```
public FindFile searchPaths(java.net.URI... searchPath)
```
    Specifies the search path.
  - searchPath
```
public FindFile searchPath(java.net.URL searchPath)
```
    Specifies the search path. Throws an exception if URL is invalid.
  - searchPaths
```
public FindFile searchPaths(java.net.URL... searchPath)
```
    Specifies the search path.
  - createRulesEngine
```
protected InExRules<java.lang.String,java.lang.String,?> createRulesEngine()
```
    Creates rule engine.
  - include
```
public FindFile include(java.lang.String pattern)
```
    Defines include pattern.
  - include
```
public FindFile include(java.lang.String... patterns)
```
    Defines include patterns.
  - excludeAll
```
public FindFile excludeAll()
```
    Enables whitelist mode.
  - includeAll
```
public FindFile includeAll()
```
    Enables blacklist mode.
  - exclude
```
public FindFile exclude(java.lang.String pattern)
```
    Defines exclude pattern.
  - exclude
```
public FindFile 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.
  - findAll
```
public java.util.List<java.io.File> findAll()
```
    Finds all files and returns list of founded files.
  - 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.
    
    Specified by:
    
    iterator in interface java.lang.Iterable<java.io.File>
  - addComparator
```
protected void addComparator(java.util.Comparator<java.io.File> comparator)
```
  - sortNone
```
public FindFile sortNone()
```
    Removes ALL sorting options.
  - sortWith
```
public FindFile sortWith(java.util.Comparator<java.io.File> fileComparator)
```
    Adds generic sorting.
  - sortFoldersFirst
```
public FindFile sortFoldersFirst()
```
    Puts folders before files.
  - sortFoldersLast
```
public FindFile sortFoldersLast()
```
    Puts files before folders.
  - sortByName
```
public FindFile sortByName()
```
    Sorts files by file name, using natural sort.
  - sortByNameDesc
```
public FindFile sortByNameDesc()
```
    Sorts files by file names descending, using natural sort.
  - sortByExtension
```
public FindFile sortByExtension()
```
    Sorts files by file extension.
  - sortByExtensionDesc
```
public FindFile sortByExtensionDesc()
```
    Sorts files by file extension descending.
  - sortByTime
```
public FindFile sortByTime()
```
    Sorts files by last modified time.
  - sortByTimeDesc
```
public FindFile sortByTimeDesc()
```
    Sorts files by last modified time descending.

Class FindFile

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface java.lang.Iterable

Field Detail

recursive

includeDirs

includeFiles

walking

matchType

rules

pathList

pathListOriginal

todoFolders

todoFiles

lastFile

rootFile

rootPath

sortComparators

Constructor Detail

FindFile

Method Detail

createWildcardFF

createRegExpFF

create

recursive

includeDirs

includeFiles

walking

matchType

matchOnlyFileName

matchFullPath

matchRelativePath

onFile

searchPath

searchPath

searchPath

searchPaths

searchPath

searchPaths

searchPath

searchPaths

createRulesEngine

include

include

excludeAll

includeAll

exclude

exclude

acceptFile

getMatchingFilePath

lastFile

addPath

reset

nextFile

findAll

init

iterator

addComparator

sortNone

sortWith

sortFoldersFirst

sortFoldersLast

sortByName

sortByNameDesc

sortByExtension

sortByExtensionDesc

sortByTime

sortByTimeDesc