1. Project Clover database Sat Feb 2 2019 06:45:20 CET
  2. Package org.xwiki.bridge.event

File DocumentDeletingEvent.java

 

Coverage histogram

../../../../img/srcFileCovDistChart4.png
80% of files have more coverage

Code metrics

0
3
3
1
77
19
3
1
1
3
1

Classes

Class Line # Actions
DocumentDeletingEvent 39 3 0% 3 4
0.3333333433.3%
 

Contributing tests

This file is covered by 3 tests. .

Source view

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 toggle 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  292 toggle public DocumentDeletingEvent(DocumentReference documentReference)
64    {
65  292 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 toggle public DocumentDeletingEvent(EventFilter eventFilter)
74    {
75  0 super(eventFilter);
76    }
77    }