com.tplan.robot.plugin

Class PluginEvent

java.lang.Object

com.tplan.robot.plugin.PluginEvent

public class PluginEvent
extends Object

Plugin event is fired by the PluginManager to PluginListener instances and indicates that a plugin was installed, uninstalled, enabled or disabled.

T-Plan Robot Enterprise, (C) 2009-2022 T-Plan Limited. All rights reserved.

Field Summary

Fields

Modifier and Type	Field and Description
static int	PLUGIN_DISABLED Event code 5 indicates that a plugin was disabled.
static int	PLUGIN_ENABLED Event code 4 indicates that a plugin was enabled.
static int	PLUGIN_INSTALLED Event code 1 indicates that a plugin was installed.
static int	PLUGIN_UNINSTALLED Event code 2 indicates that a plugin was uninstalled.
static int	PLUGIN_UPDATED Event code 3 indicates that a plugin was updated (upgraded to higher version).

Constructor Summary

Constructors

Constructor and Description
PluginEvent(Object source, int eventType, PluginInfo plugin) Event constructor.

Method Summary

Modifier and Type	Method and Description
int	getEventType() Get the event type.
PluginInfo	getPluginInfo() Get plugin associated with this event.
Object	getSource() Get source of the event (most time a PluginManager instance).

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

PLUGIN_INSTALLED

public static final int PLUGIN_INSTALLED

Event code 1 indicates that a plugin was installed.

See Also:

Constant Field Values

PLUGIN_UNINSTALLED

public static final int PLUGIN_UNINSTALLED

Event code 2 indicates that a plugin was uninstalled.

See Also:

Constant Field Values

PLUGIN_UPDATED

public static final int PLUGIN_UPDATED

Event code 3 indicates that a plugin was updated (upgraded to higher version).

See Also:

Constant Field Values

PLUGIN_ENABLED

public static final int PLUGIN_ENABLED

Event code 4 indicates that a plugin was enabled.

See Also:

Constant Field Values

PLUGIN_DISABLED

public static final int PLUGIN_DISABLED

Event code 5 indicates that a plugin was disabled.

See Also:

Constant Field Values

Constructor Detail

PluginEvent

public PluginEvent(Object source,
                   int eventType,
                   PluginInfo plugin)

Event constructor.

Parameters:

source - plugin source (most time a PluginManager instance).

eventType - event type code.

plugin - a plugin.

Method Detail

getPluginInfo

public PluginInfo getPluginInfo()

Get plugin associated with this event.

Returns:

the plugin.

getSource

public Object getSource()

Get source of the event (most time a PluginManager instance).

Returns:

event source.

getEventType

public int getEventType()

Get the event type.

Returns:

event type.