Package com.google.inject.internal

Class ProviderMethod<T>

java.lang.Object

com.google.inject.internal.InternalProviderInstanceBindingImpl.Factory<T>

com.google.inject.internal.InternalProviderInstanceBindingImpl.CyclicFactory<T>

com.google.inject.internal.ProviderMethod<T>

All Implemented Interfaces:

InternalFactory<T>, Provider<T>, HasDependencies, ProviderWithExtensionVisitor<T>, ProvidesMethodBinding<T>, javax.inject.Provider<T>

Direct Known Subclasses:

ProviderMethod.FastClassProviderMethod, ProviderMethod.ReflectionProviderMethod

public abstract class ProviderMethod<T>
extends InternalProviderInstanceBindingImpl.CyclicFactory<T>
implements HasDependencies, ProvidesMethodBinding<T>, ProviderWithExtensionVisitor<T>

A provider that invokes a method and returns its result.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private static final class	ProviderMethod.FastClassProviderMethod<T>	A ProviderMethod implementation that uses bytecode generation to invoke the provider method.
private static final class	ProviderMethod.ReflectionProviderMethod<T>	A ProviderMethod implementation that invokes the method using normal java reflection.

Field Summary

Fields

Modifier and Type	Field	Description
private final Annotation	annotation
private final com.google.common.collect.ImmutableSet<Dependency<?>>	dependencies
private final boolean	exposed
protected final Object	instance
private final Key<T>	key
protected final Method	method
private SingleParameterInjector<?>[]	parameterInjectors	Set by initialize(InjectorImpl, Errors) so it is always available prior to injection.
private final Class<? extends Annotation>	scopeAnnotation

Fields inherited from class com.google.inject.internal.InternalProviderInstanceBindingImpl.Factory

provisionCallback

Constructor Summary

Constructors

Constructor	Description
ProviderMethod(Key<T> key, Method method, Object instance, com.google.common.collect.ImmutableSet<Dependency<?>> dependencies, Class<? extends Annotation> scopeAnnotation, Annotation annotation)

Method Summary

Modifier and Type	Method	Description
<B, V> V	acceptExtensionVisitor(BindingTargetVisitor<B,V> visitor, ProviderInstanceBinding<? extends B> binding)	Instructs the extension determine if the visitor is an instance of a custom extension visitor, and if so, visit it using that method.
void	configure(Binder binder)
(package private) static <T> ProviderMethod<T>	create(Key<T> key, Method method, Object instance, com.google.common.collect.ImmutableSet<Dependency<?>> dependencies, Class<? extends Annotation> scopeAnnotation, boolean skipFastClassGeneration, Annotation annotation)	Creates a ProviderMethod.
protected T	doProvision(InternalContext context, Dependency<?> dependency)	Creates an object to be injected.
(package private) abstract T	doProvision(Object[] parameters)	Extension point for our subclasses to implement the provisioning strategy.
boolean	equals(Object obj)
Annotation	getAnnotation()	Returns the annotation that caused this binding to be created.
Set<Dependency<?>>	getDependencies()	Returns the known dependencies for this type.
Object	getEnclosingInstance()	Returns the instance of the object the method is defined in.
Object	getInstance()
Key<T>	getKey()	Returns the key of the binding.
Method	getMethod()	Returns the method this binding uses.
int	hashCode()
(package private) void	initialize(InjectorImpl injector, Errors errors)	A callback that allows for implementations to fetch dependencies on other bindings.
String	toString()

Methods inherited from class com.google.inject.internal.InternalProviderInstanceBindingImpl.CyclicFactory

get

Methods inherited from class com.google.inject.internal.InternalProviderInstanceBindingImpl.Factory

get, getSource

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.google.inject.Provider

get

Field Details

instance

protected final Object instance

method

protected final Method method

key

private final Key<T> key

scopeAnnotation

private final Class<? extends Annotation> scopeAnnotation

dependencies

private final com.google.common.collect.ImmutableSet<Dependency<?>> dependencies

exposed

private final boolean exposed

annotation

private final Annotation annotation

parameterInjectors

private SingleParameterInjector<?>[] parameterInjectors

