com.izforge.izpack.api.container

Interface Container

public interface Container

Component container.

Author:

Anthonin Bonnefoy, Tim Anderson

Method Summary

Modifier and Type	Method and Description
<T> void	addComponent(Class<T> componentType) Register a component type.
void	addComponent(Object componentKey, Object implementation) Register a component.
Container	createChildContainer() Creates a child container.
void	dispose() Disposes of the container and all of its child containers.
<T> Class<T>	getClass(String className, Class<T> superType) Returns a class given its name.
<T> T	getComponent(Class<T> componentType) Retrieve a component by its component type.
Object	getComponent(Object componentKeyOrType) Retrieve a component by its component key or type.
boolean	removeChildContainer(Container child) Removes a child container.

Method Detail

addComponent

<T> void addComponent(Class<T> componentType)

Register a component type.

Parameters:

componentType - the component type

Throws:

ContainerException - if registration fails

addComponent

void addComponent(Object componentKey,
                  Object implementation)

Register a component.

Parameters:

componentKey - the component identifier. This must be unique within the container

implementation - the component implementation

Throws:

ContainerException - if registration fails

getComponent

<T> T getComponent(Class<T> componentType)

Retrieve a component by its component type.

If the component type is registered but an instance does not exist, then it will be created.

Parameters:

componentType - the type of the component

Returns:

the corresponding object instance, or null if it does not exist

Throws:

ContainerException - if component creation fails

getComponent

Object getComponent(Object componentKeyOrType)

Retrieve a component by its component key or type.

If the component type is registered but an instance does not exist, then it will be created.

Parameters:

componentKeyOrType - the key or type of the component

Returns:

the corresponding object instance, or null if it does not exist

Throws:

ContainerException - if component creation fails

createChildContainer

Container createChildContainer()

Creates a child container.

A child container:

• may have different objects keyed on the same identifiers as its parent.
• will query its parent for dependencies if they aren't available
• is disposed when its parent is disposed

Returns:

a new container

Throws:

ContainerException - if creation fails

removeChildContainer

boolean removeChildContainer(Container child)

Removes a child container.

Parameters:

child - the container to remove

Returns:

true if the container was removed

dispose

void dispose()

Disposes of the container and all of its child containers.

getClass

<T> Class<T> getClass(String className,
                      Class<T> superType)

Returns a class given its name.

Parameters:

className - the class name

superType - the super type

Returns:

the corresponding class

Throws:

ClassCastException - if className does not implement or extend superType

IzPackClassNotFoundException - if the class cannot be found