Package com.google.inject.internal

Class ProviderMethodsModule

java.lang.Object

com.google.inject.internal.ProviderMethodsModule

All Implemented Interfaces:

Module

public final class ProviderMethodsModule
extends java.lang.Object
implements Module

Creates bindings to methods annotated with @Provides. Use the scope and binding annotations on the provider method to configure the binding.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private static class	ProviderMethodsModule.MethodAndAnnotation
private static class	ProviderMethodsModule.Signature

Field Summary

Fields

Modifier and Type	Field	Description
private java.lang.Object	delegate
private ModuleAnnotatedMethodScanner	scanner
private boolean	skipFastClassGeneration
private TypeLiteral<?>	typeLiteral

Constructor Summary

Constructors

Modifier	Constructor	Description
private	ProviderMethodsModule(java.lang.Object delegate, boolean skipFastClassGeneration, ModuleAnnotatedMethodScanner scanner)

Method Summary

Modifier and Type	Method	Description
void	configure(Binder binder)	Contributes bindings and other configurations for this module to binder.
private <T> ProviderMethod<T>	createProviderMethod(Binder binder, java.lang.reflect.Method method, java.lang.annotation.Annotation annotation)
boolean	equals(java.lang.Object o)
static Module	forModule(Module module)	Returns a module which creates bindings for provider methods from the given module.
static Module	forModule(java.lang.Object module, ModuleAnnotatedMethodScanner scanner)	Returns a module which creates bindings methods in the module that match the scanner.
static Module	forObject(java.lang.Object object)	Returns a module which creates bindings for provider methods from the given object.
private static Module	forObject(java.lang.Object object, boolean skipFastClassGeneration, ModuleAnnotatedMethodScanner scanner)
private java.lang.annotation.Annotation	getAnnotation(Binder binder, java.lang.reflect.Method method)	Returns the annotation that is claimed by the scanner, or null if there is none.
java.lang.Class<?>	getDelegateModuleClass()
(package private) <T> Key<T>	getKey(Errors errors, TypeLiteral<T> type, java.lang.reflect.Member member, java.lang.annotation.Annotation[] annotations)
java.util.List<ProviderMethod<?>>	getProviderMethods(Binder binder)
int	hashCode()
private boolean	isStaticModule()
private static boolean	overrides(java.lang.reflect.Method a, java.lang.reflect.Method b)	Returns true if a overrides b, assumes that the signatures match

Methods inherited from class java.lang.Object

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

Field Detail

delegate

private final java.lang.Object delegate

typeLiteral

private final TypeLiteral<?> typeLiteral

skipFastClassGeneration

private final boolean skipFastClassGeneration

scanner

private final ModuleAnnotatedMethodScanner scanner

Constructor Detail

ProviderMethodsModule

private ProviderMethodsModule(java.lang.Object delegate,
                              boolean skipFastClassGeneration,
                              ModuleAnnotatedMethodScanner scanner)

Method Detail

forModule

public static Module forModule(Module module)

Returns a module which creates bindings for provider methods from the given module.

forModule

public static Module forModule(java.lang.Object module,
                               ModuleAnnotatedMethodScanner scanner)

Returns a module which creates bindings methods in the module that match the scanner.

forObject

public static Module forObject(java.lang.Object object)

Returns a module which creates bindings for provider methods from the given object. This is useful notably for GIN

This will skip bytecode generation for provider methods, since it is assumed that callers are only interested in Module metadata.

forObject

private static Module forObject(java.lang.Object object,
                                boolean skipFastClassGeneration,
                                ModuleAnnotatedMethodScanner scanner)

getDelegateModuleClass

public java.lang.Class<?> getDelegateModuleClass()

isStaticModule

private boolean isStaticModule()

configure

public void configure(Binder binder)

Description copied from interface: Module

Contributes bindings and other configurations for this module to binder.

Do not invoke this method directly to install submodules. Instead use Binder.install(Module), which ensures that provider methods are discovered.

Specified by:

configure in interface Module

getProviderMethods

public java.util.List<ProviderMethod<?>> getProviderMethods(Binder binder)

getAnnotation

private java.lang.annotation.Annotation getAnnotation(Binder binder,
                                                      java.lang.reflect.Method method)

Returns the annotation that is claimed by the scanner, or null if there is none.

overrides

private static boolean overrides(java.lang.reflect.Method a,
                                 java.lang.reflect.Method b)

Returns true if a overrides b, assumes that the signatures match

createProviderMethod

private <T> ProviderMethod<T> createProviderMethod(Binder binder,
                                                   java.lang.reflect.Method method,
                                                   java.lang.annotation.Annotation annotation)

getKey

<T> Key<T> getKey(Errors errors,
                  TypeLiteral<T> type,
                  java.lang.reflect.Member member,
                  java.lang.annotation.Annotation[] annotations)

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object