org.openksavi.sponge.core.engine

Class BaseEngineModule

java.lang.Object

org.openksavi.sponge.core.engine.BaseEngineModule

All Implemented Interfaces:

EngineModule, Descriptive, HasEngine, Manageable

Direct Known Subclasses:

BaseEventQueue, BaseEventScheduler, BasePlugin, BaseProcessingUnit, BaseSpongeEngine, DefaultActionManager, DefaultConfigurationManager, DefaultEventQueueManager, DefaultKnowledgeBaseManager, DefaultPluginManager, DefaultProcessingUnitManager, DefaultProcessorManager, DefaultStatisticsManager, DefaultThreadPoolManager

public abstract class BaseEngineModule
extends Object
implements EngineModule

A base engine module.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	BaseEngineModule() Creates a new module.
protected	BaseEngineModule(String name) Creates a new module.
protected	BaseEngineModule(String name, SpongeEngine engine) Creates a new module.

Method Summary

Modifier and Type	Method and Description
protected void	doShutdown()
protected void	doStartup()
String	getDescription()
SpongeEngine	getEngine() Returns the engine.
com.google.common.util.concurrent.Service	getInternalService()
String	getLabel()
String	getName() Returns the name.
com.google.common.util.concurrent.Service.State	getState()
boolean	isFailed()
boolean	isNew()
boolean	isNewOrStartingOrRunning()
boolean	isRunning() Informs whether this managed entity is running.
boolean	isStarting()
boolean	isStopping()
boolean	isTerminated()
void	setDescription(String description)
void	setEngine(SpongeEngine engine) Sets the engine.
void	setLabel(String label)
void	setName(String name) Sets module name.
void	shutdown() Shuts down this managed entity.
void	startup() Starts up this managed entity.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

BaseEngineModule

protected BaseEngineModule(String name,
                           SpongeEngine engine)

Creates a new module.

Parameters:

name - name.

engine - the engine.

BaseEngineModule

protected BaseEngineModule(String name)

Creates a new module.

Parameters:

name - name.

BaseEngineModule

protected BaseEngineModule()

Creates a new module.

Method Detail

setEngine

public void setEngine(SpongeEngine engine)

Sets the engine.

Specified by:

setEngine in interface HasEngine

Parameters:

engine - the engine.

getEngine

public SpongeEngine getEngine()

Returns the engine.

Specified by:

getEngine in interface HasEngine

Returns:

the engine.

getName

public String getName()

Returns the name.

Specified by:

getName in interface Descriptive

Returns:

name.

setName

public void setName(String name)

Sets module name.

Specified by:

setName in interface Descriptive

Parameters:

name - module name.

getLabel

public String getLabel()

Specified by:

getLabel in interface Descriptive

setLabel

public void setLabel(String label)

Specified by:

setLabel in interface Descriptive

getDescription

public String getDescription()

Specified by:

getDescription in interface Descriptive

setDescription

public void setDescription(String description)

Specified by:

setDescription in interface Descriptive

doStartup

protected void doStartup()

doShutdown

protected void doShutdown()

startup

public void startup()

Starts up this managed entity.

Specified by:

startup in interface Manageable

shutdown

public void shutdown()

Shuts down this managed entity.

Specified by:

shutdown in interface Manageable

isNew

public final boolean isNew()

Specified by:

isNew in interface Manageable

isStarting

public final boolean isStarting()

Specified by:

isStarting in interface Manageable

isRunning

public final boolean isRunning()

Informs whether this managed entity is running.

Specified by:

isRunning in interface Manageable

Returns:

if this managed entity is running.

isStopping

public final boolean isStopping()

Specified by:

isStopping in interface Manageable

isTerminated

public final boolean isTerminated()

Specified by:

isTerminated in interface Manageable

isFailed

public final boolean isFailed()

Specified by:

isFailed in interface Manageable

getState

public com.google.common.util.concurrent.Service.State getState()

getInternalService

public com.google.common.util.concurrent.Service getInternalService()

isNewOrStartingOrRunning

public boolean isNewOrStartingOrRunning()

toString

public String toString()

Overrides:

toString in class Object