Package org.sensorhub.api.module

Class ModuleEvent

java.lang.Object

org.sensorhub.api.event.Event

org.sensorhub.api.module.ModuleEvent

public class ModuleEvent
extends Event

Event type generated at various times during a module's lifecycle

Since:

Sep 5, 2013

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	ModuleEvent.ModuleState
static enum	ModuleEvent.Type

Field Summary

Fields

Modifier and Type	Field	Description
protected Throwable	error
protected String	moduleID
protected String	msg
protected ModuleEvent.ModuleState	newState
protected ModuleEvent.Type	type

Fields inherited from class org.sensorhub.api.event.Event

source, timeStamp

Constructor Summary

Constructors

Constructor	Description
ModuleEvent(IModule<?> module, String msg)
ModuleEvent(IModule<?> module, Throwable error)
ModuleEvent(IModule<?> module, ModuleEvent.ModuleState newState)
ModuleEvent(IModule<?> module, ModuleEvent.Type type)

Method Summary

Modifier and Type	Method	Description
Throwable	getError()
String	getMessage()
IModule<?>	getModule()
ModuleEvent.ModuleState	getNewState()
String	getSourceID()	Gets the ID of the source of event.
ModuleEvent.Type	getType()

Methods inherited from class org.sensorhub.api.event.Event

getSource, getTimeStamp, toString

Methods inherited from class java.lang.Object

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

Field Details

moduleID

protected String moduleID

type

protected ModuleEvent.Type type

newState

protected ModuleEvent.ModuleState newState

error

protected Throwable error

msg

protected String msg

Constructor Details

ModuleEvent

public ModuleEvent(IModule<?> module,
 ModuleEvent.Type type)

ModuleEvent

public ModuleEvent(IModule<?> module,
 ModuleEvent.ModuleState newState)

ModuleEvent

public ModuleEvent(IModule<?> module,
 Throwable error)

ModuleEvent

public ModuleEvent(IModule<?> module,
 String msg)

Method Details

getSourceID

public String getSourceID()

Description copied from class: Event

Gets the ID of the source of event.

Specified by:

getSourceID in class Event

Returns:

ID of the event source

getModule

public IModule<?> getModule()

getType

public ModuleEvent.Type getType()

getNewState

public ModuleEvent.ModuleState getNewState()

getError

public Throwable getError()

getMessage

public String getMessage()