Package org.xwiki.bridge.event
Class DocumentUpdatingEvent
- java.lang.Object
-
- org.xwiki.observation.event.AbstractFilterableEvent
-
- org.xwiki.observation.event.AbstractCancelableEvent
-
- org.xwiki.bridge.event.AbstractDocumentEvent
-
- org.xwiki.bridge.event.DocumentUpdatingEvent
-
- All Implemented Interfaces:
Serializable
,org.xwiki.observation.event.CancelableEvent
,org.xwiki.observation.event.Event
,org.xwiki.observation.event.FilterableEvent
public class DocumentUpdatingEvent extends AbstractDocumentEvent
An event triggered before 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: 0161ef9fd1a196d073558fc1ba825766a339fdfb $
- See Also:
- Serialized Form
-
-
Constructor Summary
Constructors Constructor Description DocumentUpdatingEvent()
Constructor initializing the event filter with anAlwaysMatchingEventFilter
, meaning that this event will match any other document delete event.DocumentUpdatingEvent(DocumentReference documentReference)
Constructor initializing the event filter with aFixedNameEventFilter
, meaning that this event will match only delete events affecting the same document.DocumentUpdatingEvent(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
-
DocumentUpdatingEvent
public DocumentUpdatingEvent()
Constructor initializing the event filter with anAlwaysMatchingEventFilter
, meaning that this event will match any other document delete event.
-
DocumentUpdatingEvent
public DocumentUpdatingEvent(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
-
DocumentUpdatingEvent
public DocumentUpdatingEvent(org.xwiki.observation.event.filter.EventFilter eventFilter)
Constructor using a customEventFilter
.- Parameters:
eventFilter
- the filter to use for matching events
-
-