Class | Line # | Actions | |||||
---|---|---|---|---|---|---|---|
AnnotationAddedEvent | 37 | 3 | 0% | 3 | 2 |
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.annotation.event; | |
21 | ||
22 | import org.xwiki.observation.event.filter.EventFilter; | |
23 | ||
24 | /** | |
25 | * An event triggered when an annotation is added. | |
26 | * <p> | |
27 | * The event also send the following parameters: | |
28 | * </p> | |
29 | * <ul> | |
30 | * <li>source: the current {com.xpn.xwiki.doc.XWikiDocument} instance</li> | |
31 | * <li>data: the current {com.xpn.xwiki.XWikiContext} instance</li> | |
32 | * </ul> | |
33 | * | |
34 | * @version $Id: 75d3f32e1ee6515d6f61fab5bd1337f9a73910c6 $ | |
35 | * @since 2.6RC2 | |
36 | */ | |
37 | public class AnnotationAddedEvent extends AbstractAnnotationEvent | |
38 | { | |
39 | /** | |
40 | * The version identifier for this Serializable class. Increment only if the <i>serialized</i> form of the class | |
41 | * changes. | |
42 | */ | |
43 | private static final long serialVersionUID = 1L; | |
44 | ||
45 | /** | |
46 | * Constructor initializing the event filter with an | |
47 | * {@link org.xwiki.observation.event.filter.AlwaysMatchingEventFilter}, meaning that this event will match any | |
48 | * other annotation add event. | |
49 | */ | |
50 | 1 | public AnnotationAddedEvent() |
51 | { | |
52 | 1 | super(); |
53 | } | |
54 | ||
55 | /** | |
56 | * Constructor initializing the event filter with a {@link org.xwiki.observation.event.filter.FixedNameEventFilter}, | |
57 | * meaning that this event will match only annotation add events affecting the document matching the passed document | |
58 | * name. | |
59 | * | |
60 | * @param documentName the name of the document to match | |
61 | * @param identifier the identifier of the added annotation | |
62 | */ | |
63 | 4 | public AnnotationAddedEvent(String documentName, String identifier) |
64 | { | |
65 | 4 | super(documentName, identifier); |
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 AnnotationAddedEvent(EventFilter eventFilter) |
74 | { | |
75 | 0 | super(eventFilter); |
76 | } | |
77 | } |