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,FileVisitor<Path>,PathMatcher,PathFilter,PathVisitor,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.
Deprecating Serialization
Serialization is deprecated and will be removed in 3.0.
- Since:
- 1.0
- See Also:
-
Field Summary
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 ofOrFileFilterwith 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
Modifier and TypeMethodDescriptionbooleanChecks to see if the File should be accepted by this filter.booleanChecks to see if the File should be accepted by this filter.accept(Path file, BasicFileAttributes attributes) Checks to see if a Path should be accepted by this filter.voidaddFileFilter(IOFileFilter fileFilter) Adds the specified file filter to the list of file filters at the end of the list.voidaddFileFilter(IOFileFilter... fileFilters) Adds the given file filters.Gets this conditional file filter's list of file filters.booleanremoveFileFilter(IOFileFilter fileFilter) Removes the specified file filter.voidsetFileFilters(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.Methods inherited from class org.apache.commons.io.filefilter.AbstractFileFilter
handle, postVisitDirectory, preVisitDirectory, visitFile, visitFileFailedMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitMethods inherited from interface org.apache.commons.io.filefilter.IOFileFilter
and, matches, negate, or
-
Constructor Details
-
OrFileFilter
public OrFileFilter()Constructs a new instance ofOrFileFilter.- Since:
- 1.1
-
OrFileFilter
Constructs a new instance for the give filters.- Parameters:
fileFilters- filters to OR.- Since:
- 2.9.0
-
OrFileFilter
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:
IllegalArgumentException- if either filter is null
-
OrFileFilter
Constructs a new instance ofOrFileFilterwith the specified filters.- Parameters:
fileFilters- the file filters for this filter, copied.- Since:
- 1.1
-
-
Method Details
-
accept
Checks to see if the File should be accepted by this filter.- Specified by:
acceptin interfaceFileFilter- Specified by:
acceptin interfaceIOFileFilter- Overrides:
acceptin 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:
acceptin interfaceFilenameFilter- Specified by:
acceptin interfaceIOFileFilter- Overrides:
acceptin 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
Checks to see if a Path should be accepted by this filter.- Specified by:
acceptin interfaceIOFileFilter- Specified by:
acceptin 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
Adds the specified file filter to the list of file filters at the end of the list.- Specified by:
addFileFilterin interfaceConditionalFileFilter- Parameters:
fileFilter- the filter to be added
-
addFileFilter
Adds the given file filters.- Parameters:
fileFilters- the filters to add.- Since:
- 2.9.0
-
getFileFilters
Gets this conditional file filter's list of file filters.- Specified by:
getFileFiltersin interfaceConditionalFileFilter- Returns:
- the file filter list
-
removeFileFilter
Removes the specified file filter.- Specified by:
removeFileFilterin interfaceConditionalFileFilter- Parameters:
fileFilter- filter to be removed- Returns:
trueif the filter was found in the list,falseotherwise
-
setFileFilters
Sets the list of file filters, replacing any previously configured file filters on this filter.- Specified by:
setFileFiltersin interfaceConditionalFileFilter- Parameters:
fileFilters- the list of filters
-
toString
Provide a String representation of this file filter.- Overrides:
toStringin classAbstractFileFilter- Returns:
- a String representation
-