net.sf.mmm.util.component.api

Interface ComponentContainer

All Known Subinterfaces:

IocContainer

All Known Implementing Classes:

AbstractSpringContainer, ComponentContainerContextFallback, SpringContainer, SpringContainerBean

public interface ComponentContainer

This is the interface for a Ioc/context and dependency injection (CDI) container. It is just use as abstraction layer for frameworks like spring, guice or seam - you will not find a native implementation within this project.

Since:

3.1.0

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

Method Summary

Modifier and Type	Method and Description
<COMPONENT_API> COMPONENT_API	get(Class<COMPONENT_API> apiClass) This method gets the component that realizes the given apiClass.
<COMPONENT_API> COMPONENT_API	get(Class<COMPONENT_API> apiClass, String componentId) This method gets the component that realizes the given apiClass and is registered under the given componentId.

Method Detail

get

<COMPONENT_API> COMPONENT_API get(Class<COMPONENT_API> apiClass)
                           throws ResourceAmbiguousException,
                                  ResourceMissingException

This method gets the component that realizes the given apiClass.

Type Parameters:

COMPONENT_API - is the generic type of the apiClass.

Parameters:

apiClass - is the class reflecting the API of the requested component. This should be an interface.

Returns:

the requested component.

Throws:

ResourceMissingException - if there is no component registered that implements the given apiClass.

ResourceAmbiguousException - if there are multiple components registered that implement the given apiClass.

get

<COMPONENT_API> COMPONENT_API get(Class<COMPONENT_API> apiClass,
                                  String componentId)
                           throws ResourceMissingException

This method gets the component that realizes the given apiClass and is registered under the given componentId.

Type Parameters:

COMPONENT_API - is the generic type of the apiClass.

Parameters:

apiClass - is the class reflecting the API of the requested component. This should be an interface.

componentId - is the unique ID under which the component is registered in this container.

Returns:

the requested component.

Throws:

ResourceMissingException - if there is no component registered under the given componentId or the registered component does NOT realize the given apiClass.