Module org.refcodes.component

Package org.refcodes.component

Class LifecycleMachine

java.lang.Object

org.refcodes.component.LifecycleMachine

All Implemented Interfaces:

Destroyable, Destroyable.DestroyAutomaton, Initializable, Initializable.InitializeAutomaton, InitializedAccessor, LifecycleComponent, LifecycleComponent.LifecycleAutomaton, LifecycleStatusAccessor, Pausable, Pausable.PauseAutomaton, Resumable, Resumable.ResumeAutomaton, RunningAccessor, Startable, Startable.StartAutomaton, Stoppable, Stoppable.StopAutomaton

Direct Known Subclasses:

LifecycleMachine.ManualLifecycleMachine

public class LifecycleMachine
extends Object
implements LifecycleComponent.LifecycleAutomaton

The LifecycleMachine implements a LifecycleComponent.LifecycleAutomaton. The implementation is suffixed with "Machine" instead of "Automaton" for differentiation with any interface of similar (same) name.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	LifecycleMachine.ManualLifecycleMachine	Opens the otherwise protected LifecycleMachine.ManualLifecycleMachine.setLifecycleStatus(LifecycleStatus) to be public in order to force any lifecycle status to be set.

Nested classes/interfaces inherited from interface org.refcodes.component.Destroyable

Destroyable.DestroyAutomaton

Nested classes/interfaces inherited from interface org.refcodes.component.Initializable

Initializable.InitializeAutomaton, Initializable.InitializeBuilder<B extends Initializable.InitializeBuilder<B>>, Initializable.UncheckedInitializable

Nested classes/interfaces inherited from interface org.refcodes.component.InitializedAccessor

InitializedAccessor.InitializedMutator, InitializedAccessor.InitializedProperty

Nested classes/interfaces inherited from interface org.refcodes.component.LifecycleComponent

LifecycleComponent.LifecycleAutomaton, LifecycleComponent.UncheckedLifecycleComponent

Nested classes/interfaces inherited from interface org.refcodes.component.LifecycleStatusAccessor

LifecycleStatusAccessor.LifecycleStatusBuilder<B extends LifecycleStatusAccessor.LifecycleStatusBuilder<B>>, LifecycleStatusAccessor.LifecycleStatusMutator, LifecycleStatusAccessor.LifecycleStatusProperty

Nested classes/interfaces inherited from interface org.refcodes.component.Pausable

Pausable.PauseAutomaton, Pausable.PauseBuilder<B extends Pausable.PauseBuilder<B>>, Pausable.UncheckedPausable

Nested classes/interfaces inherited from interface org.refcodes.component.Resumable

Resumable.ResumeAutomaton, Resumable.ResumeBuilder<B extends Resumable.ResumeBuilder<B>>, Resumable.UncheckedResumable

Nested classes/interfaces inherited from interface org.refcodes.component.RunningAccessor

RunningAccessor.RunningMutator, RunningAccessor.RunningProperty

Nested classes/interfaces inherited from interface org.refcodes.component.Startable

Startable.StartAutomaton, Startable.StartBuilder<B extends Startable.StartBuilder<B>>, Startable.UncheckedStartable

Nested classes/interfaces inherited from interface org.refcodes.component.Stoppable

Stoppable.StopAutomaton, Stoppable.StopBuilder<B extends Stoppable.StopBuilder<B>>, Stoppable.UncheckedStoppable

Constructor Summary

Constructors

Constructor	Description
LifecycleMachine()	Empty constructor, such LifecycleComponent.LifecycleAutomaton cannot do much more than decline the various LifecycleStatus states for you.
LifecycleMachine(LifecycleComponent aLifecycleComponent)	This constructor uses a LifecycleStatus for wrapping it inside the LifecycleComponent.LifecycleAutomaton, making sure of obeying and guarding the correct LifecycleStatus's order of LifecycleStatus states for you.

Method Summary

Modifier and Type	Method	Description
void	destroy()	Destroys the component.
protected LifecycleComponent	getLifecycleComponent()	Provides access to the LifecycleComponent instance.
LifecycleStatus	getLifecycleStatus()	Retrieves the LifecycleStatus property from the property.
void	initialize()	Initialize the component.
boolean	isDestroyable()	Determines whether the component may get destroyed.
boolean	isDestroyed()	Determines whether the component is destroyed.
boolean	isInitalizable()	Determines whether the component may get initialized.
boolean	isInitialized()	Retrieves the is-initialized property from the initialized property.
boolean	isPausable()	Determines whether the component may get paused.
boolean	isPaused()	Determines whether the component is paused.
boolean	isResumable()	Determines whether the component may get resumed.
boolean	isRunning()	Retrieves the is-running property from the running property.
boolean	isStartable()	Determines whether the component may get started.
boolean	isStoppable()	Determines whether the component may get stopped.
boolean	isStopped()	Determines whether the component is stopped.
void	pause()	Pauses the component.
void	resume()	Resumes the component.
protected void	setLifecycleStatus(LifecycleStatus aStatus)	Provides means to set the LifecycleStatus manually.
void	start()	Starts the component.
void	stop()	Stops the component.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.refcodes.component.Initializable

initializeUnchecked

Methods inherited from interface org.refcodes.component.Pausable

pauseUnchecked

