Class ObservableLifecycleStatusMachine<SRC>

java.lang.Object

org.refcodes.component.LifecycleMachine

org.refcodes.component.ext.observer.ObservableLifecycleStatusMachine<SRC>

Type Parameters:

SRC - The source of the events consumed by the LifecycleStatusObserver.

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, Observable<LifecycleStatusObserver<InitializeAccomplishedEvent<SRC>, StartAccomplishedEvent<SRC>, ResumeAccomplishedEvent<SRC>, PauseAccomplishedEvent<SRC>, StopAccomplishedEvent<SRC>, DestroyAccomplishedEvent<SRC>, EventMetaData, SRC>>

public class ObservableLifecycleStatusMachine<SRC>
extends LifecycleMachine
implements Observable<LifecycleStatusObserver<InitializeAccomplishedEvent<SRC>, StartAccomplishedEvent<SRC>, ResumeAccomplishedEvent<SRC>, PauseAccomplishedEvent<SRC>, StopAccomplishedEvent<SRC>, DestroyAccomplishedEvent<SRC>, EventMetaData, SRC>>

The ObservableLifecycleStatusMachine extends the LifecycleMachine with life-cycle ActionEvent functionality which can be vetoed, such running through several stages from getting started till being destroyed. The valid state changes are mainly as follows:

"start" - "pause" - "resume" - "stop" - "destroy"

For example:

"start" - "pause" - "resume" - "pause" - "resume" - "stop" - "start" - "pause" - "resume" - "stop" - "destroy"

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

Nested Class Summary

Nested classes/interfaces inherited from class LifecycleMachine

LifecycleMachine.ManualLifecycleMachine

Nested classes/interfaces inherited from interface Destroyable

Destroyable.DestroyAutomaton

Nested classes/interfaces inherited from interface Initializable

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

Nested classes/interfaces inherited from interface InitializedAccessor

InitializedAccessor.InitializedMutator, InitializedAccessor.InitializedProperty

Nested classes/interfaces inherited from interface LifecycleComponent

LifecycleComponent.LifecycleAutomaton, LifecycleComponent.UncheckedLifecycleComponent

Nested classes/interfaces inherited from interface LifecycleStatusAccessor

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

Nested classes/interfaces inherited from interface Pausable

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

Nested classes/interfaces inherited from interface Resumable

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

Nested classes/interfaces inherited from interface RunningAccessor

RunningAccessor.RunningMutator, RunningAccessor.RunningProperty

Nested classes/interfaces inherited from interface Startable

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

Nested classes/interfaces inherited from interface Stoppable

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

Constructor Summary

Constructors

Constructor	Description
ObservableLifecycleStatusMachine()	Instantiates a new ObservableLifecycleStatusMachine.
ObservableLifecycleStatusMachine(ExecutorService aExecutorService, ExecutionStrategy aExecutionStrategy)	Instantiates a new ObservableLifecycleStatusMachine.
ObservableLifecycleStatusMachine(LifecycleComponent aLifecycleComponent)	Instantiates the class ObservableLifecycleStatusMachine.
ObservableLifecycleStatusMachine(LifecycleComponent aLifecycleComponent, ExecutorService aExecutorService, ExecutionStrategy aExecutionStrategy)	Instantiates the class ObservableLifecycleStatusMachine.
ObservableLifecycleStatusMachine(LifecycleComponent aLifecycleComponent, EventMetaData aEventMetaData)	Instantiates the class ObservableLifecycleStatusMachine.
ObservableLifecycleStatusMachine(LifecycleComponent aLifecycleComponent, EventMetaData aEventMetaData, ExecutorService aExecutorService, ExecutionStrategy aExecutionStrategy)	Instantiates the class ObservableLifecycleStatusMachine.
ObservableLifecycleStatusMachine(LifecycleComponent aLifecycleComponent, EventMetaData aEventMetaData, SRC aSource)	Instantiates the class ObservableLifecycleStatusMachine.
ObservableLifecycleStatusMachine(LifecycleComponent aLifecycleComponent, EventMetaData aEventMetaData, SRC aSource, ExecutorService aExecutorService, ExecutionStrategy aExecutionStrategy)	Instantiates the class ObservableLifecycleStatusMachine.
ObservableLifecycleStatusMachine(LifecycleComponent aLifecycleComponent, SRC aSource)	Instantiates the class ObservableLifecycleStatusMachine.
ObservableLifecycleStatusMachine(LifecycleComponent aLifecycleComponent, SRC aSource, ExecutorService aExecutorService, ExecutionStrategy aExecutionStrategy)	Instantiates the class ObservableLifecycleStatusMachine.
ObservableLifecycleStatusMachine(EventMetaData aEventMetaData)	Instantiates a new ObservableLifecycleStatusMachine.
ObservableLifecycleStatusMachine(EventMetaData aEventMetaData, ExecutorService aExecutorService, ExecutionStrategy aExecutionStrategy)	Instantiates a new ObservableLifecycleStatusMachine.
ObservableLifecycleStatusMachine(EventMetaData aEventMetaData, SRC aSource)	Instantiates a new ObservableLifecycleStatusMachine.
ObservableLifecycleStatusMachine(EventMetaData aEventMetaData, SRC aSource, ExecutorService aExecutorService, ExecutionStrategy aExecutionStrategy)	Instantiates a new ObservableLifecycleStatusMachine.
ObservableLifecycleStatusMachine(SRC aSource)	Instantiates a new ObservableLifecycleStatusMachine.
ObservableLifecycleStatusMachine(SRC aSource, ExecutorService aExecutorService, ExecutionStrategy aExecutionStrategy)	Instantiates a new ObservableLifecycleStatusMachine.

