Package com.deltawalker.script

Interface Filter

All Known Subinterfaces:
AlignFilter, AttributeFilter, FolderFilter, PathFilter, SizeFilter, TextFilter, TimeFilter
public interface Filter
The base type of all DeltaWalker filters. Filters include or exclude files and folders (DeltaNodes) in folder comparisons, and make text comparisons ignore matching text. Filters are created and managed through Filters.
Since:
2.0

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getDescription()
    Returns a user-friendly text describing the purpose of this filter, for example "C++/Java comments" for a text filter.
    String
    getDisplayExpression()
    Returns the expression of this filter as shown in the DeltaWalker UI, for instance "Older than 6/6/13 10:25:55" for a time filter or "Larger than 2KB" for a size filter.
    String
    getExpression()
    Returns the expression of this filter: the regular or shell expression of a PathFilter, AlignFilter or TextFilter.
    boolean
    isEnabled()
    Answers whether this filter is enabled.
    boolean
    isRegexType()
    Answers whether getExpression() is a regular expression or a shell expression.

  • Method Details

    • getDescription

      String getDescription()
      Returns a user-friendly text describing the purpose of this filter, for example "C++/Java comments" for a text filter. In the current release folder filters return an empty string; the description passed to the add...Filter() methods of Filters is kept only for text filters.
      Returns:
      a string describing this filter's purpose
      Since:
      2.0

    • getDisplayExpression

      String getDisplayExpression()
      Returns the expression of this filter as shown in the DeltaWalker UI, for instance "Older than 6/6/13 10:25:55" for a time filter or "Larger than 2KB" for a size filter. For path filters it is the same as getExpression().
      Returns:
      the display expression as string.
      Since:
      2.0

    • getExpression

      String getExpression()
      Returns the expression of this filter: the regular or shell expression of a PathFilter, AlignFilter or TextFilter.
      Returns:
      the expression as a string
      Since:
      2.0

    • isEnabled

      boolean isEnabled()
      Answers whether this filter is enabled. Only enabled filters are applied; filters created by Filters are enabled.
      Returns:
      true when the filter is enabled, false otherwise.
      Since:
      2.0

    • isRegexType

      boolean isRegexType()
      Answers whether getExpression() is a regular expression or a shell expression.
      Returns:
      true if getExpression() returns a regular expression, false if it returns a shell expression.
      Since:
      2.0