Top Description Methods
org.apache.avalon.framework.component

public Interface Composable

Known Direct Subinterfaces
org.apache.avalon.framework.component.Recomposable

A Composable class is one that needs to connect to software components using a "role" abstraction, thus not depending on particular implementations but on behavioral interfaces.

The contract surrounding a Composable is that it is a user. The Composable is able to use Components managed by the ComponentManager it was initialized with. As part of the contract with the system, the instantiating entity must call the compose method before the Composable can be considered valid.

Deprecated: Use org.apache.avalon.framework.service.Serviceable instead.

Author
Avalon Development Team
Version
$Id: Composable.java 506231 2007-02-12 02:36:54Z crossley $

Method Summary

Modifier and TypeMethod and Description
public void
compose(ComponentManager
The ComponentManager which this Composable uses. Must not be null.
componentManager
)

Pass the ComponentManager to the composer.

Method Detail

composeback to summary
public void compose(ComponentManager componentManager) throws ComponentException

Pass the ComponentManager to the composer. The Composable implementation should use the specified ComponentManager to acquire the components it needs for execution.

Parameters
componentManager:ComponentManager

The ComponentManager which this Composable uses. Must not be null.

Exceptions
ComponentException:
if an error occurs