org.xwiki.script.event.ScriptEvaluatingEvent Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of xwiki-commons-script Show documentation
XWiki Commons - Script
There is a newer version: 16.10.0-rc-1
/*
 * See the NOTICE file distributed with this work for additional
 * information regarding copyright ownership.
 *
 * This is free software; you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License as
 * published by the Free Software Foundation; either version 2.1 of
 * the License, or (at your option) any later version.
 *
 * This software is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this software; if not, write to the Free
 * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
 * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
 */
package org.xwiki.script.event;

import org.xwiki.observation.event.AbstractCancelableEvent;
import org.xwiki.observation.event.filter.EventFilter;

/**
 * An event triggered just before evaluation of a script macro (Groovy, Velocity, etc.) is started. The script will not
 * be executed if this event is canceled.
 * 
 * This event is supposed to be sent with {@code org.xwiki.rendering.transformation.MacroTransformationContext} as the
 * source and {@code org.xwiki.rendering.macro.script.ScriptMacroParameters} as data.
 * 
 *
 * @version $Id: 7d0c1237cbdd0acc5816aacdcf7e66293abe1615 $
 * @see ScriptEvaluatedEvent
 * @since 2.6RC2
 */
public class ScriptEvaluatingEvent extends AbstractCancelableEvent
{
    /** Serial version ID. Increment only if the serialized version of this class changes. */
    private static final long serialVersionUID = 1L;

    /**
     * Constructor initializing the event filter with an
     * {@link org.xwiki.observation.event.filter.AlwaysMatchingEventFilter}, meaning that this event will match any
     * other event of the same type.
     */
    public ScriptEvaluatingEvent()
    {
        super();
    }

    /**
     * Constructor initializing the event filter with a {@link org.xwiki.observation.event.filter.FixedNameEventFilter},
     * meaning that this event will match only events of the same type affecting the same passed name.
     *
     * @param scriptMacroName name of the macro to match, e.g. "velocity"
     */
    public ScriptEvaluatingEvent(String scriptMacroName)
    {
        super(scriptMacroName);
    }

    /**
     * Constructor using a custom {@link EventFilter}.
     *
     * @param eventFilter the filter to use for matching events
     */
    public ScriptEvaluatingEvent(EventFilter eventFilter)
    {
        super(eventFilter);
    }
}