File DocumentCreatingEvent.java
Coverage histogram
64% of files have more coverage
Classes
| Class | Line # | Actions | |||||
|---|---|---|---|---|---|---|---|
| DocumentCreatingEvent | 38 | 3 | 0% | 3 | 2 |
Contributing tests
This file is covered by 22 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 created. | |
| 27 | * <p> | |
| 28 | * The event also send the following parameters: | |
| 29 | * </p> | |
| 30 | * <ul> | |
| 31 | * <li>source: the current {com.xpn.xwiki.doc.XWikiDocument} instance which is going to be saved</li> | |
| 32 | * <li>data: the current {com.xpn.xwiki.XWikiContext} instance</li> | |
| 33 | * </ul> | |
| 34 | * | |
| 35 | * @version $Id: 1eb6ee05e85cb8bb45aa8ed52a9d5d462a5ed755 $ | |
| 36 | * @since 2.7RC1 | |
| 37 | */ | |
| 38 | public class DocumentCreatingEvent extends AbstractDocumentEvent | |
| 39 | { | |
| 40 | /** | |
| 41 | * The version identifier for this Serializable class. Increment only if the <i>serialized</i> form of the class | |
| 42 | * changes. | |
| 43 | */ | |
| 44 | private static final long serialVersionUID = 1L; | |
| 45 | ||
| 46 | /** | |
| 47 | * Constructor initializing the event filter with an | |
| 48 | * {@link org.xwiki.observation.event.filter.AlwaysMatchingEventFilter}, meaning that this event will match any | |
| 49 | * other document delete event. | |
| 50 | */ | |
| 51 | 3 |  public DocumentCreatingEvent() |
| 52 | { | |
| 53 | 3 | super(); |
| 54 | } | |
| 55 | ||
| 56 | /** | |
| 57 | * Constructor initializing the event filter with a {@link org.xwiki.observation.event.filter.FixedNameEventFilter}, | |
| 58 | * meaning that this event will match only delete events affecting the same document. | |
| 59 | * | |
| 60 | * @param documentReference the reference of the document to match | |
| 61 | */ | |
| 62 | 3473 | public DocumentCreatingEvent(DocumentReference documentReference) |
| 63 | { | |
| 64 | 3473 | super(documentReference); |
| 65 | } | |
| 66 | ||
| 67 | /** | |
| 68 | * Constructor using a custom {@link EventFilter}. | |
| 69 | * | |
| 70 | * @param eventFilter the filter to use for matching events | |
| 71 | */ | |
| 72 | 0 | public DocumentCreatingEvent(EventFilter eventFilter) |
| 73 | { | |
| 74 | 0 | super(eventFilter); |
| 75 | } | |
| 76 | } |