Class ObservableLifecycleRequestMachine<SRC>

java.lang.Object

org.refcodes.component.LifecycleMachine

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

Type Parameters:

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

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<LifecycleRequestObserver<InitializeRequestedEvent<SRC>, StartRequestedEvent<SRC>, ResumeRequestedEvent<SRC>, PauseRequestedEvent<SRC>, StopRequestedEvent<SRC>, DestroyRequestedEvent<SRC>, EventMetaData, SRC>>

public class ObservableLifecycleRequestMachine<SRC>
extends LifecycleMachine
implements Observable<LifecycleRequestObserver<InitializeRequestedEvent<SRC>, StartRequestedEvent<SRC>, ResumeRequestedEvent<SRC>, PauseRequestedEvent<SRC>, StopRequestedEvent<SRC>, DestroyRequestedEvent<SRC>, EventMetaData, SRC>>

The ObservableLifecycleRequestMachine extends the LifecycleMachine with request ActionEvent functionality which can be vetoed. 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
ObservableLifecycleRequestMachine()	Instantiates a new ObservableLifecycleRequestMachine.
ObservableLifecycleRequestMachine(ExecutorService aExecutorService, ExecutionStrategy aExecutionStrategy)	Instantiates the class ObservableLifecycleRequestMachine.
ObservableLifecycleRequestMachine(LifecycleComponent aLifecycleComponent)	Instantiates the class ObservableLifecycleRequestMachine.
ObservableLifecycleRequestMachine(LifecycleComponent aLifecycleComponent, ExecutorService aExecutorService, ExecutionStrategy aExecutionStrategy)	Instantiates the class ObservableLifecycleRequestMachine.
ObservableLifecycleRequestMachine(LifecycleComponent aLifecycleComponent, EventMetaData aEventMetaData)	Instantiates the class ObservableLifecycleRequestMachine.
ObservableLifecycleRequestMachine(LifecycleComponent aLifecycleComponent, EventMetaData aEventMetaData, ExecutorService aExecutorService, ExecutionStrategy aExecutionStrategy)	Instantiates the class ObservableLifecycleRequestMachine.
ObservableLifecycleRequestMachine(LifecycleComponent aLifecycleComponent, EventMetaData aEventMetaData, SRC aSource)	Instantiates the class ObservableLifecycleRequestMachine.
ObservableLifecycleRequestMachine(LifecycleComponent aLifecycleComponent, EventMetaData aEventMetaData, SRC aSource, ExecutorService aExecutorService, ExecutionStrategy aExecutionStrategy)	Instantiates the class ObservableLifecycleRequestMachine.
ObservableLifecycleRequestMachine(LifecycleComponent aLifecycleComponent, SRC aSource)	Instantiates the class ObservableLifecycleRequestMachine.
ObservableLifecycleRequestMachine(LifecycleComponent aLifecycleComponent, SRC aSource, ExecutorService aExecutorService, ExecutionStrategy aExecutionStrategy)	Instantiates the class ObservableLifecycleRequestMachine.
ObservableLifecycleRequestMachine(EventMetaData aEventMetaData)	Instantiates a new ObservableLifecycleRequestMachine.
ObservableLifecycleRequestMachine(EventMetaData aEventMetaData, ExecutorService aExecutorService, ExecutionStrategy aExecutionStrategy)	Instantiates the class ObservableLifecycleRequestMachine.
ObservableLifecycleRequestMachine(EventMetaData aEventMetaData, SRC aSource)	Instantiates a new ObservableLifecycleRequestMachine.
ObservableLifecycleRequestMachine(EventMetaData aEventMetaData, SRC aSource, ExecutorService aExecutorService, ExecutionStrategy aExecutionStrategy)	Instantiates the class ObservableLifecycleRequestMachine.
ObservableLifecycleRequestMachine(SRC aSource)	Instantiates a new ObservableLifecycleRequestMachine.
ObservableLifecycleRequestMachine(SRC aSource, ExecutorService aExecutorService, ExecutionStrategy aExecutionStrategy)	Instantiates the class ObservableLifecycleRequestMachine.

Method Summary