Method Summary

Modifier and Type	Method	Description
void	destroy()
boolean	hasObserver(LifecycleStatusObserver<InitializeAccomplishedEvent<SRC>, StartAccomplishedEvent<SRC>, ResumeAccomplishedEvent<SRC>, PauseAccomplishedEvent<SRC>, StopAccomplishedEvent<SRC>, DestroyAccomplishedEvent<SRC>, EventMetaData, SRC> aObserver)
void	initialize()
void	pause()
void	resume()
void	start()
void	stop()
boolean	subscribeObserver(LifecycleStatusObserver<InitializeAccomplishedEvent<SRC>, StartAccomplishedEvent<SRC>, ResumeAccomplishedEvent<SRC>, PauseAccomplishedEvent<SRC>, StopAccomplishedEvent<SRC>, DestroyAccomplishedEvent<SRC>, EventMetaData, SRC> aObserver)
boolean	unsubscribeObserver(LifecycleStatusObserver<InitializeAccomplishedEvent<SRC>, StartAccomplishedEvent<SRC>, ResumeAccomplishedEvent<SRC>, PauseAccomplishedEvent<SRC>, StopAccomplishedEvent<SRC>, DestroyAccomplishedEvent<SRC>, EventMetaData, SRC> aObserver)

Methods inherited from class LifecycleMachine

getLifecycleComponent, getLifecycleStatus, isDestroyable, isDestroyed, isInitalizable, isInitialized, isPausable, isPaused, isResumable, isRunning, isStartable, isStoppable, isStopped, setLifecycleStatus

Methods inherited from class Object

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

Constructor Details

ObservableLifecycleStatusMachine

public ObservableLifecycleStatusMachine()

Instantiates a new ObservableLifecycleStatusMachine.

ObservableLifecycleStatusMachine

public ObservableLifecycleStatusMachine(SRC aSource)

Instantiates a new ObservableLifecycleStatusMachine.

Parameters:

aSource - The source instance to be used when firing events in case the source is to be different from this class' instance.

ObservableLifecycleStatusMachine

public ObservableLifecycleStatusMachine(EventMetaData aEventMetaData)

Instantiates a new ObservableLifecycleStatusMachine.

Parameters:

aEventMetaData - The EventMetaData to be used when firing events in case the EventMetaData is to be different from the auto-generated EventMetaData.

ObservableLifecycleStatusMachine

public ObservableLifecycleStatusMachine(EventMetaData aEventMetaData,
 SRC aSource)

Instantiates a new ObservableLifecycleStatusMachine.

Parameters:

aEventMetaData - The EventMetaData to be used when firing events in case the EventMetaData is to be different from the auto-generated EventMetaData.

aSource - The source instance to be used when firing events in case the source is to be different from this class' instance.

ObservableLifecycleStatusMachine

public ObservableLifecycleStatusMachine(LifecycleComponent aLifecycleComponent)

Instantiates the class ObservableLifecycleStatusMachine.

See Also:

• LifecycleMachine(LifecycleComponent)

ObservableLifecycleStatusMachine

public ObservableLifecycleStatusMachine(LifecycleComponent aLifecycleComponent,
 SRC aSource)

Instantiates the class ObservableLifecycleStatusMachine.

Parameters:

aSource - The source instance to be used when firing events in case the source is to be different from this class' instance.

