public class OrFileFilter extends AbstractFileFilter implements ConditionalFileFilter, java.io.Serializable
FileFilter
providing conditional OR logic across a list of file filters. This filter returns
true
if any filters in the list return true
. Otherwise, it returns false
. Checking of the
file filter list stops when the first filter returns true
.
Serialization is deprecated and will be removed in 3.0.
FileFilterUtils.or(IOFileFilter...)
,
Serialized FormModifier and Type | Field and Description |
---|---|
private java.util.List<IOFileFilter> |
fileFilters
The list of file filters.
|
private static long |
serialVersionUID |
EMPTY_STRING_ARRAY
Modifier | Constructor and Description |
---|---|
|
OrFileFilter()
Constructs a new instance of
OrFileFilter . |
private |
OrFileFilter(java.util.ArrayList<IOFileFilter> initialList)
Constructs a new instance with the given initial list.
|
private |
OrFileFilter(int initialCapacity)
Constructs a new instance with the given initial capacity.
|
|
OrFileFilter(IOFileFilter... fileFilters)
Constructs a new instance for the give filters.
|
|
OrFileFilter(IOFileFilter filter1,
IOFileFilter filter2)
Constructs a new file filter that ORs the result of other filters.
|
|
OrFileFilter(java.util.List<IOFileFilter> fileFilters)
Constructs a new instance of
OrFileFilter with the specified filters. |
Modifier and Type | Method and Description |
---|---|
boolean |
accept(java.io.File file)
Checks to see if the File should be accepted by this filter.
|
boolean |
accept(java.io.File file,
java.lang.String name)
Checks to see if the File should be accepted by this filter.
|
java.nio.file.FileVisitResult |
accept(java.nio.file.Path file,
java.nio.file.attribute.BasicFileAttributes attributes)
Checks to see if a Path should be accepted by this filter.
|
void |
addFileFilter(IOFileFilter... fileFilters)
Adds the given file filters.
|
void |
addFileFilter(IOFileFilter fileFilter)
Adds the specified file filter to the list of file filters at the end of
the list.
|
java.util.List<IOFileFilter> |
getFileFilters()
Gets this conditional file filter's list of file filters.
|
boolean |
removeFileFilter(IOFileFilter fileFilter)
Removes the specified file filter.
|
void |
setFileFilters(java.util.List<IOFileFilter> fileFilters)
Sets the list of file filters, replacing any previously configured
file filters on this filter.
|
java.lang.String |
toString()
Provide a String representation of this file filter.
|
append, append, get, handle, postVisitDirectory, preVisitDirectory, toDefaultFileVisitResult, toFileVisitResult, visitFile, visitFileFailed
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
and, matches, negate, or
private static final long serialVersionUID
private final java.util.List<IOFileFilter> fileFilters
public OrFileFilter()
OrFileFilter
.private OrFileFilter(java.util.ArrayList<IOFileFilter> initialList)
initialList
- the initial list.private OrFileFilter(int initialCapacity)
initialCapacity
- the initial capacity.public OrFileFilter(IOFileFilter... fileFilters)
fileFilters
- filters to OR.public OrFileFilter(IOFileFilter filter1, IOFileFilter filter2)
filter1
- the first filter, must not be nullfilter2
- the second filter, must not be nulljava.lang.IllegalArgumentException
- if either filter is nullpublic OrFileFilter(java.util.List<IOFileFilter> fileFilters)
OrFileFilter
with the specified filters.fileFilters
- the file filters for this filter, copied.public boolean accept(java.io.File file)
accept
in interface java.io.FileFilter
accept
in interface IOFileFilter
accept
in class AbstractFileFilter
file
- the File to checkpublic boolean accept(java.io.File file, java.lang.String name)
accept
in interface java.io.FilenameFilter
accept
in interface IOFileFilter
accept
in class AbstractFileFilter
file
- the directory File to checkname
- the file name within the directory to checkpublic java.nio.file.FileVisitResult accept(java.nio.file.Path file, java.nio.file.attribute.BasicFileAttributes attributes)
accept
in interface PathFilter
accept
in interface IOFileFilter
file
- the Path to check.attributes
- the file's basic attributes (TODO may be null).public void addFileFilter(IOFileFilter fileFilter)
addFileFilter
in interface ConditionalFileFilter
fileFilter
- the filter to be addedpublic void addFileFilter(IOFileFilter... fileFilters)
fileFilters
- the filters to add.public java.util.List<IOFileFilter> getFileFilters()
getFileFilters
in interface ConditionalFileFilter
public boolean removeFileFilter(IOFileFilter fileFilter)
removeFileFilter
in interface ConditionalFileFilter
fileFilter
- filter to be removedtrue
if the filter was found in the list,
false
otherwisepublic void setFileFilters(java.util.List<IOFileFilter> fileFilters)
setFileFilters
in interface ConditionalFileFilter
fileFilters
- the list of filterspublic java.lang.String toString()
toString
in class AbstractFileFilter