org.xwiki.annotation.event

Class AbstractAnnotationEvent

java.lang.Object

org.xwiki.observation.event.AbstractFilterableEvent

org.xwiki.observation.event.AbstractCancelableEvent

org.xwiki.bridge.event.AbstractDocumentEvent

org.xwiki.annotation.event.AbstractAnnotationEvent

All Implemented Interfaces:

Serializable, AnnotationEvent, org.xwiki.observation.event.CancelableEvent, org.xwiki.observation.event.Event, org.xwiki.observation.event.FilterableEvent

Direct Known Subclasses:

AnnotationAddedEvent, AnnotationDeletedEvent, AnnotationUpdatedEvent

public abstract class AbstractAnnotationEvent
extends AbstractDocumentEvent
implements AnnotationEvent

Base class for all annotation Event.

Since:

2.6RC2

Version:

$Id: 4d3c3d178cc0d3c2450593283c034dadd89ef8bb $

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
AbstractAnnotationEvent() Constructor initializing the event filter with an AlwaysMatchingEventFilter, meaning that this event will match any other annotation event (add, update, delete).
AbstractAnnotationEvent(org.xwiki.observation.event.filter.EventFilter eventFilter) Constructor using a custom EventFilter.
AbstractAnnotationEvent(String documentName, String identifier) Constructor initializing the event filter with a FixedNameEventFilter, meaning that this event will match only comment events affecting the document matching the passed document name.

Method Summary

Modifier and Type	Method and Description
String	getIdentifier() Retrieves the identifier of the annotation added/updated/deleted in the event.

Methods inherited from class org.xwiki.observation.event.AbstractCancelableEvent

cancel, cancel, getReason, isCanceled

Methods inherited from class org.xwiki.observation.event.AbstractFilterableEvent

equals, getEventFilter, hashCode, matches

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.xwiki.observation.event.FilterableEvent

getEventFilter

Methods inherited from interface org.xwiki.observation.event.Event

matches

Constructor Detail

AbstractAnnotationEvent

public AbstractAnnotationEvent()

Constructor initializing the event filter with an AlwaysMatchingEventFilter, meaning that this event will match any other annotation event (add, update, delete).

AbstractAnnotationEvent

public AbstractAnnotationEvent(String documentName,
                               String identifier)

Constructor initializing the event filter with a FixedNameEventFilter, meaning that this event will match only comment events affecting the document matching the passed document name.

Parameters:

documentName - the name of the updated document to match

identifier - the identifier of the annotation added/updated/deleted

AbstractAnnotationEvent

public AbstractAnnotationEvent(org.xwiki.observation.event.filter.EventFilter eventFilter)

Constructor using a custom EventFilter.

Parameters:

eventFilter - the filter to use for matching events

Method Detail

getIdentifier

public String getIdentifier()

Description copied from interface: AnnotationEvent

Retrieves the identifier of the annotation added/updated/deleted in the event.

Specified by:

getIdentifier in interface AnnotationEvent

Returns:

identifier of the annotation