org.xwiki.script.event

Class ScriptEvaluatedEvent

java.lang.Object

org.xwiki.observation.event.AbstractFilterableEvent

org.xwiki.script.event.ScriptEvaluatedEvent

All Implemented Interfaces:

Serializable, Event, FilterableEvent

public class ScriptEvaluatedEvent
extends AbstractFilterableEvent

An event triggered right after evaluation of a script macro (Groovy, Velocity, etc.) was finished (no matter successfully or not).

This event is supposed to be sent with org.xwiki.rendering.transformation.MacroTransformationContext as the source and org.xwiki.rendering.macro.script.ScriptMacroParameters as data.

Since:

2.6RC2

Version:

$Id: 0d6d7568ef879a02e4ea0c2363c6dc8bfb6cd66f $

See Also:

ScriptEvaluatingEvent, Serialized Form

Constructor Summary

Constructors

Constructor and Description
ScriptEvaluatedEvent() Constructor initializing the event filter with an AlwaysMatchingEventFilter, meaning that this event will match any other event of the same type.
ScriptEvaluatedEvent(EventFilter eventFilter) Constructor using a custom EventFilter.
ScriptEvaluatedEvent(String scriptMacroName) Constructor initializing the event filter with a FixedNameEventFilter, meaning that this event will match only events of the same type affecting the same passed name.

Method Summary

Methods inherited from class org.xwiki.observation.event.AbstractFilterableEvent

equals, getEventFilter, hashCode, matches

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ScriptEvaluatedEvent

public ScriptEvaluatedEvent()

Constructor initializing the event filter with an AlwaysMatchingEventFilter, meaning that this event will match any other event of the same type.

ScriptEvaluatedEvent

public ScriptEvaluatedEvent(String scriptMacroName)

Constructor initializing the event filter with a FixedNameEventFilter, meaning that this event will match only events of the same type affecting the same passed name.

Parameters:

scriptMacroName - name of the macro to match, e.g. "velocity"

ScriptEvaluatedEvent

public ScriptEvaluatedEvent(EventFilter eventFilter)

Constructor using a custom EventFilter.

Parameters:

eventFilter - the filter to use for matching events