Module org.refcodes.component

Package org.refcodes.component

Interface Ceasable

All Known Subinterfaces:

Ceasable.CeaseAutomaton, Ceasable.UncheckedCeasable

public interface Ceasable

This mixin might be implemented by a component in order to provide cease facilities. Cease is the zombie between stop and destroy. A processed sequence may be ceased instead of being stopped. Taken an animation; an animation sequence is stopped so it stands still ("freezes") to be resumed again (e.g. via a "start()" method). It may also get ceased instead of being stopped, in that case it may get faded out or (if it is a sprite) it may explode - so to gracefully finish off that animation sequence.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	Ceasable.CeaseAutomaton	The Ceasable.CeaseAutomaton interface defines those methods related to the cease life-cycle.
static interface	Ceasable.CeaseBuilder<B extends Ceasable.CeaseBuilder<B>>	To enable the Ceasable functionality to be invoked in a builder chain.
static interface	Ceasable.UncheckedCeasable	See Ceasable without any checked exception being declared.

Method Summary

Modifier and Type	Method	Description
void	cease()	Ceases the component.
default void	ceaseUnchecked()	Ceases the component by calling cease() without you to require catching an CeaseException.

Method Details

cease

void cease()
    throws CeaseException

Ceases the component.

Throws:

CeaseException - in case ceasing fails.

ceaseUnchecked

default void ceaseUnchecked()

Ceases the component by calling cease() without you to require catching an CeaseException.

Throws:

CeaseException.CeaseRuntimeException - encapsulates the aCause and is thrown upon encountering a CeaseException exception