org.appdapter.module.basic
Class NullModule<PM extends Modulator>

java.lang.Object
  org.appdapter.core.log.BasicDebugger
      org.appdapter.module.basic.BasicModule<PM>
          org.appdapter.module.basic.NullModule<PM>

All Implemented Interfaces:

Module<PM>

Direct Known Subclasses:

BasicModuleTestOne.PowerModule

public class NullModule<PM extends Modulator>
extends BasicModule<PM>

Author:

Stu B.

Nested Class Summary

Nested classes/interfaces inherited from interface org.appdapter.api.module.Module

Module.State

Field Summary

Fields inherited from class org.appdapter.core.log.BasicDebugger

IMPO_HI, IMPO_HIHI, IMPO_LO, IMPO_LOLO, IMPO_MAX, IMPO_MIN, IMPO_NORM

Constructor Summary

NullModule()

Method Summary

void	initModule() Modulator must be set when initModule is called.
void	releaseModule() Required pre-state is POST_STOP_OR_FAILED_STARTUP.
void	runOnce() Required pre-state is WAIT_TO_RUN_OR_STOP.
void	start() Required pre-state is WAIT_TO_START.
void	stop() Required pre-state is WAIT_TO_RUN_OR_STOP.

Methods inherited from class org.appdapter.module.basic.BasicModule

enterBasicInitModule, enterBasicReleaseModule, enterBasicRunOnce, enterBasicStart, enterBasicStop, exitBasicInitModule, exitBasicReleaseModule, exitBasicRunOnce, exitBasicStart, exitBasicStop, failDuringInitOrStartup, getDescription, getParentModulator, getState, isStopRequested, markStopRequested, notifyStateViolation, setParentModulator, toString, verifyStoredState

Methods inherited from class org.appdapter.core.log.BasicDebugger

checkDebugImportance, getLogger, isLoggerUsable, logError, logInfo, logInfo, logInfoEvent, setDebugImportanceThreshold, setLogger

Methods inherited from class java.lang.Object

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

Constructor Detail

NullModule

public NullModule()

Method Detail

initModule

public void initModule()

Description copied from interface: Module

Modulator must be set when initModule is called. initModule is called exactly once, by the modulator, and can be First method called on Module, and called only once. Can only be called by the modulatorModule Upon return, must be in WAIT_TO_START, or or POST_STOP_OR_FAILED_STARTUP.

start

public void start()

Description copied from interface: Module

Required pre-state is WAIT_TO_START. During-state is IN_START Upon return, state is WAIT_TO_RUN_OR_STOP, or POST_STOP_OR_FAILED_STARTUP.

runOnce

public void runOnce()

Description copied from interface: Module

Required pre-state is WAIT_TO_RUN_OR_STOP. During-state is IN_RUN. Upon return, state is WAIT_TO_RUN_OR_STOP.

stop

public void stop()

Description copied from interface: Module

Required pre-state is WAIT_TO_RUN_OR_STOP. During-state is IN_STOP. Upon return, state is POST_STOP_OR_FAILED_STARTUP.

releaseModule

public void releaseModule()

Description copied from interface: Module

Required pre-state is POST_STOP_OR_FAILED_STARTUP. Module is no longer usable as soon as call begins. Should not throw.