Methods inherited from interface org.refcodes.component.Resumable

resumeUnchecked

Methods inherited from interface org.refcodes.component.Startable

startUnchecked

Methods inherited from interface org.refcodes.component.Stoppable

stopUnchecked

Constructor Details

LifecycleMachine

public LifecycleMachine()

Empty constructor, such LifecycleComponent.LifecycleAutomaton cannot do much more than decline the various LifecycleStatus states for you.

LifecycleMachine

public LifecycleMachine(LifecycleComponent aLifecycleComponent)

This constructor uses a LifecycleStatus for wrapping it inside the LifecycleComponent.LifecycleAutomaton, making sure of obeying and guarding the correct LifecycleStatus's order of LifecycleStatus states for you.

Parameters:

aLifecycleComponent - The component to be guarded regarding the correct declination of the LifecycleStatus states.

Method Details

getLifecycleStatus

public LifecycleStatus getLifecycleStatus()

Retrieves the LifecycleStatus property from the property. Determines in which LifecycleStatus status a component is in.

Specified by:

getLifecycleStatus in interface LifecycleStatusAccessor

Returns:

Returns the LifecycleStatus property stored by the property.

initialize

public void initialize()
                throws InitializeException

Initialize the component.

Specified by:

initialize in interface Initializable

Throws:

InitializeException - Thrown in case initializing fails.

isInitalizable

public boolean isInitalizable()

Determines whether the component may get initialized.

Specified by:

isInitalizable in interface Initializable.InitializeAutomaton

Returns:

True if Initializable.initialize() is possible.

isInitialized

public boolean isInitialized()

Retrieves the is-initialized property from the initialized property. Determines whether the component is initialized. A component is initialized after being initialized as of Initializable.initialize() or Configurable.initialize(Object).

Specified by:

isInitialized in interface InitializedAccessor

Returns:

True in case of being initialized (returns the is-initialized property stored by the initialized property).

isStartable

public boolean isStartable()

Determines whether the component may get started.

Specified by:

isStartable in interface Startable.StartAutomaton

Returns:

True if Startable.start() is possible.

start

public void start()
           throws StartException

Starts the component.

Specified by:

start in interface Startable

Throws:

StartException - Thrown in case starting fails.

isRunning

public boolean isRunning()

Retrieves the is-running property from the running property. Determines whether the component is running. A component is running after being started or being resumed as of Startable.start() or Resumable.resume().

Specified by:

isRunning in interface RunningAccessor

Returns:

True in case of being resumed or started (returns the is-running property stored by the running property).

isPausable

public boolean isPausable()

Determines whether the component may get paused.

Specified by:

isPausable in interface Pausable.PauseAutomaton

Returns:

True if Pausable.pause() is possible.

pause

public void pause()
           throws PauseException

Pauses the component.

Specified by:

pause in interface Pausable

Throws:

PauseException - in case pausing fails.

isPaused

public boolean isPaused()

Determines whether the component is paused.

Specified by:

isPaused in interface Pausable.PauseAutomaton

Returns:

True in case of being paused, else false.

isResumable

public boolean isResumable()

Determines whether the component may get resumed.

Specified by:

isResumable in interface Resumable.ResumeAutomaton

Returns:

True if Resumable.resume() is possible.

resume

public void resume()
            throws ResumeException

Resumes the component.

Specified by:

resume in interface Resumable

Throws:

ResumeException - Thrown in case resuming fails.

isStoppable

public boolean isStoppable()

Determines whether the component may get stopped.

Specified by:

isStoppable in interface Stoppable.StopAutomaton

Returns:

True if Stoppable.stop() is possible.

stop

public void stop()
          throws StopException

Stops the component.

Specified by:

stop in interface Stoppable

Throws:

StopException - Thrown in case stopping fails.

isStopped

public boolean isStopped()

Determines whether the component is stopped.

Specified by:

isStopped in interface Stoppable.StopAutomaton

Returns:

True in case of being stopped, else false.

isDestroyable

public boolean isDestroyable()

Determines whether the component may get destroyed.

Specified by:

isDestroyable in interface Destroyable.DestroyAutomaton

Returns:

True if Destroyable.destroy() is possible.

destroy

public void destroy()

Destroys the component. External resources might stay untouched! This should always be possible and must not throw any exception. In case a Component has been destroyed, then invoking any of that Component instance's methods (except the Destroyable.destroy() method) must throw an IllegalStateException as by definition a once destroyed Component is in the state of being destroyed which is irreversible.

Specified by:

destroy in interface Destroyable

isDestroyed

public boolean isDestroyed()

Determines whether the component is destroyed. In case of being true, then invoking any of that Component instance's methods (except the Destroyable.destroy() method) must throw an IllegalStateException as by definition a once destroyed Component is in the state of being destroyed which is irreversible.

Specified by:

isDestroyed in interface Destroyable.DestroyAutomaton

Returns:

True in case of being destroyed, else false.

getLifecycleComponent

protected LifecycleComponent getLifecycleComponent()

Provides access to the LifecycleComponent instance.

Returns:

The LifecycleComponent instance being set.

setLifecycleStatus

protected void setLifecycleStatus(LifecycleStatus aStatus)

Provides means to set the LifecycleStatus manually.

Parameters:

aStatus - The LifecycleStatus to be set.