See Also:

• LifecycleMachine(LifecycleComponent)

ObservableLifecycleStatusMachine

public ObservableLifecycleStatusMachine(LifecycleComponent aLifecycleComponent,
 EventMetaData aEventMetaData)

Instantiates the class ObservableLifecycleStatusMachine.

Parameters:

aEventMetaData - The EventMetaData to be used when firing events in case the EventMetaData is to be different from the auto-generated EventMetaData.

See Also:

• LifecycleMachine(LifecycleComponent)

ObservableLifecycleStatusMachine

public ObservableLifecycleStatusMachine(LifecycleComponent aLifecycleComponent,
 EventMetaData aEventMetaData,
 SRC aSource)

Instantiates the class ObservableLifecycleStatusMachine.

Parameters:

aEventMetaData - The EventMetaData to be used when firing events in case the EventMetaData is to be different from the auto-generated EventMetaData. *

aSource - The source instance to be used when firing events in case the source is to be different from this class' instance.

See Also:

• LifecycleMachine(LifecycleComponent)

ObservableLifecycleStatusMachine

public ObservableLifecycleStatusMachine(ExecutorService aExecutorService,
 ExecutionStrategy aExecutionStrategy)

Instantiates a new ObservableLifecycleStatusMachine.

Parameters:

aExecutorService - The executor service to be used when firing ActionEvent instances in multiple threads (if null then a default one is used).

aExecutionStrategy - The ExecutionStrategy to be used when firing ActionEvent instance (if null then the default ExecutionStrategy.SEQUENTIAL is used).

ObservableLifecycleStatusMachine

public ObservableLifecycleStatusMachine(SRC aSource,
 ExecutorService aExecutorService,
 ExecutionStrategy aExecutionStrategy)

Instantiates a new ObservableLifecycleStatusMachine.

Parameters:

aSource - The source instance to be used when firing events in case the source is to be different from this class' instance.

aExecutorService - The executor service to be used when firing ActionEvent instances in multiple threads (if null then a default one is used).

aExecutionStrategy - The ExecutionStrategy to be used when firing ActionEvent instance (if null then the default ExecutionStrategy.SEQUENTIAL is used).

ObservableLifecycleStatusMachine

public ObservableLifecycleStatusMachine(EventMetaData aEventMetaData,
 ExecutorService aExecutorService,
 ExecutionStrategy aExecutionStrategy)

Instantiates a new ObservableLifecycleStatusMachine.

Parameters:

aEventMetaData - The EventMetaData to be used when firing events in case the EventMetaData is to be different from the auto-generated EventMetaData.

aExecutorService - The executor service to be used when firing ActionEvent instances in multiple threads (if null then a default one is used).

aExecutionStrategy - The ExecutionStrategy to be used when firing ActionEvent instance (if null then the default ExecutionStrategy.SEQUENTIAL is used).

ObservableLifecycleStatusMachine

public ObservableLifecycleStatusMachine(EventMetaData aEventMetaData,
 SRC aSource,
 ExecutorService aExecutorService,
 ExecutionStrategy aExecutionStrategy)

Instantiates a new ObservableLifecycleStatusMachine.

Parameters:

aEventMetaData - The EventMetaData to be used when firing events in case the EventMetaData is to be different from the auto-generated EventMetaData.

aSource - The source instance to be used when firing events in case the source is to be different from this class' instance.

aExecutorService - The executor service to be used when firing ActionEvent instances in multiple threads (if null then a default one is used).

aExecutionStrategy - The ExecutionStrategy to be used when firing ActionEvent instance (if null then the default ExecutionStrategy.SEQUENTIAL is used).

ObservableLifecycleStatusMachine

public ObservableLifecycleStatusMachine(LifecycleComponent aLifecycleComponent,
 ExecutorService aExecutorService,
 ExecutionStrategy aExecutionStrategy)

Instantiates the class ObservableLifecycleStatusMachine.

Parameters:

aExecutorService - The executor service to be used when firing ActionEvent instances in multiple threads (if null then a default one is used). *

aExecutionStrategy - The ExecutionStrategy to be used when firing ActionEvent instance (if null then the default ExecutionStrategy.SEQUENTIAL is used).

See Also:

• LifecycleMachine(LifecycleComponent)

ObservableLifecycleStatusMachine

public ObservableLifecycleStatusMachine(LifecycleComponent aLifecycleComponent,
 SRC aSource,
 ExecutorService aExecutorService,
 ExecutionStrategy aExecutionStrategy)

