Class OrFileFilter

java.lang.Object
org.apache.commons.vfs2.filter.OrFileFilter
All Implemented Interfaces:
Serializable, FileFilter, ConditionalFileFilter

public class OrFileFilter extends Object implements FileFilter, ConditionalFileFilter, Serializable
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:
2.4
See Also:
  • Field Details

    • serialVersionUID

      private static final long serialVersionUID
      See Also:
    • fileFilters

      private final List<FileFilter> fileFilters
      The list of file filters.
  • Constructor Details

    • OrFileFilter

      public OrFileFilter()
      Default constructor.
    • OrFileFilter

      public OrFileFilter(FileFilter... filters)
      Constructs a new file filter that ORs the result of other filters.
      Parameters:
      filters - array of filters, must not be null or empty
    • OrFileFilter

      public OrFileFilter(List<FileFilter> fileFilters)
      Constructs a new instance of OrFileFilter with the specified filters.
      Parameters:
      fileFilters - the file filters for this filter, copied, null ignored
  • Method Details

    • accept

      public boolean accept(FileSelectInfo fileSelectInfo) throws FileSystemException
      Description copied from interface: FileFilter
      Determines if a file or folder should be selected.
      Specified by:
      accept in interface FileFilter
      Parameters:
      fileSelectInfo - the file or folder to select.
      Returns:
      true if the file should be selected.
      Throws:
      FileSystemException - Thrown for file system errors (since 2.4.)
    • addFileFilter

      public void addFileFilter(FileFilter fileFilter)
      Description copied from interface: ConditionalFileFilter
      Adds the specified file filter to the list of file filters at the end of the list.
      Specified by:
      addFileFilter in interface ConditionalFileFilter
      Parameters:
      fileFilter - the filter to be added
    • getFileFilters

      public List<FileFilter> getFileFilters()
      Description copied from interface: ConditionalFileFilter
      Returns this conditional file filter's list of file filters.
      Specified by:
      getFileFilters in interface ConditionalFileFilter
      Returns:
      the file filter list
    • removeFileFilter

      public boolean removeFileFilter(FileFilter fileFilter)
      Description copied from interface: ConditionalFileFilter
      Removes the specified file filter.
      Specified by:
      removeFileFilter in interface ConditionalFileFilter
      Parameters:
      fileFilter - filter to be removed
      Returns:
      true if the filter was found in the list, false otherwise
    • setFileFilters

      public void setFileFilters(List<FileFilter> fileFilters)
      Description copied from interface: ConditionalFileFilter
      Sets the list of file filters, replacing any previously configured file filters on this filter.
      Specified by:
      setFileFilters in interface ConditionalFileFilter
      Parameters:
      fileFilters - the list of filters
    • toString

      public String toString()
      Provide a String representation of this file filter.
      Overrides:
      toString in class Object
      Returns:
      a String representation