Module org.refcodes.component

Package org.refcodes.component

Interface Resumable

All Known Subinterfaces:

ComponentComposite, ComponentComposite.ExtendedComponentComposite<CTX,CON>, ConfigurableLifecycleComponent<CTX>, ConfigurableLifecycleComponent.ConfigurableLifecycleAutomaton<CTX>, LifecycleComponent, LifecycleComponent.LifecycleAutomaton, LifecycleComponent.UncheckedLifecycleComponent, Resumable.ResumeAutomaton, Resumable.UncheckedResumable

All Known Implementing Classes:

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

public interface Resumable

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	Resumable.ResumeAutomaton	The Resumable.ResumeAutomaton interface defines those methods related to the resume life-cycle.
static interface	Resumable.ResumeBuilder<B extends Resumable.ResumeBuilder<B>>	To enable the Resumable functionality to be invoked in a builder chain.
static interface	Resumable.UncheckedResumable	See Resumable without any checked exception being declared.

Method Summary

Modifier and Type	Method	Description
void	resume()	Resumes the component.
default void	resumeUnchecked()	Resumes the component by calling resume() without you to require catching an ResumeException.

Method Details

resume

void resume()
     throws ResumeException

Resumes the component.

Throws:

ResumeException - Thrown in case resuming fails.

resumeUnchecked

default void resumeUnchecked()

Resumes the component by calling resume() without you to require catching an ResumeException.

Throws:

ResumeException.ResumeRuntimeException - encapsulates the aCause and is thrown upon encountering a ResumeException exception