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