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 SummaryFields inherited from interface org.apache.commons.io.filefilter.IOFileFilterEMPTY_STRING_ARRAY
- 
Constructor SummaryConstructorsConstructorDescriptionConstructs 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 SummaryModifier and TypeMethodDescriptionbooleanTests to see if the File should be accepted by this filter.booleanTests 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.AbstractFileFilterhandle, postVisitDirectory, preVisitDirectory, visitFile, visitFileFailedMethods inherited from class java.lang.Objectclone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitMethods inherited from interface org.apache.commons.io.filefilter.IOFileFilterand, matches, negate, or
- 
Constructor Details- 
OrFileFilterpublic OrFileFilter()Constructs a new instance ofOrFileFilter.- Since:
- 1.1
 
- 
OrFileFilterConstructs a new instance for the give filters.- Parameters:
- fileFilters- filters to OR.
- Since:
- 2.9.0
 
- 
OrFileFilterConstructs a new file filter that ORs the result of other filters.- Parameters:
- filter1- the first filter, must not be null
- filter2- the second filter, must not be null
- Throws:
- IllegalArgumentException- if either filter is null
 
- 
OrFileFilterConstructs a new instance ofOrFileFilterwith the specified filters.- Parameters:
- fileFilters- the file filters for this filter, copied.
- Since:
- 1.1
 
 
- 
- 
Method Details- 
acceptTests to see if the File should be accepted by this filter.- Specified by:
- acceptin interface- FileFilter
- Specified by:
- acceptin interface- IOFileFilter
- Overrides:
- acceptin class- AbstractFileFilter
- Parameters:
- file- the File to check
- Returns:
- true if this file matches the test
 
- 
acceptTests to see if the File should be accepted by this filter.- Specified by:
- acceptin interface- FilenameFilter
- Specified by:
- acceptin interface- IOFileFilter
- Overrides:
- acceptin class- AbstractFileFilter
- Parameters:
- file- the directory File to check
- name- the file name within the directory to check
- Returns:
- true if this file matches the test
 
- 
acceptChecks to see if a Path should be accepted by this filter.- Specified by:
- acceptin interface- IOFileFilter
- Specified by:
- acceptin interface- PathFilter
- Parameters:
- file- the Path to check.
- attributes- the path's basic attributes (may be null).
- Returns:
- true if this path matches the test.
 
- 
addFileFilterAdds the specified file filter to the list of file filters at the end of the list.- Specified by:
- addFileFilterin interface- ConditionalFileFilter
- Parameters:
- fileFilter- the filter to be added
 
- 
addFileFilterAdds the given file filters.- Parameters:
- fileFilters- the filters to add.
- Since:
- 2.9.0
 
- 
getFileFiltersGets this conditional file filter's list of file filters.- Specified by:
- getFileFiltersin interface- ConditionalFileFilter
- Returns:
- the file filter list
 
- 
removeFileFilterRemoves the specified file filter.- Specified by:
- removeFileFilterin interface- ConditionalFileFilter
- Parameters:
- fileFilter- filter to be removed
- Returns:
- trueif the filter was found in the list,- falseotherwise
 
- 
setFileFiltersSets the list of file filters, replacing any previously configured file filters on this filter.- Specified by:
- setFileFiltersin interface- ConditionalFileFilter
- Parameters:
- fileFilters- the list of filters
 
- 
toStringProvide a String representation of this file filter.- Overrides:
- toStringin class- AbstractFileFilter
- Returns:
- a String representation
 
 
-