Package org.apache.commons.io.filefilter
Class OrFileFilter
- java.lang.Object
-
- org.apache.commons.io.filefilter.AbstractFileFilter
-
- org.apache.commons.io.filefilter.OrFileFilter
-
- All Implemented Interfaces:
java.io.FileFilter
,java.io.FilenameFilter
,java.io.Serializable
,java.nio.file.FileVisitor<java.nio.file.Path>
,PathFilter
,PathVisitor
,ConditionalFileFilter
,IOFileFilter
public class OrFileFilter extends AbstractFileFilter implements ConditionalFileFilter, java.io.Serializable
AFileFilter
providing conditional OR logic across a list of file filters. This filter returnstrue
if any filters in the list returntrue
. Otherwise, it returnsfalse
. Checking of the file filter list stops when the first filter returnstrue
.- Since:
- 1.0
- See Also:
FileFilterUtils.or(IOFileFilter...)
, Serialized Form
-
-
Field Summary
-
Fields inherited from interface org.apache.commons.io.filefilter.IOFileFilter
EMPTY_STRING_ARRAY
-
-
Constructor Summary
Constructors Constructor Description OrFileFilter()
Constructs a new instance ofOrFileFilter
.OrFileFilter(java.util.List<IOFileFilter> fileFilters)
Constructs a new instance ofOrFileFilter
with the specified filters.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.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method 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 the Path should be accepted by this filter.void
addFileFilter(IOFileFilter fileFilter)
Adds the specified file filter to the list of file filters at the end of the list.void
addFileFilter(IOFileFilter... fileFilters)
Adds the given file filters.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.-
Methods inherited from class org.apache.commons.io.filefilter.AbstractFileFilter
postVisitDirectory, preVisitDirectory, visitFile, visitFileFailed
-
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface org.apache.commons.io.filefilter.IOFileFilter
and, negate, or
-
-
-
-
Constructor Detail
-
OrFileFilter
public OrFileFilter()
Constructs a new instance ofOrFileFilter
.- Since:
- 1.1
-
OrFileFilter
public OrFileFilter(IOFileFilter... fileFilters)
Constructs a new instance for the give filters.- Parameters:
fileFilters
- filters to OR.- Since:
- 2.9.0
-
OrFileFilter
public OrFileFilter(IOFileFilter filter1, IOFileFilter filter2)
Constructs a new file filter that ORs the result of other filters.- Parameters:
filter1
- the first filter, must not be nullfilter2
- the second filter, must not be null- Throws:
java.lang.IllegalArgumentException
- if either filter is null
-
OrFileFilter
public OrFileFilter(java.util.List<IOFileFilter> fileFilters)
Constructs a new instance ofOrFileFilter
with the specified filters.- Parameters:
fileFilters
- the file filters for this filter, copied.- Since:
- 1.1
-
-
Method Detail
-
accept
public boolean accept(java.io.File file)
Checks to see if the File should be accepted by this filter.- Specified by:
accept
in interfacejava.io.FileFilter
- Specified by:
accept
in interfaceIOFileFilter
- Overrides:
accept
in classAbstractFileFilter
- Parameters:
file
- the File to check- Returns:
- true if this file matches the test
-
accept
public boolean accept(java.io.File file, java.lang.String name)
Checks to see if the File should be accepted by this filter.- Specified by:
accept
in interfacejava.io.FilenameFilter
- Specified by:
accept
in interfaceIOFileFilter
- Overrides:
accept
in classAbstractFileFilter
- Parameters:
file
- the directory File to checkname
- the file name within the directory to check- Returns:
- true if this file matches the test
-
accept
public java.nio.file.FileVisitResult accept(java.nio.file.Path file, java.nio.file.attribute.BasicFileAttributes attributes)
Checks to see if the Path should be accepted by this filter.- Specified by:
accept
in interfaceIOFileFilter
- Specified by:
accept
in interfacePathFilter
- Parameters:
file
- the Path to check.attributes
- the file's basic attributes (TODO may be null).- Returns:
- true if this path matches the test.
-
addFileFilter
public void addFileFilter(IOFileFilter fileFilter)
Adds the specified file filter to the list of file filters at the end of the list.- Specified by:
addFileFilter
in interfaceConditionalFileFilter
- Parameters:
fileFilter
- the filter to be added
-
addFileFilter
public void addFileFilter(IOFileFilter... fileFilters)
Adds the given file filters.- Parameters:
fileFilters
- the filters to add.- Since:
- 2.9.0
-
getFileFilters
public java.util.List<IOFileFilter> getFileFilters()
Gets this conditional file filter's list of file filters.- Specified by:
getFileFilters
in interfaceConditionalFileFilter
- Returns:
- the file filter list
-
removeFileFilter
public boolean removeFileFilter(IOFileFilter fileFilter)
Removes the specified file filter.- Specified by:
removeFileFilter
in interfaceConditionalFileFilter
- Parameters:
fileFilter
- filter to be removed- Returns:
true
if the filter was found in the list,false
otherwise
-
setFileFilters
public void setFileFilters(java.util.List<IOFileFilter> fileFilters)
Sets the list of file filters, replacing any previously configured file filters on this filter.- Specified by:
setFileFilters
in interfaceConditionalFileFilter
- Parameters:
fileFilters
- the list of filters
-
toString
public java.lang.String toString()
Provide a String representation of this file filter.- Overrides:
toString
in classAbstractFileFilter
- Returns:
- a String representation
-
-