org.symphonyoss.s2.fugue.di

Class ComponentDescriptor

java.lang.Object

org.symphonyoss.s2.fugue.di.ComponentDescriptor

public class ComponentDescriptor
extends Object

Fugue components are required to provide a ComponentDescriptor which specifies what dependencies it has and what interfaces it provides.

Author:

Bruce Skingle

Constructor Summary

Constructors

Constructor and Description
ComponentDescriptor()

Method Summary

Modifier and Type	Method and Description
<T> ComponentDescriptor	addDependency(Class<T> requiredInterface, IBinder<T> binder) Add a simple (Cardinality.One) dependency.
<T> ComponentDescriptor	addDependency(Class<T> requiredInterface, IBinder<T> binder, Cardinality cardinality) Add a dependency.
ComponentDescriptor	addProvidedInterface(Class<?> providedInterface) Add an interface which this component implements and which can be provided to other components.
ComponentDescriptor	addStart(Runnable handler) Add a Runnable which will be called during process initialisation.
ComponentDescriptor	addStop(Runnable handler) Add a Runnable which will be called during process termination.

Methods inherited from class java.lang.Object

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

Constructor Detail

ComponentDescriptor

public ComponentDescriptor()

Method Detail

addDependency

public <T> ComponentDescriptor addDependency(Class<T> requiredInterface,
                                             IBinder<T> binder)

Add a simple (Cardinality.One) dependency. Convenience method.

Parameters:

requiredInterface - The interface of which an implementation is required.

binder - The binder to be called with the injected value.

Returns:

this - fluent interface.

addDependency

public <T> ComponentDescriptor addDependency(Class<T> requiredInterface,
                                             IBinder<T> binder,
                                             Cardinality cardinality)

Add a dependency.

Parameters:

requiredInterface - The interface of which an implementation is required.

cardinality - The number of instances which is required.

binder - The binder to be called with the injected value.

Returns:

this - fluent interface.

addProvidedInterface

public ComponentDescriptor addProvidedInterface(Class<?> providedInterface)

Add an interface which this component implements and which can be provided to other components. If the class provided does not actually implement this interface then a runtime exception will be thrown from the resolve method of the context.

Parameters:

providedInterface - An interface which is provided.

Returns:

this - fluent interface.

addStart

public ComponentDescriptor addStart(Runnable handler)

Add a Runnable which will be called during process initialisation.

Parameters:

handler - A Runnable to be called at start time.

Returns:

This (fluent method)

addStop

public ComponentDescriptor addStop(Runnable handler)

Add a Runnable which will be called during process termination.

Parameters:

handler - A Runnable to be called at shutdown time.

Returns:

This (fluent method)