Package org.apache.jackrabbit.vault.fs.api

Interface PathFilter

All Superinterfaces:
Dumpable, Filter
All Known Implementing Classes:
DefaultPathFilter
public interface PathFilter extends Filter, Dumpable
The item filter is used to include or exclude a set of paths. It is usually part of a PathFilterSet.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final PathFilter
    ALL
    The "Catch all" item filter.
    static final PathFilter
    NONE
    The "Miss all" item filter.

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    isAbsolute()
    Checks if the pattern is absolute, i.e.
    boolean
    matches(@NotNull String path)
    Checks if the given path matches this filters criteria.
    @NotNull PathFilter
    translate(@Nullable PathMapping mapping)
    Translates this path filter with the given mapping.

    Methods inherited from interface org.apache.jackrabbit.vault.fs.api.Dumpable

    dump

  • Field Details

    • ALL

      static final PathFilter ALL
      The "Catch all" item filter.

    • NONE

      static final PathFilter NONE
      The "Miss all" item filter.

  • Method Details

    • matches

      boolean matches(@NotNull @NotNull String path)
      Checks if the given path matches this filters criteria.
      Parameters:
      path - the path to check
      Returns:
      true if this filter matches the criteria; false otherwise.

    • isAbsolute

      boolean isAbsolute()
      Checks if the pattern is absolute, i.e. does not start with a wildcard.
      Returns:
      true if pattern is absolute

    • translate

      @NotNull @NotNull PathFilter translate(@Nullable @Nullable PathMapping mapping)
      Translates this path filter with the given mapping. Note that only absolute filters can be translated.
      Parameters:
      mapping - the mapping to apply
      Returns:
      the new filter
      Since:
      2.4.10