Class DepthSelector

All Implemented Interfaces:
Cloneable, Parameterizable, ResourceSelector, ExtendFileSelector, FileSelector

public class DepthSelector extends BaseExtendSelector
Selector that filters files based on the how deep in the directory tree they are.
  • Field Details

    • MIN_KEY

      public static final String MIN_KEY
      Used for parameterized custom selector
      See Also:
    • MAX_KEY

      public static final String MAX_KEY
      Used for parameterized custom selector
      See Also:
    • min

      public int min
      min attribute
    • max

      public int max
      max attribute
  • Constructor Details

    • DepthSelector

      public DepthSelector()
  • Method Details

    • toString

      public String toString()
      Description copied from class: DataType
      Basic DataType toString().
      toString in class DataType
      a string describing this object
    • setMin

      public void setMin(int min)
      The minimum depth below the basedir before a file is selected.
      min - minimum directory levels below basedir to go
    • setMax

      public void setMax(int max)
      The minimum depth below the basedir before a file is selected.
      max - maximum directory levels below basedir to go
    • setParameters

      public void setParameters(Parameter... parameters)
      When using this as a custom selector, this method will be called. It translates each parameter into the appropriate setXXX() call.
      Specified by:
      setParameters in interface Parameterizable
      setParameters in class BaseExtendSelector
      parameters - the complete set of parameters for this selector
    • verifySettings

      public void verifySettings()
      Checks to make sure all settings are kosher. In this case, it means that the max depth is not lower than the min depth.
      verifySettings in class BaseSelector
    • isSelected

      public boolean isSelected(File basedir, String filename, File file)
      The heart of the matter. This is where the selector gets to decide on the inclusion of a file in a particular fileset. Most of the work for this selector is offloaded into SelectorUtils, a static class that provides the same services for both FilenameSelector and DirectoryScanner.
      Specified by:
      isSelected in interface FileSelector
      Specified by:
      isSelected in class BaseExtendSelector
      basedir - the base directory the scan is being done from
      filename - is the name of the file to check
      file - is a object the selector can use
      whether the file should be selected or not