Class | Line # | Actions | |||||
---|---|---|---|---|---|---|---|
DocumentDeletingEvent | 39 | 3 | 0% | 3 | 4 |
1 | /* | |
2 | * See the NOTICE file distributed with this work for additional | |
3 | * information regarding copyright ownership. | |
4 | * | |
5 | * This is free software; you can redistribute it and/or modify it | |
6 | * under the terms of the GNU Lesser General Public License as | |
7 | * published by the Free Software Foundation; either version 2.1 of | |
8 | * the License, or (at your option) any later version. | |
9 | * | |
10 | * This software is distributed in the hope that it will be useful, | |
11 | * but WITHOUT ANY WARRANTY; without even the implied warranty of | |
12 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU | |
13 | * Lesser General Public License for more details. | |
14 | * | |
15 | * You should have received a copy of the GNU Lesser General Public | |
16 | * License along with this software; if not, write to the Free | |
17 | * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA | |
18 | * 02110-1301 USA, or see the FSF site: http://www.fsf.org. | |
19 | */ | |
20 | package org.xwiki.bridge.event; | |
21 | ||
22 | import org.xwiki.model.reference.DocumentReference; | |
23 | import org.xwiki.observation.event.filter.EventFilter; | |
24 | ||
25 | /** | |
26 | * An event triggered before a document is deleted. | |
27 | * <p> | |
28 | * The event also send the following parameters: | |
29 | * </p> | |
30 | * <ul> | |
31 | * <li>source: what the document will look like after the delete, it's possible to access the deleted document using | |
32 | * XWikDocument#getOriginalDocument()</li> | |
33 | * <li>data: the current {com.xpn.xwiki.XWikiContext} instance</li> | |
34 | * </ul> | |
35 | * | |
36 | * @version $Id: 1a301985d9043449c8e7ad3200bc5e47473b2137 $ | |
37 | * @since 2.7RC1 | |
38 | */ | |
39 | public class DocumentDeletingEvent extends AbstractDocumentEvent | |
40 | { | |
41 | /** | |
42 | * The version identifier for this Serializable class. Increment only if the <i>serialized</i> form of the class | |
43 | * changes. | |
44 | */ | |
45 | private static final long serialVersionUID = 1L; | |
46 | ||
47 | /** | |
48 | * Constructor initializing the event filter with an | |
49 | * {@link org.xwiki.observation.event.filter.AlwaysMatchingEventFilter}, meaning that this event will match any | |
50 | * other document delete event. | |
51 | */ | |
52 | 0 | public DocumentDeletingEvent() |
53 | { | |
54 | 0 | super(); |
55 | } | |
56 | ||
57 | /** | |
58 | * Constructor initializing the event filter with a {@link org.xwiki.observation.event.filter.FixedNameEventFilter}, | |
59 | * meaning that this event will match only delete events affecting the same document. | |
60 | * | |
61 | * @param documentReference the reference of the document to match | |
62 | */ | |
63 | 158 | public DocumentDeletingEvent(DocumentReference documentReference) |
64 | { | |
65 | 158 | super(documentReference); |
66 | } | |
67 | ||
68 | /** | |
69 | * Constructor using a custom {@link EventFilter}. | |
70 | * | |
71 | * @param eventFilter the filter to use for matching events | |
72 | */ | |
73 | 0 | public DocumentDeletingEvent(EventFilter eventFilter) |
74 | { | |
75 | 0 | super(eventFilter); |
76 | } | |
77 | } |