DocumentUpdatingEvent (XWiki Platform - Bridge 14.4 API)

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 which is going to be saved
- data: the current {com.xpn.xwiki.XWikiContext} instance
Since:

2.7RC1

Version:

$Id: 96dbc37e2f856c258a8b92d6d6aea5201e2ff025 $

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor	Description
`DocumentUpdatingEvent()`	Constructor initializing the event filter with an `AlwaysMatchingEventFilter`, meaning that this event will match any other document delete event.
`DocumentUpdatingEvent(DocumentReference documentReference)`	Constructor initializing the event filter with a `FixedNameEventFilter`, meaning that this event will match only delete events affecting the same document.
`DocumentUpdatingEvent(org.xwiki.observation.event.filter.EventFilter eventFilter)`	Constructor using a custom `EventFilter`.

Method Summary
- 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.Event
  matches

- Constructor Detail
  - DocumentUpdatingEvent
```
public DocumentUpdatingEvent()
```
    Constructor initializing the event filter with an AlwaysMatchingEventFilter, meaning that this event will match any other document delete event.
  - DocumentUpdatingEvent
```
public DocumentUpdatingEvent(DocumentReference documentReference)
```
    Constructor initializing the event filter with a FixedNameEventFilter, 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 custom EventFilter.
    
    Parameters:
    
    eventFilter - the filter to use for matching events