|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object cz.cuni.amis.pogamut.base.component.controller.ComponentControlHelper
public class ComponentControlHelper
Provides empty implementations of life-cycle methods defined by IComponentControlHelper
- override only these that you need.
Constructor Summary | |
---|---|
ComponentControlHelper()
|
Method Summary | |
---|---|
void |
kill()
Kills the component in ruthless way. |
void |
pause()
Pauses the component. |
void |
prePause()
Called before the IPausingEvent of the component is broadcast. |
void |
preResume()
Called before the IResumingEvent of the component is broadcast. |
void |
preStart()
Called before the IStartingEvent of the component is broadcast. |
void |
preStartPaused()
Called before IStartingPausedEvent of the component is broadcast. |
void |
preStop()
Called before the IStoppingEvent of the component is broadcast. |
void |
reset()
Called whenever IResetEvent is caught. |
void |
resume()
Resumes the component. |
void |
start()
Starts the component. |
void |
startPaused()
Starts the component but it assumes that the component just prepares whatever data structures it needs / make connections / handshake whatever it needs with the environment / etc. |
void |
stop()
Stops the component. |
java.lang.String |
toString()
|
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public ComponentControlHelper()
Method Detail |
---|
public void kill()
IComponentControlHelper
Called whenever IFatalErrorEvent
is caught.
Must not throw any exception whatsoever.
kill
in interface IComponentControlHelper
public void prePause() throws PogamutException
IComponentControlHelper
IPausingEvent
of the component is broadcast.
You may need to pre-clean some stuff.
prePause
in interface IComponentControlHelper
PogamutException
public void pause() throws PogamutException
IComponentControlHelper
Called whenever IPausingEvent
is caught from one of the dependencies.
pause
in interface IComponentControlHelper
PogamutException
public void reset()
IComponentControlHelper
IResetEvent
is caught. It should reinitialize data structures of the
component so it can be started again.
Should throw an exception in case that the component can't be reseted.
reset
in interface IComponentControlHelper
public void preResume() throws PogamutException
IComponentControlHelper
IResumingEvent
of the component is broadcast.
You may need to pre-clean some stuff.
preResume
in interface IComponentControlHelper
PogamutException
public void resume() throws PogamutException
IComponentControlHelper
Called whenever IResumingEvent
is caught from one of the dependencies.
resume
in interface IComponentControlHelper
PogamutException
public void preStart() throws PogamutException
IComponentControlHelper
IStartingEvent
of the component is broadcast.
You may need to prepare some stuff before starting event is generated
preStart
in interface IComponentControlHelper
PogamutException
public void start() throws PogamutException
IComponentControlHelper
start
in interface IComponentControlHelper
PogamutException
public void preStartPaused() throws PogamutException
IComponentControlHelper
IStartingPausedEvent
of the component is broadcast.
You may need to prepare some stuff before starting event is generated.
preStartPaused
in interface IComponentControlHelper
PogamutException
public void startPaused() throws PogamutException
IComponentControlHelper
It should not let the agent to perform designers work (i.e., UT2004 bots should not start playing in the game).
After this call, the component should behave as it would have been paused with IComponentControlHelper.pause()
.
startPaused
in interface IComponentControlHelper
PogamutException
public void preStop() throws PogamutException
IComponentControlHelper
IStoppingEvent
of the component is broadcast.
You may need to pre-clean some stuff.
preStop
in interface IComponentControlHelper
PogamutException
public void stop() throws PogamutException
IComponentControlHelper
It should throw an exception if the component can't be stopped.
stop
in interface IComponentControlHelper
PogamutException
public java.lang.String toString()
toString
in class java.lang.Object
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |