org.appdapter.module.basic

Class BasicModule<Ctx>

java.lang.Object

org.appdapter.core.log.BasicDebugger

org.appdapter.bind.rdf.jena.assembly.KnownComponentImpl

org.appdapter.module.basic.BasicModule<Ctx>

All Implemented Interfaces:

Module<Ctx>, AnyOper.HasIdent, KnownComponent, MutableKnownComponent, UIAnnotations.ApplyToClassInterfaces, Loggable

Direct Known Subclasses:

NullModule, TimedModule

public abstract class BasicModule<Ctx>
extends KnownComponentImpl
implements Module<Ctx>

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

myLogger

Fields inherited from interface org.appdapter.api.trigger.AnyOper.HasIdent

HASIDENT

Fields inherited from interface org.appdapter.core.log.Loggable

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

Constructor Summary

Constructors

Constructor and Description
BasicModule()

Method Summary

Methods

Modifier and Type	Method and Description
protected void	enterBasicInitModule(boolean verifyPreInitState)
protected void	enterBasicReleaseModule()
protected void	enterBasicRunOnce()
protected void	enterBasicStart()
protected void	enterBasicStop()
protected void	exitBasicInitModule(boolean verifyInInitState)
protected void	exitBasicReleaseModule()
protected void	exitBasicRunOnce()
protected void	exitBasicStart()
protected void	exitBasicStop()
void	failDuringInitOrStartup()
Ctx	getContext() The Module must have a valid parentModulator whenever it is inside a module action callback.
String	getFieldSummary()
Module.State	getState()
boolean	isStopRequested()
void	markStopRequested() Correct way for application to ask the module to stop.
protected void	notifyStateViolation(String detectingMethod, String expectedStateDesc, boolean throExcept)
void	setContext(Ctx m)
protected void	verifyStoredState(String checkingMethod, boolean throExcept, Module.State... allowedStates) Ensure we are in an allowed state, will notifyStateViolation if not.

Methods inherited from class org.appdapter.bind.rdf.jena.assembly.KnownComponentImpl

getDescription, getIdent, getShortLabel, setDescription, setIdent, setShortLabel, toString

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

checkDebugImportance, forceLog4jConfig, getLogger, getLoggerForClass, isLoggerUsable, logDebug, logError, logError, logInfo, logInfo, logInfoEvent, logWarning, logWarning, logWithException, setDebugImportanceThreshold, setLogger, useLoggerForClass

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.appdapter.api.module.Module

initModule, releaseModule, runOnce, start, stop

Constructor Detail

BasicModule

public BasicModule()

Method Detail

getState

public Module.State getState()

Specified by:

getState in interface Module<Ctx>

Returns:

Current state, subject to synchronization behavior of this module.

markStopRequested

public void markStopRequested()

Correct way for application to ask the module to stop.

Specified by:

markStopRequested in interface Module<Ctx>

isStopRequested

public boolean isStopRequested()

Specified by:

isStopRequested in interface Module<Ctx>

getContext

public Ctx getContext()

Description copied from interface: Module

The Module must have a valid parentModulator whenever it is inside a module action callback.

Specified by:

getContext in interface Module<Ctx>

Returns:

Current Modulator, subject to synchronization behavior of this module.

setContext

public void setContext(Ctx m)

Specified by:

setContext in interface Module<Ctx>

notifyStateViolation

protected void notifyStateViolation(String detectingMethod,
                        String expectedStateDesc,
                        boolean throExcept)

verifyStoredState

protected void verifyStoredState(String checkingMethod,
                     boolean throExcept,
                     Module.State... allowedStates)

Ensure we are in an allowed state, will notifyStateViolation if not.

failDuringInitOrStartup

public void failDuringInitOrStartup()

Specified by:

failDuringInitOrStartup in interface Module<Ctx>

enterBasicInitModule

protected void enterBasicInitModule(boolean verifyPreInitState)

exitBasicInitModule

protected void exitBasicInitModule(boolean verifyInInitState)

enterBasicStart

protected void enterBasicStart()

exitBasicStart

protected void exitBasicStart()

enterBasicRunOnce

protected void enterBasicRunOnce()

exitBasicRunOnce

protected void exitBasicRunOnce()

enterBasicStop

protected void enterBasicStop()

exitBasicStop

protected void exitBasicStop()

enterBasicReleaseModule

protected void enterBasicReleaseModule()

exitBasicReleaseModule

protected void exitBasicReleaseModule()

getFieldSummary

public String getFieldSummary()

Overrides:

getFieldSummary in class KnownComponentImpl