org.osgi.framework.FrameworkEvent Class Reference

List of all members.


Detailed Description

A general event from the Framework.

FrameworkEvent is the event class used when notifying listeners of general events occuring within the OSGI environment. A type code is used to identify the event type for future extendability.

OSGi Alliance reserves the right to extend the set of event types.

Version:
Revision
1.14

Definition at line 37 of file FrameworkEvent.java.


Public Member Functions

 FrameworkEvent (int type, Object source)
 Creates a Framework event.
 FrameworkEvent (int type, Bundle bundle, Throwable throwable)
 Creates a Framework event regarding the specified bundle.
Throwable getThrowable ()
 Returns the exception related to this event.
Bundle getBundle ()
 Returns the bundle associated with the event.
int getType ()
 Returns the type of framework event.

Static Public Attributes

static final int STARTED = 0x00000001
 The Framework has started.
static final int ERROR = 0x00000002
 An error has occurred.
static final int PACKAGES_REFRESHED = 0x00000004
 A PackageAdmin.refreshPackage operation has completed.
static final int STARTLEVEL_CHANGED = 0x00000008
 A StartLevel.setStartLevel operation has completed.
static final int WARNING = 0x00000010
 A warning has occurred.
static final int INFO = 0x00000020
 An informational event has occurred.

Constructor & Destructor Documentation

org.osgi.framework.FrameworkEvent.FrameworkEvent ( int  type,
Object  source 
)

Creates a Framework event.

Parameters:
type The event type.
source The event source object. This may not be null.
Deprecated:
As of 1.2. This constructor is deprecated in favor of using the other constructor with the System Bundle as the event source.

Definition at line 147 of file FrameworkEvent.java.

org.osgi.framework.FrameworkEvent.FrameworkEvent ( int  type,
Bundle  bundle,
Throwable  throwable 
)

Creates a Framework event regarding the specified bundle.

Parameters:
type The event type.
bundle The event source.
throwable The related exception. This argument may be null if there is no related exception.

Definition at line 162 of file FrameworkEvent.java.


Member Function Documentation

Throwable org.osgi.framework.FrameworkEvent.getThrowable (  ) 

Returns the exception related to this event.

Returns:
The related exception or null if none.

Definition at line 174 of file FrameworkEvent.java.

Referenced by org.knopflerfish.framework.Listeners.frameworkEvent().

Bundle org.osgi.framework.FrameworkEvent.getBundle (  ) 

Returns the bundle associated with the event.

This bundle is also the source of the event.

Returns:
The bundle associated with the event.

Definition at line 184 of file FrameworkEvent.java.

Referenced by org.knopflerfish.framework.Listeners.frameworkEvent().

int org.osgi.framework.FrameworkEvent.getType (  ) 

Returns the type of framework event.

The type values are:

Returns:
The type of state change.

Definition at line 204 of file FrameworkEvent.java.

Referenced by org.knopflerfish.framework.Listeners.frameworkEvent().


Member Data Documentation

final int org.osgi.framework.FrameworkEvent.STARTED = 0x00000001 [static]

The Framework has started.

This event is fired when the Framework has started after all installed bundles that are marked to be started have been started and the Framework has reached the intitial start level.

The value of STARTED is 0x00000001.

See also:
"<code>StartLevel</code>"

Definition at line 67 of file FrameworkEvent.java.

final int org.osgi.framework.FrameworkEvent.ERROR = 0x00000002 [static]

An error has occurred.

There was an error associated with a bundle.

The value of ERROR is 0x00000002.

Definition at line 78 of file FrameworkEvent.java.

final int org.osgi.framework.FrameworkEvent.PACKAGES_REFRESHED = 0x00000004 [static]

A PackageAdmin.refreshPackage operation has completed.

This event is fired when the Framework has completed the refresh packages operation initiated by a call to the PackageAdmin.refreshPackages method.

The value of PACKAGES_REFRESHED is 0x00000004.

Since:
1.2
See also:
"<code>PackageAdmin.refreshPackages</code>"

Definition at line 94 of file FrameworkEvent.java.

final int org.osgi.framework.FrameworkEvent.STARTLEVEL_CHANGED = 0x00000008 [static]

A StartLevel.setStartLevel operation has completed.

This event is fired when the Framework has completed changing the active start level initiated by a call to the StartLevel.setStartLevel method.

The value of STARTLEVEL_CHANGED is 0x00000008.

Since:
1.2
See also:
"<code>StartLevel</code>"

Definition at line 110 of file FrameworkEvent.java.

final int org.osgi.framework.FrameworkEvent.WARNING = 0x00000010 [static]

A warning has occurred.

There was a warning associated with a bundle.

The value of WARNING is 0x00000010.

Since:
1.3

Definition at line 123 of file FrameworkEvent.java.

final int org.osgi.framework.FrameworkEvent.INFO = 0x00000020 [static]

An informational event has occurred.

There was an informational event associated with a bundle.

The value of INFO is 0x00000020.

Since:
1.3

Definition at line 136 of file FrameworkEvent.java.


The documentation for this class was generated from the following file:
Generated on Mon Jan 11 21:19:24 2010 for OpenMobileIS by  doxygen 1.5.4