Module org.refcodes.component

Package org.refcodes.component

Interface Pausable

All Known Subinterfaces:

ComponentComposite, ComponentComposite.ExtendedComponentComposite<CTX,CON>, ConfigurableLifecycleComponent<CTX>, ConfigurableLifecycleComponent.ConfigurableLifecycleAutomaton<CTX>, LifecycleComponent, LifecycleComponent.LifecycleAutomaton, LifecycleComponent.UncheckedLifecycleComponent, Pausable.PauseAutomaton, Pausable.UncheckedPausable

All Known Implementing Classes:

AbstractComponentComposite, AbstractComponentComposite.ExtendedCompositeComponentImpl, ConfigurableLifecycleAutomatonImpl, LifecycleMachine, LifecycleMachine.ManualLifecycleMachine

public interface Pausable

This mixin might be implemented by a component in order to provide pause facilities.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	Pausable.PauseAutomaton	The Pausable.PauseAutomaton interface defines those methods related to the pause life-cycle.
static interface	Pausable.PauseBuilder<B extends Pausable.PauseBuilder<B>>	To enable the Pausable functionality to be invoked in a builder chain.
static interface	Pausable.UncheckedPausable	See Pausable without any checked exception being declared.

Method Summary

Modifier and Type	Method	Description
void	pause()	Pauses the component.
default void	pauseUnchecked()	Pauses the component by calling pause() without you to require catching an PauseException.

Method Details

pause

void pause()
    throws PauseException

Pauses the component.

Throws:

PauseException - in case pausing fails.

pauseUnchecked

default void pauseUnchecked()

Pauses the component by calling pause() without you to require catching an PauseException.

Throws:

PauseException.PauseRuntimeException - encapsulates the aCause and is thrown upon encountering a PauseException exception