1. Project Clover database Tue Dec 20 2016 21:24:09 CET
  2. Package org.xwiki.script.event

File ScriptEvaluatingEvent.java

 

Coverage histogram

../../../../img/srcFileCovDistChart7.png
64% of files have more coverage

Code metrics

0
3
3
1
72
19
3
1
1
3
1

Classes

Class Line # Actions
ScriptEvaluatingEvent 37 3 0% 3 2
0.666666766.7%
 

Contributing tests

This file is covered by 101 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.script.event;
21   
22    import org.xwiki.observation.event.AbstractCancelableEvent;
23    import org.xwiki.observation.event.filter.EventFilter;
24   
25    /**
26    * An event triggered just before evaluation of a script macro (Groovy, Velocity, etc.) is started. The script will not
27    * be executed if this event is canceled.
28    * <p>
29    * This event is supposed to be sent with {@code org.xwiki.rendering.transformation.MacroTransformationContext} as the
30    * source and {@code org.xwiki.rendering.macro.script.ScriptMacroParameters} as data.
31    * </p>
32    *
33    * @version $Id: 7d0c1237cbdd0acc5816aacdcf7e66293abe1615 $
34    * @see ScriptEvaluatedEvent
35    * @since 2.6RC2
36    */
 
37    public class ScriptEvaluatingEvent extends AbstractCancelableEvent
38    {
39    /** Serial version ID. Increment only if the <i>serialized</i> version of this class changes. */
40    private static final long serialVersionUID = 1L;
41   
42    /**
43    * Constructor initializing the event filter with an
44    * {@link org.xwiki.observation.event.filter.AlwaysMatchingEventFilter}, meaning that this event will match any
45    * other event of the same type.
46    */
 
47  444 toggle public ScriptEvaluatingEvent()
48    {
49  444 super();
50    }
51   
52    /**
53    * Constructor initializing the event filter with a {@link org.xwiki.observation.event.filter.FixedNameEventFilter},
54    * meaning that this event will match only events of the same type affecting the same passed name.
55    *
56    * @param scriptMacroName name of the macro to match, e.g. "velocity"
57    */
 
58  8750 toggle public ScriptEvaluatingEvent(String scriptMacroName)
59    {
60  8750 super(scriptMacroName);
61    }
62   
63    /**
64    * Constructor using a custom {@link EventFilter}.
65    *
66    * @param eventFilter the filter to use for matching events
67    */
 
68  0 toggle public ScriptEvaluatingEvent(EventFilter eventFilter)
69    {
70  0 super(eventFilter);
71    }
72    }