Package com.intellij.util.pico

Class DefaultPicoContainer

java.lang.Object

com.intellij.util.pico.DefaultPicoContainer

All Implemented Interfaces:

MutablePicoContainer, PicoContainer

public class DefaultPicoContainer
extends java.lang.Object
implements MutablePicoContainer

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DefaultPicoContainer.InstanceComponentAdapter

Constructor Summary

Constructors

Constructor and Description
DefaultPicoContainer()
DefaultPicoContainer(PicoContainer parent)

Method Summary

Modifier and Type	Method and Description
ComponentAdapter	getComponentAdapter(java.lang.Object componentKey) Find a component adapter associated with the specified key.
ComponentAdapter	getComponentAdapterOfType(java.lang.Class componentType) Find a component adapter associated with the specified type.
java.util.Collection<ComponentAdapter>	getComponentAdapters() Retrieve all the component adapters inside this container.
java.util.List<ComponentAdapter>	getComponentAdaptersOfType(java.lang.Class componentType) Retrieve all component adapters inside this container that are associated with the specified type.
java.lang.Object	getComponentInstance(java.lang.Object componentKey) Retrieve a component instance registered with a specific key.
java.lang.Object	getComponentInstanceOfType(java.lang.Class componentType) Find a component instance matching the specified type.
PicoContainer	getParent() Retrieve the parent container of this container.
<T> T	getService(java.lang.Class<T> serviceClass)
ComponentAdapter	getServiceAdapter(java.lang.String key)
ComponentAdapter	registerComponent(ComponentAdapter componentAdapter) Register a component via a ComponentAdapter.
ComponentAdapter	registerComponentImplementation(java.lang.Class componentImplementation) Register a component using the componentImplementation as key.
ComponentAdapter	registerComponentImplementation(java.lang.Object componentKey, java.lang.Class componentImplementation) Register a component.
ComponentAdapter	registerComponentImplementation(java.lang.Object componentKey, java.lang.Class componentImplementation, Parameter[] parameters) Register a component.
ComponentAdapter	registerComponentInstance(java.lang.Object component) Register an arbitrary object.
ComponentAdapter	registerComponentInstance(java.lang.Object componentKey, java.lang.Object componentInstance) Register an arbitrary object as a component in the container.
void	release()
java.lang.String	toString()
ComponentAdapter	unregisterComponent(java.lang.Object componentKey) Unregister a component by key.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

DefaultPicoContainer

public DefaultPicoContainer(PicoContainer parent)

DefaultPicoContainer

public DefaultPicoContainer()

Method Detail

getComponentAdapters

public java.util.Collection<ComponentAdapter> getComponentAdapters()

Description copied from interface: PicoContainer

Retrieve all the component adapters inside this container. The component adapters from the parent container are not returned.

Specified by:

getComponentAdapters in interface PicoContainer

Returns:

a collection containing all the ComponentAdapters inside this container. The collection will not be modifiable.

See Also:

a variant of this method which returns the component adapters inside this container that are associated with the specified type.

getComponentAdapter

public final ComponentAdapter getComponentAdapter(java.lang.Object componentKey)

Description copied from interface: PicoContainer

Find a component adapter associated with the specified key. If a component adapter cannot be found in this container, the parent container (if one exists) will be searched.

Specified by:

getComponentAdapter in interface PicoContainer

Parameters:

componentKey - the key that the component was registered with.

Returns:

the component adapter associated with this key, or null if no component has been registered for the specified key.

release

public void release()

getComponentAdapterOfType

public ComponentAdapter getComponentAdapterOfType(java.lang.Class componentType)

Description copied from interface: PicoContainer

Find a component adapter associated with the specified type. If a component adapter cannot be found in this container, the parent container (if one exists) will be searched.

Specified by:

getComponentAdapterOfType in interface PicoContainer

Parameters:

componentType - the type of the component.

Returns:

the component adapter associated with this class, or null if no component has been registered for the specified key.

getComponentAdaptersOfType

public java.util.List<ComponentAdapter> getComponentAdaptersOfType(java.lang.Class componentType)

Description copied from interface: PicoContainer

Retrieve all component adapters inside this container that are associated with the specified type. The component adapters from the parent container are not returned.

Specified by:

getComponentAdaptersOfType in interface PicoContainer

Parameters:

componentType - the type of the components.

Returns:

a collection containing all the ComponentAdapters inside this container that are associated with the specified type. Changes to this collection will not be reflected in the container itself.

registerComponent

public ComponentAdapter registerComponent(ComponentAdapter componentAdapter)

Description copied from interface: MutablePicoContainer

Register a component via a ComponentAdapter. Use this if you need fine grained control over what ComponentAdapter to use for a specific component.

Specified by:

registerComponent in interface MutablePicoContainer

Parameters:

componentAdapter - the adapter

Returns:

the same adapter that was passed as an argument.

unregisterComponent

public ComponentAdapter unregisterComponent(java.lang.Object componentKey)

Description copied from interface: MutablePicoContainer

Unregister a component by key.

Specified by:

unregisterComponent in interface MutablePicoContainer

