org.grouplens.grapht.reflect.internal

Class ProviderClassSatisfaction

java.lang.Object

org.grouplens.grapht.reflect.internal.ProviderClassSatisfaction

All Implemented Interfaces:

Serializable, Satisfaction

public class ProviderClassSatisfaction
extends Object
implements Satisfaction, Serializable

ProviderClassSatisfaction is a satisfaction implementation that satisfies a type given a Provider class capable of providing that type.

Author:

GroupLens Research

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ProviderClassSatisfaction(Class<? extends javax.inject.Provider<?>> providerType) Create a ProviderClassSatisfaction that wraps a given provider type.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
CachePolicy	getDefaultCachePolicy() Get the default cache policy for instances created by this satisfaction.
List<Desire>	getDependencies() Get this satisfaction's dependencies.
Class<?>	getErasedType() Get the type-erased class of this satisfaction's type.
Class<? extends javax.inject.Provider<?>>	getProviderType()
Type	getType() Get the type of this satisfaction.
int	hashCode()
boolean	hasInstance() Query whether this satisfaction already has an instance to return.
Instantiator	makeInstantiator(Map<Desire,Instantiator> dependencies, LifecycleManager lm) Create an instantiator from this satisfaction.
String	toString()
<T> T	visit(SatisfactionVisitor<T> visitor) Visit the satisfaction.

Methods inherited from class java.lang.Object

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

Constructor Detail

ProviderClassSatisfaction

public ProviderClassSatisfaction(Class<? extends javax.inject.Provider<?>> providerType)

Create a ProviderClassSatisfaction that wraps a given provider type.

Parameters:

providerType - The provider class type

Throws:

NullPointerException - if providerType is null

IllegalArgumentException - if the class is not a Provider, or is not instantiable

Method Detail

getDefaultCachePolicy

public CachePolicy getDefaultCachePolicy()

Description copied from interface: Satisfaction

Get the default cache policy for instances created by this satisfaction. In most cases this should be NO_PREFERENCE, but annotations such as Singleton can be used to specify a default. BindingFunctions are allowed to overrule the default cache policy.

Specified by:

getDefaultCachePolicy in interface Satisfaction

Returns:

The default cache policy if no function overrules it

getProviderType

public Class<? extends javax.inject.Provider<?>> getProviderType()

Returns:

The Provider class that provides instances satisfying this satisfaction

getDependencies

public List<Desire> getDependencies()

Description copied from interface: Satisfaction

Get this satisfaction's dependencies.

Specified by:

getDependencies in interface Satisfaction

Returns:

A list of dependencies which must be satisfied in order to instantiate this satisfaction.

getType

public Type getType()

Description copied from interface: Satisfaction

Get the type of this satisfaction. If this is a synthetic Satisfaction, then a null type is returned.

Specified by:

getType in interface Satisfaction

Returns:

The type of objects to be instantiated by this satisfaction.

getErasedType

public Class<?> getErasedType()

Description copied from interface: Satisfaction

Get the type-erased class of this satisfaction's type. If this is a synthetic Satisfaction, then null is returned.

Specified by:

getErasedType in interface Satisfaction

Returns:

The class object for this satisfaction's type.

hasInstance

public boolean hasInstance()

Description copied from interface: Satisfaction

Query whether this satisfaction already has an instance to return. If true, then this satisfaction's provider will just return an instance that is already in existence; if false, then its provider may create new instances.

Specified by:

hasInstance in interface Satisfaction

Returns:

whether the satisfaction already has an instance.

visit

public <T> T visit(SatisfactionVisitor<T> visitor)

Description copied from interface: Satisfaction

Visit the satisfaction. This method invokes the appropriate method on the provided visitor to report information on itself.

Specified by:

visit in interface Satisfaction

Type Parameters:

T - The type returned from the visitor.

Parameters:

visitor - The visitor object.

Returns:

The return value from the invoked visitor method.

makeInstantiator

public Instantiator makeInstantiator(Map<Desire,Instantiator> dependencies,
                                     LifecycleManager lm)

Description copied from interface: Satisfaction

Create an instantiator from this satisfaction.

If the details of the Satisfaction require instantiation (e.g. a class or provider class satisfaction), the returned provider should be a new instance, and it should perform no memoization of its own. Caching is the purview of Injector implementations.

If the satisfaction is configured to use specific instances, this rule is obviously void.

Specified by:

makeInstantiator in interface Satisfaction

Parameters:

dependencies - A function mapping desires to providers of their instances.

lm - The lifecycle manager (if one should be used).

Returns:

An instantiator of new instances of the type specified by this satisfaction, instantiated using the specified dependency mapping.

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