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:
FileFilter
,FilenameFilter
,Serializable
,ConditionalFileFilter
,IOFileFilter
A
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
.- Since:
- 1.0
- See Also:
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate final List<IOFileFilter>
The list of file filters.private static final long
Fields inherited from interface org.apache.commons.io.filefilter.IOFileFilter
EMPTY_STRING_ARRAY
-
Constructor Summary
ConstructorsConstructorDescriptionConstructs a new instance ofOrFileFilter
.OrFileFilter
(List<IOFileFilter> fileFilters) Constructs a new instance ofOrFileFilter
with the specified filters.OrFileFilter
(IOFileFilter filter1, IOFileFilter filter2) Constructs a new file filter that ORs the result of two other filters. -
Method Summary
Modifier and TypeMethodDescriptionboolean
Checks to see if the File should be accepted by this filter.boolean
Checks to see if the File should be accepted by this filter.void
addFileFilter
(IOFileFilter ioFileFilter) Adds the specified file filter to the list of file filters at the end of the list.Returns this conditional file filter's list of file filters.boolean
removeFileFilter
(IOFileFilter ioFileFilter) Removes the specified file filter.void
setFileFilters
(List<IOFileFilter> fileFilters) Sets the list of file filters, replacing any previously configured file filters on this filter.toString()
Provide a String representation of this file filter.
-
Field Details
-
serialVersionUID
private static final long serialVersionUID- See Also:
-
fileFilters
The list of file filters.
-
-
Constructor Details
-
OrFileFilter
public OrFileFilter()Constructs a new instance ofOrFileFilter
.- Since:
- 1.1
-
OrFileFilter
Constructs a new instance ofOrFileFilter
with the specified filters.- Parameters:
fileFilters
- the file filters for this filter, copied, null ignored- Since:
- 1.1
-
OrFileFilter
Constructs a new file filter that ORs the result of two other filters.- Parameters:
filter1
- the first filter, must not be nullfilter2
- the second filter, must not be null- Throws:
IllegalArgumentException
- if either filter is null
-
-
Method Details
-
addFileFilter
Adds the specified file filter to the list of file filters at the end of the list.- Specified by:
addFileFilter
in interfaceConditionalFileFilter
- Parameters:
ioFileFilter
- the filter to be added
-
getFileFilters
Returns this conditional file filter's list of file filters.- Specified by:
getFileFilters
in interfaceConditionalFileFilter
- Returns:
- the file filter list
-
removeFileFilter
Removes the specified file filter.- Specified by:
removeFileFilter
in interfaceConditionalFileFilter
- Parameters:
ioFileFilter
- filter to be removed- Returns:
true
if the filter was found in the list,false
otherwise
-
setFileFilters
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
-
accept
Checks to see if the File should be accepted by this filter.- Specified by:
accept
in interfaceFileFilter
- Specified by:
accept
in interfaceIOFileFilter
- Overrides:
accept
in classAbstractFileFilter
- Parameters:
file
- the File to check- Returns:
- true if this file matches the test
-
accept
Checks to see if the File should be accepted by this filter.- Specified by:
accept
in interfaceFilenameFilter
- 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
-
toString
Provide a String representation of this file filter.- Overrides:
toString
in classAbstractFileFilter
- Returns:
- a String representation
-