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

File AbstractDocumentEvent.java

 

Coverage histogram

../../../../img/srcFileCovDistChart10.png
0% of files have more coverage

Code metrics

0
3
3
1
75
24
3
1
1
3
1

Classes

Class Line # Actions
AbstractDocumentEvent 34 3 0% 3 0
1.0100%
 

Contributing tests

This file is covered by 169 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.internal.reference.DefaultStringEntityReferenceSerializer;
23    import org.xwiki.model.internal.reference.DefaultSymbolScheme;
24    import org.xwiki.model.reference.DocumentReference;
25    import org.xwiki.observation.event.AbstractCancelableEvent;
26    import org.xwiki.observation.event.filter.EventFilter;
27   
28    /**
29    * Base class for all document related {@link org.xwiki.observation.event.Event}.
30    *
31    * @version $Id: bd0d16eb181e1e62f44d28082f1ecb90ee4bd4c3 $
32    * @since 2.7RC1
33    */
 
34    public abstract class AbstractDocumentEvent extends AbstractCancelableEvent
35    {
36    /**
37    * The version identifier for this Serializable class. Increment only if the <i>serialized</i> form of the class
38    * changes.
39    */
40    private static final long serialVersionUID = 1L;
41   
42    /**
43    * Used to serialize document name.
44    */
45    private static final DefaultStringEntityReferenceSerializer SERIALIZER =
46    new DefaultStringEntityReferenceSerializer(new DefaultSymbolScheme());
47   
48    /**
49    * This event will match any other document event of the same type.
50    */
 
51  5140 toggle public AbstractDocumentEvent()
52    {
53  5140 super();
54    }
55   
56    /**
57    * This event will match only events of the same type affecting the same document.
58    *
59    * @param documentReference the reference of the document relater to this event
60    */
 
61  18819 toggle public AbstractDocumentEvent(DocumentReference documentReference)
62    {
63  18819 super(SERIALIZER.serialize(documentReference));
64    }
65   
66    /**
67    * Constructor using a custom {@link EventFilter}.
68    *
69    * @param eventFilter the filter to use for matching events
70    */
 
71  758 toggle public AbstractDocumentEvent(EventFilter eventFilter)
72    {
73  758 super(eventFilter);
74    }
75    }