Parameters:

componentKey - key of the component to unregister.

Returns:

the ComponentAdapter that was associated with this component.

getComponentInstance

public java.lang.Object getComponentInstance(java.lang.Object componentKey)

Description copied from interface: PicoContainer

Retrieve a component instance registered with a specific key. If a component cannot be found in this container, the parent container (if one exists) will be searched.

Specified by:

getComponentInstance in interface PicoContainer

Parameters:

componentKey - the key that the component was registered with.

Returns:

an instantiated component, or null if no component has been registered for the specified key.

getService

public <T> T getService(java.lang.Class<T> serviceClass)

getServiceAdapter

public final ComponentAdapter getServiceAdapter(java.lang.String key)

getComponentInstanceOfType

public java.lang.Object getComponentInstanceOfType(java.lang.Class componentType)

Description copied from interface: PicoContainer

Find a component instance matching the specified type.

Specified by:

getComponentInstanceOfType in interface PicoContainer

Parameters:

componentType - the type of the component

Returns:

an instantiated component matching the class, or null if no component has been registered with a matching type

registerComponentInstance

public ComponentAdapter registerComponentInstance(java.lang.Object component)

Description copied from interface: MutablePicoContainer

Register an arbitrary object. The class of the object will be used as a key. Calling this method is equivalent to calling * registerComponentImplementation(componentImplementation, componentImplementation).

Specified by:

registerComponentInstance in interface MutablePicoContainer

Returns:

the ComponentAdapter that has been associated with this component. In the majority of cases, this return value can be safely ignored, as one of the getXXX() methods of the PicoContainer interface can be used to retrieve a reference to the component later on.

registerComponentInstance

public ComponentAdapter registerComponentInstance(java.lang.Object componentKey,
                                                  java.lang.Object componentInstance)

Description copied from interface: MutablePicoContainer

Register an arbitrary object as a component in the container. This is handy when other components in the same container have dependencies on this kind of object, but where letting the container manage and instantiate it is impossible.

Beware that too much use of this method is an antipattern.

Specified by:

registerComponentInstance in interface MutablePicoContainer

Parameters:

componentKey - a key that identifies the component. Must be unique within the conainer. The type of the key object has no semantic significance unless explicitly specified in the implementing container.

componentInstance - an arbitrary object.

Returns:

the ComponentAdapter that has been associated with this component. In the majority of cases, this return value can be safely ignored, as one of the getXXX() methods of the PicoContainer interface can be used to retrieve a reference to the component later on.

registerComponentImplementation

public ComponentAdapter registerComponentImplementation(java.lang.Class componentImplementation)

Description copied from interface: MutablePicoContainer

Register a component using the componentImplementation as key. Calling this method is equivalent to calling registerComponentImplementation(componentImplementation, componentImplementation).

Specified by:

registerComponentImplementation in interface MutablePicoContainer

Parameters:

componentImplementation - the concrete component class.

Returns:

the ComponentAdapter that has been associated with this component. In the majority of cases, this return value can be safely ignored, as one of the getXXX() methods of the PicoContainer interface can be used to retrieve a reference to the component later on.

registerComponentImplementation

public ComponentAdapter registerComponentImplementation(java.lang.Object componentKey,
                                                        java.lang.Class componentImplementation)

Description copied from interface: MutablePicoContainer

Register a component.

Specified by:

registerComponentImplementation in interface MutablePicoContainer

Parameters:

componentKey - a key that identifies the component. Must be unique within the container. The type of the key object has no semantic significance unless explicitly specified in the documentation of the implementing container.

componentImplementation - the component's implementation class. This must be a concrete class (ie, a class that can be instantiated).

Returns:

the ComponentAdapter that has been associated with this component. In the majority of cases, this return value can be safely ignored, as one of the getXXX() methods of the PicoContainer interface can be used to retrieve a reference to the component later on.

See Also:

a variant of this method that allows more control over the parameters passed into the componentImplementation constructor when constructing an instance.

registerComponentImplementation

public ComponentAdapter registerComponentImplementation(java.lang.Object componentKey,
                                                        java.lang.Class componentImplementation,
                                                        Parameter[] parameters)

Description copied from interface: MutablePicoContainer

Register a component.

Specified by:

registerComponentImplementation in interface MutablePicoContainer

Parameters:

componentKey - a key that identifies the component. Must be unique within the container. The type of the key object has no semantic significance unless explicitly specified in the documentation of the implementing container.

componentImplementation - the component's implementation class. This must be a concrete class (ie, a class that can be instantiated).

parameters - an array of parameters that gives the container hints about what arguments to pass to the constructor when it is instantiated. Container implementations may ignore one or more of these hints.

Returns:

the ComponentAdapter that has been associated with this component. In the majority of cases, this return value can be safely ignored, as one of the getXXX() methods of the PicoContainer interface can be used to retrieve a reference to the component later on.

getParent

public PicoContainer getParent()

Description copied from interface: PicoContainer

Retrieve the parent container of this container.

Specified by:

getParent in interface PicoContainer

Returns:

a PicoContainer instance, or null if this container does not have a parent.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object