Package org.xwiki.bridge.event
Class DocumentDeletedEvent
- java.lang.Object
-
- org.xwiki.observation.event.AbstractFilterableEvent
-
- org.xwiki.observation.event.AbstractCancelableEvent
-
- org.xwiki.bridge.event.AbstractDocumentEvent
-
- org.xwiki.bridge.event.DocumentDeletedEvent
-
- All Implemented Interfaces:
Serializable
,org.xwiki.observation.event.CancelableEvent
,org.xwiki.observation.event.Event
,org.xwiki.observation.event.FilterableEvent
public class DocumentDeletedEvent extends AbstractDocumentEvent
An event triggered after a document is deleted.The event also send the following parameters:
- source: the current {com.xpn.xwiki.doc.XWikiDocument} instance
- data: the current {com.xpn.xwiki.XWikiContext} instance
- Since:
- 2.7RC1
- Version:
- $Id: 51501e8ffacc553c2e35952b350afbac640d267a $
- See Also:
- Serialized Form
-
-
Constructor Summary
Constructors Constructor Description DocumentDeletedEvent()
Constructor initializing the event filter with anAlwaysMatchingEventFilter
, meaning that this event will match any other document delete event.DocumentDeletedEvent(DocumentReference documentReference)
Constructor initializing the event filter with aFixedNameEventFilter
, meaning that this event will match only delete events affecting the same document.DocumentDeletedEvent(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
-
DocumentDeletedEvent
public DocumentDeletedEvent()
Constructor initializing the event filter with anAlwaysMatchingEventFilter
, meaning that this event will match any other document delete event. Since listeners may expect to find the document reference in the event, it is recommended to use the constructor with the explicit parameter when generating the event.
-
DocumentDeletedEvent
public DocumentDeletedEvent(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
-
DocumentDeletedEvent
public DocumentDeletedEvent(org.xwiki.observation.event.filter.EventFilter eventFilter)
Constructor using a customEventFilter
.- Parameters:
eventFilter
- the filter to use for matching events
-
-