Module org.refcodes.component

Package org.refcodes.component

Interface Initializable

All Known Subinterfaces:

ComponentComposite, ComponentComposite.ExtendedComponentComposite<CTX,CON>, Initializable.InitializeAutomaton, Initializable.UncheckedInitializable, InitializableComponent, LifecycleComponent, LifecycleComponent.LifecycleAutomaton, LifecycleComponent.UncheckedLifecycleComponent

All Known Implementing Classes:

AbstractComponentComposite, AbstractComponentComposite.ExtendedCompositeComponentImpl, LifecycleAutomatonImpl, LifecycleAutomatonImpl.ManualLifecycleAutomatonImpl

public interface Initializable

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

In case a context is to be provided to the initialize() method, you may use the Configurable interface with its Configurable.initialize(Object) method, which provides an argument specifying the context to be passed to the Component.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	Initializable.InitializeAutomaton	The Initializable.InitializeAutomaton interface defines those methods related to the initialize life-cycle.
static interface	Initializable.InitializeBuilder<B extends Initializable.InitializeBuilder<B>>	To enable the Initializable functionality to be invoked in a builder chain.
static interface	Initializable.UncheckedInitializable	See Initializable without any checked exception being declared.

Method Summary

Modifier and Type	Method	Description
void	initialize()	Initialize the component.
default void	initializeUnchecked()	Initialize the component by calling initialize() without you to require catching an InitializeException.

Method Details

initialize

void initialize()
         throws InitializeException

Initialize the component.

Throws:

InitializeException - Thrown in case initializing fails.

initializeUnchecked

default void initializeUnchecked()

Initialize the component by calling initialize() without you to require catching an InitializeException.

Throws:

InitializeException.InitializeRuntimeException - encapsulates the cause and is thrown upon encountering a InitializeException exception