Package org.xwiki.bridge.event
Class DocumentUpdatedEvent
- java.lang.Object
-
- org.xwiki.observation.event.AbstractFilterableEvent
-
- org.xwiki.observation.event.AbstractCancelableEvent
-
- org.xwiki.bridge.event.AbstractDocumentEvent
-
- org.xwiki.bridge.event.DocumentUpdatedEvent
-
- All Implemented Interfaces:
Serializable
,org.xwiki.observation.event.CancelableEvent
,org.xwiki.observation.event.Event
,org.xwiki.observation.event.FilterableEvent
public class DocumentUpdatedEvent extends AbstractDocumentEvent
An event triggered after a document is updated.The event also send the following parameters:
- source: the current {com.xpn.xwiki.doc.XWikiDocument} instance from which you can get the "original" document (the version before all the modifications)
- data: the current {com.xpn.xwiki.XWikiContext} instance
- Since:
- 2.7RC1
- Version:
- $Id: a013c5c662f7a890c4b3a6c918030bd27a95e848 $
- See Also:
- Serialized Form
-
-
Constructor Summary
Constructors Constructor Description DocumentUpdatedEvent()
Constructor initializing the event filter with anAlwaysMatchingEventFilter
, meaning that this event will match any other document delete event.DocumentUpdatedEvent(DocumentReference documentReference)
Constructor initializing the event filter with aFixedNameEventFilter
, meaning that this event will match only delete events affecting the same document.DocumentUpdatedEvent(org.xwiki.observation.event.filter.EventFilter eventFilter)
Constructor using a customEventFilter
.
-
Method Summary
-
Methods inherited from class org.xwiki.bridge.event.AbstractDocumentEvent
getDocumentReference
-
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
-
-
-
-
Constructor Detail
-
DocumentUpdatedEvent
public DocumentUpdatedEvent()
Constructor initializing the event filter with anAlwaysMatchingEventFilter
, meaning that this event will match any other document delete event.
-
DocumentUpdatedEvent
public DocumentUpdatedEvent(DocumentReference documentReference)
Constructor initializing the event filter with aFixedNameEventFilter
, meaning that this event will match only delete events affecting the same document.- Parameters:
documentReference
- the reference of the document to match
-
DocumentUpdatedEvent
public DocumentUpdatedEvent(org.xwiki.observation.event.filter.EventFilter eventFilter)
Constructor using a customEventFilter
.- Parameters:
eventFilter
- the filter to use for matching events
-
-