Set by initialize(InjectorImpl, Errors) so it is always available prior to injection.

Constructor Details

ProviderMethod

ProviderMethod(Key<T> key,
 Method method,
 Object instance,
 com.google.common.collect.ImmutableSet<Dependency<?>> dependencies,
 Class<? extends Annotation> scopeAnnotation,
 Annotation annotation)

Parameters:

method - the method to invoke. Its return type must be the same type as key.

Method Details

create

static <T> ProviderMethod<T> create(Key<T> key,
 Method method,
 Object instance,
 com.google.common.collect.ImmutableSet<Dependency<?>> dependencies,
 Class<? extends Annotation> scopeAnnotation,
 boolean skipFastClassGeneration,
 Annotation annotation)

Creates a ProviderMethod.

Unless skipFastClassGeneration is set, this will use bytecode generation to invoke the actual method, since it is significantly faster. However, this may fail if the method is private or protected, since this approach is subject to java access policies.

getKey

public Key<T> getKey()

Description copied from interface: ProvidesMethodBinding

Returns the key of the binding.

Specified by:

getKey in interface ProvidesMethodBinding<T>

getMethod

public Method getMethod()

Description copied from interface: ProvidesMethodBinding

Returns the method this binding uses.

Specified by:

getMethod in interface ProvidesMethodBinding<T>

getInstance

public Object getInstance()

getEnclosingInstance

public Object getEnclosingInstance()

Description copied from interface: ProvidesMethodBinding

Returns the instance of the object the method is defined in.

Specified by:

getEnclosingInstance in interface ProvidesMethodBinding<T>

getAnnotation

public Annotation getAnnotation()

Description copied from interface: ProvidesMethodBinding

Returns the annotation that caused this binding to be created. For @Provides methods, this is an instance of the @Provides annotation. For bindings from ModuleAnnotatedMethodScanner, this is the annotation that caused the scanner to produce the binding.

Specified by:

getAnnotation in interface ProvidesMethodBinding<T>

configure

public void configure(Binder binder)

initialize

void initialize(InjectorImpl injector,
 Errors errors)
         throws ErrorsException

Description copied from class: InternalProviderInstanceBindingImpl.Factory

A callback that allows for implementations to fetch dependencies on other bindings.

Will be called exactly once, prior to any call to InternalProviderInstanceBindingImpl.Factory.doProvision(com.google.inject.internal.InternalContext, com.google.inject.spi.Dependency<?>).

Specified by:

initialize in class InternalProviderInstanceBindingImpl.Factory<T>

Throws:

ErrorsException

doProvision

protected T doProvision(InternalContext context,
 Dependency<?> dependency)
                 throws InternalProvisionException

Description copied from class: InternalProviderInstanceBindingImpl.Factory

Creates an object to be injected.

Specified by:

doProvision in class InternalProviderInstanceBindingImpl.Factory<T>

Returns:

instance to be injected

Throws:

InternalProvisionException - if a value cannot be provided

doProvision

abstract T doProvision(Object[] parameters)
                throws IllegalAccessException,
InvocationTargetException

Extension point for our subclasses to implement the provisioning strategy.

Throws:

IllegalAccessException

InvocationTargetException

getDependencies

public Set<Dependency<?>> getDependencies()

Description copied from interface: HasDependencies

Returns the known dependencies for this type. If this has dependencies whose values are not known statically, a dependency for the Injector will be included in the returned set.

Specified by:

getDependencies in interface HasDependencies

Returns:

a possibly empty set

acceptExtensionVisitor

public <B,
V> V acceptExtensionVisitor(BindingTargetVisitor<B,V> visitor,
 ProviderInstanceBinding<? extends B> binding)

Description copied from interface: ProviderWithExtensionVisitor

Instructs the extension determine if the visitor is an instance of a custom extension visitor, and if so, visit it using that method. If the visitor is not an instance of the custom extension visitor, this method MUST call visitor.visit(binding).

Due to issues with generics, the type parameters of this method do not relate to the type of the provider. In practice, the 'B' type will always be a supertype of 'T'.

Specified by:

acceptExtensionVisitor in interface ProviderWithExtensionVisitor<T>

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object