io.helixservice.core.component

Interface Component

public interface Component

Helix Component Interface

Field Summary

Fields

Modifier and Type	Field and Description
static Component[]	EMPTY

Method Summary

Modifier and Type	Method and Description
String	getComponentDescription() Return a human readable short description of this component.
String	getComponentType() Each component must define it's type name.
default Component[]	getContainedComponents() Return list of components contained within this component.

Field Detail

EMPTY

static final Component[] EMPTY

Method Detail

getComponentType

String getComponentType()

Each component must define it's type name. The type is used for lookup in the component registry.

Example component types include "Controller", "ErrorHandler"

Returns:

The type of component

getComponentDescription

String getComponentDescription()

Return a human readable short description of this component. This will be used to log or describe each registered component.

Returns:

The component description; may be null

getContainedComponents

default Component[] getContainedComponents()

Return list of components contained within this component.

This is most useful if the component is a Builder or Factory which produces additional components that need to be registered with ComponentRegistry.

This method must the same array of components each time; Do not re-construct the contained components on each call.

This method will be automatically called by the ComponentRegistry to register all of its contained components.

Returns:

An array of contained components. Default is an empty array.