Instantiates the class ObservableLifecycleStatusMachine.

Parameters:

aSource - The source instance to be used when firing events in case the source is to be different from this class' instance. *

aExecutorService - The executor service to be used when firing ActionEvent instances in multiple threads (if null then a default one is used). *

aExecutionStrategy - The ExecutionStrategy to be used when firing ActionEvent instance (if null then the default ExecutionStrategy.SEQUENTIAL is used).

See Also:

• LifecycleMachine(LifecycleComponent)

ObservableLifecycleStatusMachine

public ObservableLifecycleStatusMachine(LifecycleComponent aLifecycleComponent,
 EventMetaData aEventMetaData,
 ExecutorService aExecutorService,
 ExecutionStrategy aExecutionStrategy)

Instantiates the class ObservableLifecycleStatusMachine.

Parameters:

aEventMetaData - The EventMetaData to be used when firing events in case the EventMetaData is to be different from the auto-generated EventMetaData. *

aExecutorService - The executor service to be used when firing ActionEvent instances in multiple threads (if null then a default one is used). *

aExecutionStrategy - The ExecutionStrategy to be used when firing ActionEvent instance (if null then the default ExecutionStrategy.SEQUENTIAL is used).

See Also:

• LifecycleMachine(LifecycleComponent)

ObservableLifecycleStatusMachine

public ObservableLifecycleStatusMachine(LifecycleComponent aLifecycleComponent,
 EventMetaData aEventMetaData,
 SRC aSource,
 ExecutorService aExecutorService,
 ExecutionStrategy aExecutionStrategy)

Instantiates the class ObservableLifecycleStatusMachine.

Parameters:

aEventMetaData - The EventMetaData to be used when firing events in case the EventMetaData is to be different from the auto-generated EventMetaData. *

aSource - The source instance to be used when firing events in case the source is to be different from this class' instance. *

aExecutorService - The executor service to be used when firing ActionEvent instances in multiple threads (if null then a default one is used). *

aExecutionStrategy - The ExecutionStrategy to be used when firing ActionEvent instance (if null then the default ExecutionStrategy.SEQUENTIAL is used).

See Also:

• LifecycleMachine(LifecycleComponent)

Method Details

hasObserver

public boolean hasObserver(LifecycleStatusObserver<InitializeAccomplishedEvent<SRC>, StartAccomplishedEvent<SRC>, ResumeAccomplishedEvent<SRC>, PauseAccomplishedEvent<SRC>, StopAccomplishedEvent<SRC>, DestroyAccomplishedEvent<SRC>, EventMetaData, SRC> aObserver)

Specified by:

hasObserver in interface Observable<SRC>

subscribeObserver

public boolean subscribeObserver(LifecycleStatusObserver<InitializeAccomplishedEvent<SRC>, StartAccomplishedEvent<SRC>, ResumeAccomplishedEvent<SRC>, PauseAccomplishedEvent<SRC>, StopAccomplishedEvent<SRC>, DestroyAccomplishedEvent<SRC>, EventMetaData, SRC> aObserver)

Specified by:

subscribeObserver in interface Observable<SRC>

unsubscribeObserver

public boolean unsubscribeObserver(LifecycleStatusObserver<InitializeAccomplishedEvent<SRC>, StartAccomplishedEvent<SRC>, ResumeAccomplishedEvent<SRC>, PauseAccomplishedEvent<SRC>, StopAccomplishedEvent<SRC>, DestroyAccomplishedEvent<SRC>, EventMetaData, SRC> aObserver)

Specified by:

unsubscribeObserver in interface Observable<SRC>

initialize

public void initialize()
                throws InitializeException

Specified by:

initialize in interface Initializable

Overrides:

initialize in class LifecycleMachine

Throws:

InitializeException

start

public void start()
           throws StartException

Specified by:

start in interface Startable

Overrides:

start in class LifecycleMachine

Throws:

StartException

pause

public void pause()
           throws PauseException

Specified by:

pause in interface Pausable

Overrides:

pause in class LifecycleMachine

Throws:

PauseException

resume

public void resume()
            throws ResumeException

Specified by:

resume in interface Resumable

Overrides:

resume in class LifecycleMachine

Throws:

ResumeException

stop

public void stop()
          throws StopException

Specified by:

stop in interface Stoppable

Overrides:

stop in class LifecycleMachine

Throws:

StopException

destroy

public void destroy()

Specified by:

destroy in interface Destroyable

Overrides:

destroy in class LifecycleMachine