Module org.refcodes.component

Package org.refcodes.component

Interface Ceasable.CeaseBuilder<B extends Ceasable.CeaseBuilder<B>>

Type Parameters:

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

Enclosing interface:

Ceasable

public static interface Ceasable.CeaseBuilder<B extends Ceasable.CeaseBuilder<B>>

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

Method Summary

Modifier and Type	Method	Description
B	withCease()	Builder method for the Ceasable.cease() method.
default B	withCeaseUnchecked()	Ceases the component by calling withCease() without you to require catching an CeaseException.

Method Details

withCease

B withCease()
     throws CeaseException

Builder method for the Ceasable.cease() method.

Returns:

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

Throws:

CeaseException - Thrown in case ceasing fails.

withCeaseUnchecked

default B withCeaseUnchecked()

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

Returns:

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

Throws:

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