org.xwiki.annotation.event

Class AnnotationDeletedEvent

java.lang.Object

org.xwiki.observation.event.AbstractFilterableEvent

org.xwiki.observation.event.AbstractCancelableEvent

org.xwiki.bridge.event.AbstractDocumentEvent

org.xwiki.annotation.event.AbstractAnnotationEvent

org.xwiki.annotation.event.AnnotationDeletedEvent

All Implemented Interfaces:

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

public class AnnotationDeletedEvent
extends AbstractAnnotationEvent

An event triggered when an annotation is deleted.

The event also send the following parameters:

• source: the current {com.xpn.xwiki.doc.XWikiDocument} instance
• data: the current {com.xpn.xwiki.XWikiContext} instance

Since:

2.6RC2

Version:

$Id: bd74bfff2bb6b520812c97394d3244a5288f1679 $

See Also:

Serialized Form

Constructor Summary

Constructors

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

Method Summary

Methods inherited from class org.xwiki.annotation.event.AbstractAnnotationEvent

getIdentifier

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

AnnotationDeletedEvent

public AnnotationDeletedEvent()

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

AnnotationDeletedEvent

public AnnotationDeletedEvent(String documentName,
                              String identifier)

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

Parameters:

documentName - the name of the document to match

identifier - the identifier of the deleted annotation

AnnotationDeletedEvent

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

Constructor using a custom EventFilter.

Parameters:

eventFilter - the filter to use for matching events