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

Class EventTypeFilter

java.lang.Object

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

All Implemented Interfaces:

EventFilter

public class EventTypeFilter
extends java.lang.Object
implements EventFilter

EventTypeFilter filters based on event types as defined by ObservationManager.addEventListener().

Constructor Summary

Constructors

Constructor and Description
EventTypeFilter(int eventTypes) Create a new Filter instance that includes all events matching the eventTypes bit mask.

Method Summary

Modifier and Type	Method and Description
EventFilter	create(java.lang.String name, NodeState before, NodeState after) Factory for creating a filter instance for the given child node
boolean	includeAdd(PropertyState after) Include an added property
boolean	includeAdd(java.lang.String name, NodeState after) Include an added node
boolean	includeChange(PropertyState before, PropertyState after) Include a changed property
boolean	includeDelete(PropertyState before) Include a deleted property
boolean	includeDelete(java.lang.String name, NodeState before) Include a deleted node
boolean	includeMove(java.lang.String sourcePath, java.lang.String name, NodeState moved) Include a moved node
boolean	includeReorder(java.lang.String destName, java.lang.String name, NodeState reordered) Include a reordered node

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

EventTypeFilter

public EventTypeFilter(int eventTypes)

Create a new Filter instance that includes all events matching the eventTypes bit mask. That is, a given event is included if the corresponding bit in eventType is set.

Parameters:

eventTypes - bit mask encoding the types of events to include

See Also:

Event

Method Detail

includeAdd

public boolean includeAdd(PropertyState after)

Description copied from interface: EventFilter

Include an added property

Specified by:

includeAdd in interface EventFilter

Parameters:

after - added property

Returns:

true if the property should be included

includeChange

public boolean includeChange(PropertyState before,
                             PropertyState after)

Description copied from interface: EventFilter

Include a changed property

Specified by:

includeChange in interface EventFilter

Parameters:

before - property before the change

after - property after the change

Returns:

true if the property should be included

includeDelete

public boolean includeDelete(PropertyState before)

Description copied from interface: EventFilter

Include a deleted property

Specified by:

includeDelete in interface EventFilter

Parameters:

before - deleted property

Returns:

true if the property should be included

includeAdd

public boolean includeAdd(java.lang.String name,
                          NodeState after)

Description copied from interface: EventFilter

Include an added node

Specified by:

includeAdd in interface EventFilter

Parameters:

name - name of the node

after - added node

Returns:

true if the node should be included

includeDelete

public boolean includeDelete(java.lang.String name,
                             NodeState before)

Description copied from interface: EventFilter

Include a deleted node

Specified by:

includeDelete in interface EventFilter

Parameters:

name - name of the node

before - deleted node

Returns:

true if the node should be included

includeMove

public boolean includeMove(java.lang.String sourcePath,
                           java.lang.String name,
                           NodeState moved)

Description copied from interface: EventFilter

Include a moved node

Specified by:

includeMove in interface EventFilter

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

public boolean includeReorder(java.lang.String destName,
                              java.lang.String name,
                              NodeState reordered)

Description copied from interface: EventFilter

Include a reordered node

Specified by:

includeReorder in interface EventFilter

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

public EventFilter create(java.lang.String name,
                          NodeState before,
                          NodeState after)

Description copied from interface: EventFilter

Factory for creating a filter instance for the given child node

Specified by:

create in interface EventFilter

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.