org.picocontainer.alternatives

Class EmptyPicoContainer

java.lang.Object

org.picocontainer.alternatives.EmptyPicoContainer

All Implemented Interfaces:

java.io.Serializable, Disposable, PicoContainer, Startable

public class EmptyPicoContainer
extends java.lang.Object
implements PicoContainer, java.io.Serializable

empty pico container serving as recoil damper in situations where you do not like to check whether container reference suplpied to you is null or not

Since:

1.1

Author:

Konstantin Pribluda

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
EmptyPicoContainer()

Method Summary

Methods

Modifier and Type	Method and Description
void	accept(PicoVisitor visitor) Accepts a visitor that should visit the child containers, component adapters and component instances.
void	dispose() Dispose this component.
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	getComponentAdapters() Retrieve all the component adapters inside this container.
java.util.List	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.
java.util.List	getComponentInstances() Retrieve all the registered component instances in the container, (not including those in the parent container).
java.util.List	getComponentInstancesOfType(java.lang.Class componentType) Returns a List of components of a certain componentType.
PicoContainer	getParent() Retrieve the parent container of this container.
void	start() Start this component.
void	stop() Stop this component.
void	verify() Verify that the dependencies for all the registered components can be satisfied.

Methods inherited from class java.lang.Object

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

Constructor Detail

EmptyPicoContainer

public EmptyPicoContainer()

Method Detail

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.

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

getComponentInstances

public java.util.List getComponentInstances()

Description copied from interface: PicoContainer

Retrieve all the registered component instances in the container, (not including those in the parent container). The components are returned in their order of instantiation, which depends on the dependency order between them.

Specified by:

getComponentInstances in interface PicoContainer

Returns:

all the components.

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.

getComponentAdapter

public 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.

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.

getComponentAdapters

public java.util.Collection 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.

getComponentAdaptersOfType

public java.util.List 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.

verify

public void verify()

Description copied from interface: PicoContainer

Verify that the dependencies for all the registered components can be satisfied. No components are instantiated during the verification process.

Specified by:

verify in interface PicoContainer

accept

public void accept(PicoVisitor visitor)

Description copied from interface: PicoContainer

Accepts a visitor that should visit the child containers, component adapters and component instances.

Specified by:

accept in interface PicoContainer

Parameters:

visitor - the visitor

getComponentInstancesOfType

public java.util.List getComponentInstancesOfType(java.lang.Class componentType)

Description copied from interface: PicoContainer

Returns a List of components of a certain componentType. The list is ordered by instantiation order, starting with the components instantiated first at the beginning.

Specified by:

getComponentInstancesOfType in interface PicoContainer

Parameters:

componentType - the searched type.

Returns:

a List of components.

start

public void start()

Description copied from interface: Startable

Start this component. Called initially at the begin of the lifecycle. It can be called again after a stop.

Specified by:

start in interface Startable

stop

public void stop()

Description copied from interface: Startable

Stop this component. Called near the end of the lifecycle. It can be called again after a further start. Implement Disposable if you need a single call at the definite end of the lifecycle.

Specified by:

stop in interface Startable

dispose

public void dispose()

Description copied from interface: Disposable

Dispose this component. The component should deallocate all resources. The contract for this method defines a single call at the end of this component's life.

Specified by:

dispose in interface Disposable