org.xwiki.annotation.event
Class AnnotationUpdatedEvent

java.lang.Object
  extended by org.xwiki.observation.event.AbstractFilterableEvent
      extended by org.xwiki.bridge.event.AbstractDocumentEvent
          extended by org.xwiki.annotation.event.AbstractAnnotationEvent
              extended by org.xwiki.annotation.event.AnnotationUpdatedEvent
All Implemented Interfaces:
Serializable, AnnotationEvent, Event, FilterableEvent

public class AnnotationUpdatedEvent
extends AbstractAnnotationEvent

An event triggered when an annotation is updated.

Since:
2.6RC2
See Also:
Serialized Form

Constructor Summary
AnnotationUpdatedEvent()
          Constructor initializing the event filter with an AlwaysMatchingEventFilter, meaning that this event will match any other annotation update event.
AnnotationUpdatedEvent(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.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(EventFilter eventFilter)
Constructor using a custom EventFilter.

Parameters:
eventFilter - the filter to use for matching events