Modifier and Type	Method	Description
void	destroy()
boolean	hasObserver(LifecycleRequestObserver<InitializeRequestedEvent<SRC>, StartRequestedEvent<SRC>, ResumeRequestedEvent<SRC>, PauseRequestedEvent<SRC>, StopRequestedEvent<SRC>, DestroyRequestedEvent<SRC>, EventMetaData, SRC> aObserver)
void	initialize()
void	pause()
void	resume()
void	start()
void	stop()
boolean	subscribeObserver(LifecycleRequestObserver<InitializeRequestedEvent<SRC>, StartRequestedEvent<SRC>, ResumeRequestedEvent<SRC>, PauseRequestedEvent<SRC>, StopRequestedEvent<SRC>, DestroyRequestedEvent<SRC>, EventMetaData, SRC> aObserver)
boolean	unsubscribeObserver(LifecycleRequestObserver<InitializeRequestedEvent<SRC>, StartRequestedEvent<SRC>, ResumeRequestedEvent<SRC>, PauseRequestedEvent<SRC>, StopRequestedEvent<SRC>, DestroyRequestedEvent<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

Methods inherited from interface Initializable

initializeUnchecked

Methods inherited from interface Pausable

pauseUnchecked

Methods inherited from interface Resumable

resumeUnchecked

Methods inherited from interface Startable

startUnchecked

Methods inherited from interface Stoppable

stopUnchecked

Constructor Details

ObservableLifecycleRequestMachine

public ObservableLifecycleRequestMachine()

Instantiates a new ObservableLifecycleRequestMachine.

ObservableLifecycleRequestMachine

public ObservableLifecycleRequestMachine(SRC aSource)

Instantiates a new ObservableLifecycleRequestMachine.

Parameters:

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

ObservableLifecycleRequestMachine

public ObservableLifecycleRequestMachine(EventMetaData aEventMetaData)

Instantiates a new ObservableLifecycleRequestMachine.

Parameters:

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

ObservableLifecycleRequestMachine

public ObservableLifecycleRequestMachine(EventMetaData aEventMetaData,
 SRC aSource)

Instantiates a new ObservableLifecycleRequestMachine.

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.

ObservableLifecycleRequestMachine

public ObservableLifecycleRequestMachine(LifecycleComponent aLifecycleComponent)

Instantiates the class ObservableLifecycleRequestMachine.

See Also:

• LifecycleMachine(LifecycleComponent)

ObservableLifecycleRequestMachine

public ObservableLifecycleRequestMachine(LifecycleComponent aLifecycleComponent,
 SRC aSource)

Instantiates the class ObservableLifecycleRequestMachine.

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)

ObservableLifecycleRequestMachine

public ObservableLifecycleRequestMachine(LifecycleComponent aLifecycleComponent,
 EventMetaData aEventMetaData)

Instantiates the class ObservableLifecycleRequestMachine.

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)

ObservableLifecycleRequestMachine

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

Instantiates the class ObservableLifecycleRequestMachine.

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)

ObservableLifecycleRequestMachine

public ObservableLifecycleRequestMachine(ExecutorService aExecutorService,
 ExecutionStrategy aExecutionStrategy)

Instantiates the class ObservableLifecycleRequestMachine.

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).

ObservableLifecycleRequestMachine

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

Instantiates the class ObservableLifecycleRequestMachine.

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).

ObservableLifecycleRequestMachine

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

Instantiates the class ObservableLifecycleRequestMachine.

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).

ObservableLifecycleRequestMachine

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

Instantiates the class ObservableLifecycleRequestMachine.

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).

ObservableLifecycleRequestMachine

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

Instantiates the class ObservableLifecycleRequestMachine.

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)

ObservableLifecycleRequestMachine

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

Instantiates the class ObservableLifecycleRequestMachine.

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)

ObservableLifecycleRequestMachine

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

Instantiates the class ObservableLifecycleRequestMachine.

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)

ObservableLifecycleRequestMachine

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

Instantiates the class ObservableLifecycleRequestMachine.

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(LifecycleRequestObserver<InitializeRequestedEvent<SRC>, StartRequestedEvent<SRC>, ResumeRequestedEvent<SRC>, PauseRequestedEvent<SRC>, StopRequestedEvent<SRC>, DestroyRequestedEvent<SRC>, EventMetaData, SRC> aObserver)

Specified by:

hasObserver in interface Observable<SRC>

subscribeObserver

public boolean subscribeObserver(LifecycleRequestObserver<InitializeRequestedEvent<SRC>, StartRequestedEvent<SRC>, ResumeRequestedEvent<SRC>, PauseRequestedEvent<SRC>, StopRequestedEvent<SRC>, DestroyRequestedEvent<SRC>, EventMetaData, SRC> aObserver)

Specified by:

subscribeObserver in interface Observable<SRC>

unsubscribeObserver

public boolean unsubscribeObserver(LifecycleRequestObserver<InitializeRequestedEvent<SRC>, StartRequestedEvent<SRC>, ResumeRequestedEvent<SRC>, PauseRequestedEvent<SRC>, StopRequestedEvent<SRC>, DestroyRequestedEvent<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