Module org.refcodes.component

Package org.refcodes.component

Interface Stoppable

All Known Subinterfaces:

CompositeComponent, CompositeComponent.ExtendedCompositeComponent<CTX,CON>, ConfigurableLifecycleComponent<CTX>, ConfigurableLifecycleComponent.ConfigurableLifecycleAutomaton<CTX>, LifecycleComponent, LifecycleComponent.LifecycleAutomaton, LifecycleComponent.UncheckedLifecycleComponent, Stoppable.StopAutomaton, Stoppable.UncheckedStoppable

All Known Implementing Classes:

CompositeComponentImpl, CompositeComponentImpl.ExtendedCompositeComponentImpl, ConfigurableLifecycleAutomatonImpl, LifecycleAutomatonImpl, LifecycleAutomatonImpl.ManualLifecycleAutomatonImpl

public interface Stoppable

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	Stoppable.StopAutomaton	The Stoppable.StopAutomaton interface defines those methods related to the stop life-cycle.
static interface	Stoppable.StopBuilder<B extends Stoppable.StopBuilder<B>>	To enable the Stoppable functionality to be invoked in a builder chain.
static interface	Stoppable.UncheckedStoppable	See Stoppable without any checked exception being declared.

Method Summary

Modifier and Type	Method	Description
void	stop()	Stops the component.
default void	stopUnchecked()	Stops the component by calling stop() without you to require catching an StopException.

Method Details

stop

void stop()
   throws StopException

Stops the component.

Throws:

StopException - Thrown in case stopping fails.

stopUnchecked

default void stopUnchecked()

Stops the component by calling stop() without you to require catching an StopException.

Throws:

StopException.StopRuntimeException - encapsulates the cause and is thrown upon encountering a StopException exception