org.jboss.gravia.runtime

Class ModuleEvent

java.lang.Object

java.util.EventObject

org.jboss.gravia.runtime.ModuleEvent

All Implemented Interfaces:

Serializable

public class ModuleEvent
extends EventObject

An event from the Runtime describing a module lifecycle change.

ModuleEvent objects are delivered to SynchronousModuleListeners and ModuleListeners when a change occurs in a module's lifecycle. A type code is used to identify the event type for future extendability.

Since:

27-Sep-2013

Author:

thomas.diesler@jboss.com

See Also:

ModuleListener, SynchronousModuleListener, Serialized Form

Thread Safety: Immutable

Field Summary

Fields

Modifier and Type	Field and Description
static int	INSTALLED The module has been installed.
static int	STARTED The module has been started.
static int	STARTING The module is about to be activated.
static int	STOPPED The module has been stopped.
static int	STOPPING The module is about to deactivated.
static int	UNINSTALLED The module has been uninstalled.

Fields inherited from class java.util.EventObject

source

Constructor Summary

Constructors

Constructor and Description
ModuleEvent(int type, Module module) Creates a module event of the specified type.

Method Summary

Methods

Modifier and Type	Method and Description
Module	getModule() Returns the module which had a lifecycle change.
int	getType() Returns the type of lifecyle event.

Methods inherited from class java.util.EventObject

getSource, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

INSTALLED

public static final int INSTALLED

The module has been installed.

See Also:

Constant Field Values

STARTED

public static final int STARTED

The module has been started.

The module's ModuleActivator start method has been executed if the module has a module activator class.

See Also:

Module.start(), Constant Field Values

STOPPED

public static final int STOPPED

The module has been stopped.

The module's ModuleActivator stop method has been executed if the module has a module activator class.

See Also:

Module.stop(), Constant Field Values

UNINSTALLED

public static final int UNINSTALLED

The module has been uninstalled.

See Also:

Module.uninstall(), Constant Field Values

STARTING

public static final int STARTING

The module is about to be activated.

The module's ModuleActivator start method is about to be called if the module has a module activator class. This event is only delivered to SynchronousModuleListener s. It is not delivered to ModuleListeners.

See Also:

Module.start(), Constant Field Values

STOPPING

public static final int STOPPING

The module is about to deactivated.

The module's ModuleActivator stop method is about to be called if the module has a module activator class. This event is only delivered to SynchronousModuleListener s. It is not delivered to ModuleListeners.

See Also:

Module.stop(), Constant Field Values

Constructor Detail

ModuleEvent

public ModuleEvent(int type,
           Module module)

Creates a module event of the specified type.

Parameters:

type - The event type.

module - The module which had a lifecycle change. This module is used as the origin of the event.

Method Detail

getModule

public Module getModule()

Returns the module which had a lifecycle change. This module is the source of the event.

Returns:

The module that had a change occur in its lifecycle.

getType

public int getType()

Returns the type of lifecyle event. The type values are:

• INSTALLED
• STARTED
• STOPPED
• UNINSTALLED
• STARTING
• STOPPING

Returns:

The type of lifecycle event.