AbstractDocumentEvent (XWiki Platform - Bridge 14.4 API)

java.lang.Object
- org.xwiki.observation.event.AbstractFilterableEvent
- - org.xwiki.observation.event.AbstractCancelableEvent
  - - org.xwiki.bridge.event.AbstractDocumentEvent

All Implemented Interfaces:

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

Direct Known Subclasses:

AbstractDocumentRestoreEvent, DocumentCreatedEvent, DocumentCreatingEvent, DocumentDeletedEvent, DocumentDeletingEvent, DocumentRolledBackEvent, DocumentRollingBackEvent, DocumentUpdatedEvent, DocumentUpdatingEvent, DocumentVersionRangeDeletedEvent, DocumentVersionRangeDeletingEvent
```
public abstract class AbstractDocumentEvent
extends org.xwiki.observation.event.AbstractCancelableEvent
```
Base class for all document related Event.

Since:

2.7RC1

Version:

$Id: bd0d16eb181e1e62f44d28082f1ecb90ee4bd4c3 $

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor	Description
`AbstractDocumentEvent()`	This event will match any other document event of the same type.
`AbstractDocumentEvent(DocumentReference documentReference)`	This event will match only events of the same type affecting the same document.
`AbstractDocumentEvent(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
  - AbstractDocumentEvent
```
public AbstractDocumentEvent()
```
    This event will match any other document event of the same type.
  - AbstractDocumentEvent
```
public AbstractDocumentEvent(DocumentReference documentReference)
```
    This event will match only events of the same type affecting the same document.
    
    Parameters:
    
    documentReference - the reference of the document relater to this event
  - AbstractDocumentEvent
```
public AbstractDocumentEvent(org.xwiki.observation.event.filter.EventFilter eventFilter)
```
    Constructor using a custom EventFilter.
    
    Parameters:
    
    eventFilter - the filter to use for matching events