org.grouplens.grapht.reflect.internal

Class ReflectionDesire

java.lang.Object

org.grouplens.grapht.reflect.internal.ReflectionDesire

All Implemented Interfaces:

Serializable, Desire

public class ReflectionDesire
extends Object
implements Desire, Serializable

ReflectionDesire is an implementation of desire that contains all necessary implementation to represent a desire, except that the point of injection is abstracted by an InjectionPoint.

Author:

GroupLens Research

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ReflectionDesire.Signature

Constructor Summary

Constructors

Constructor and Description
ReflectionDesire(Class<?> desiredType, InjectionPoint injectPoint, Satisfaction satisfaction) Create a ReflectionDesire that represents the dependency for desiredType that will be injected into the given InjectionPoint.
ReflectionDesire(InjectionPoint injectPoint) Create a ReflectionDesire that immediately wraps the given InjectionPoint.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
Class<?>	getDesiredType()
static List<Desire>	getDesires(Class<?> type) Return a list of desires that must satisfied in order to instantiate the given type.
InjectionPoint	getInjectionPoint()
Satisfaction	getSatisfaction() Get the satisfaction (concrete type) if this desire is fully resolved.
int	hashCode()
boolean	isInstantiable() Query whether this desire is instantiable, that is, resolved to a concrete type.
Desire	restrict(Class<?> type) Return a new Desire that restricts the type of this desire to the given class.
Desire	restrict(Satisfaction satis) Return a new Desire that restricts the type of this desire to the erased type of the satisfaction.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ReflectionDesire

public ReflectionDesire(InjectionPoint injectPoint)

Create a ReflectionDesire that immediately wraps the given InjectionPoint. The desired type equals the type declared by the injection point. The created desire will have a satisfaction if the injection point's type is satisfiable.

Parameters:

injectPoint - The injection point to wrap

Throws:

NullPointerException - if injectPoint is null

ReflectionDesire

public ReflectionDesire(Class<?> desiredType,
                        InjectionPoint injectPoint,
                        Satisfaction satisfaction)

Create a ReflectionDesire that represents the dependency for desiredType that will be injected into the given InjectionPoint. The optional satisfaction will satisfy this desire. If null is provided, and the desired type instantiable, a ClassSatisfaction is created.

Parameters:

desiredType - The desired type of the dependency

injectPoint - The injection point of the desire

satisfaction - The satisfaction satisfying this desire, if there is one

Throws:

NullPointerException - if desiredType, injectPoint, or dfltSource is null

IllegalArgumentException - if desiredType is not assignable to the type of the injection point, or if the satisfaction's type is not assignable to the desired type

Method Detail

getDesires

public static List<Desire> getDesires(Class<?> type)

Return a list of desires that must satisfied in order to instantiate the given type.

Parameters:

type - The class type whose dependencies will be queried

Returns:

The dependency desires for the given type

Throws:

NullPointerException - if the type is null

getDesiredType

public Class<?> getDesiredType()

Specified by:

getDesiredType in interface Desire

Returns:

The desired type, potentially more constrained than the injection point's type

getInjectionPoint

public InjectionPoint getInjectionPoint()

Specified by:

getInjectionPoint in interface Desire

Returns:

The injection point of this desire

isInstantiable

public boolean isInstantiable()

Description copied from interface: Desire

Query whether this desire is instantiable, that is, resolved to a concrete type. If it is instantiable, then it can be converted to a Satisfaction with Desire.getSatisfaction().

Specified by:

isInstantiable in interface Desire

Returns:

true if the desire is for a concrete class. The only further desires or satisfactions that can satisfy it are for subclasses of the desire type.

getSatisfaction

public Satisfaction getSatisfaction()

Description copied from interface: Desire

Get the satisfaction (concrete type) if this desire is fully resolved.

Specified by:

getSatisfaction in interface Desire

Returns:

The satisfaction for this desire, or null if the desire is not a concrete type.

restrict

public Desire restrict(Class<?> type)

Description copied from interface: Desire

Return a new Desire that restricts the type of this desire to the given class. The type must be a subclass of the desired type.

Specified by:

restrict in interface Desire

Parameters:

type - The restricted type

Returns:

A restricted Desire

restrict

public Desire restrict(Satisfaction satis)

Description copied from interface: Desire

Return a new Desire that restricts the type of this desire to the erased type of the satisfaction. The returned Desire will also be instantiable and return the provided satisfaction from Desire.getSatisfaction().

Specified by:

restrict in interface Desire

Parameters:

satis - The satisfaction to restrict this desire to

Returns:

A restricted and satisfied desire

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object