Module org.refcodes.component

Package org.refcodes.component

Interface Pausable.PauseBuilder<B extends Pausable.PauseBuilder<B>>

Type Parameters:

B - The instance to be returned on which to apply succeeding builder operations.

Enclosing interface:

Pausable

public static interface Pausable.PauseBuilder<B extends Pausable.PauseBuilder<B>>

To enable the Pausable functionality to be invoked in a builder chain.

Method Summary

Modifier and Type	Method	Description
default B	pauseUnchecked()	Pauses the component by calling withPause() without you to require catching an PauseException.
B	withPause()	Builder method for the Pausable.pause() method.

Method Detail

withPause

B withPause()
     throws PauseException

Builder method for the Pausable.pause() method.

Returns:

The instance to be returned on which to apply succeeding builder operations.

Throws:

PauseException - Thrown in case pausing fails.

pauseUnchecked

default B pauseUnchecked()

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

Returns:

The instance to be returned on which to apply succeeding builder operations.

Throws:

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