Package org.apache.jackrabbit.oak.plugins.observation.filter

Interface EventFilter

All Known Implementing Classes:
ACFilter, AddSubtreeFilter, ConstantFilter, DeleteSubtreeFilter, EventTypeFilter, GlobbingPathFilter, MoveFilter, UniversalFilter, VisibleFilter
public interface EventFilter
Filter for determining what changes to report the the event listener.

  • Method Details

    • includeAdd

      boolean includeAdd(PropertyState after)
      Include an added property
      Parameters:
      after - added property
      Returns:
      true if the property should be included

    • includeChange

      boolean includeChange(PropertyState before, PropertyState after)
      Include a changed property
      Parameters:
      before - property before the change
      after - property after the change
      Returns:
      true if the property should be included

    • includeDelete

      boolean includeDelete(PropertyState before)
      Include a deleted property
      Parameters:
      before - deleted property
      Returns:
      true if the property should be included

    • includeAdd

      boolean includeAdd(String name, NodeState after)
      Include an added node
      Parameters:
      name - name of the node
      after - added node
      Returns:
      true if the node should be included

    • includeDelete

      boolean includeDelete(String name, NodeState before)
      Include a deleted node
      Parameters:
      name - name of the node
      before - deleted node
      Returns:
      true if the node should be included

    • includeMove

      boolean includeMove(String sourcePath, String name, NodeState moved)
      Include a moved node
      Parameters:
      sourcePath - source path of the move operation
      name - name of the moved node
      moved - the moved node
      Returns:
      true if the node should be included

    • includeReorder

      boolean includeReorder(String destName, String name, NodeState reordered)
      Include a reordered node
      Parameters:
      destName - name of the orderBefore() destination node
      name - name of the reordered node
      reordered - the reordered node
      Returns:
      true if the node should be included

    • create

      @Nullable @Nullable EventFilter create(String name, NodeState before, NodeState after)
      Factory for creating a filter instance for the given child node
      Parameters:
      name - name of the child node
      before - before state of the child node
      after - after state of the child node
      Returns:
      filter instance for filtering the child node or null to exclude the sub tree rooted at this child node.