org.xwiki.annotation.event

Class AnnotationUpdatedEvent

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.AnnotationUpdatedEvent

All Implemented Interfaces:

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

public class AnnotationUpdatedEvent
extends AbstractAnnotationEvent

An event triggered when an annotation is updated.

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: 375d5d88f251cc7aaacb3b64a602a72c40f7d22b $

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
AnnotationUpdatedEvent() Constructor initializing the event filter with an AlwaysMatchingEventFilter, meaning that this event will match any other annotation update event.
AnnotationUpdatedEvent(org.xwiki.observation.event.filter.EventFilter eventFilter) Constructor using a custom EventFilter.
AnnotationUpdatedEvent(String documentName, String identifier) Constructor initializing the event filter with a FixedNameEventFilter, meaning that this event will match only annotation update 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

AnnotationUpdatedEvent

public AnnotationUpdatedEvent()

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

AnnotationUpdatedEvent

public AnnotationUpdatedEvent(String documentName,
                              String identifier)

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

Parameters:

documentName - the name of the document to match

identifier - the identifier of the updated annotation

AnnotationUpdatedEvent

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

Constructor using a custom EventFilter.

Parameters:

eventFilter - the filter to use for matching events