Top Description Inners Fields Constructors Methods
com.google.inject.internal

public final Class ProviderMethodsModule

extends Object
implements Module
Class Inheritance
All Implemented Interfaces
com.google.inject.Module
Static Imports
com.google.common.base.Preconditions.checkNotNull, .Preconditions.checkState

Creates bindings to methods annotated with @Provides. Use the scope and binding annotations on the provider method to configure the binding.
Authors
[email protected] (Bob Lee), [email protected] (Jesse Wilson)

Nested and Inner Type Summary

Modifier and TypeClass and Description
private static class
private static class

Field Summary

Modifier and TypeField and Description
private final Object
private final ModuleAnnotatedMethodScanner
private final boolean
private final TypeLiteral<?>

Constructor Summary

AccessConstructor and Description
private
ProviderMethodsModule(Object delegate, boolean skipFastClassGeneration, ModuleAnnotatedMethodScanner scanner)

Method Summary

Modifier and TypeMethod and Description
public void
configure(Binder binder)

Implements com.google.inject.Module.configure.

Contributes bindings and other configurations for this module to binder.
private <T> ProviderMethod<T>
createProviderMethod(Binder binder, Method method, Annotation annotation)

public boolean
equals(Object
the reference object with which to compare.
o
)

Overrides java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.
public static Module
forModule(Module module)

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

public static Module
forModule(Object module, ModuleAnnotatedMethodScanner scanner)

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

public static Module
forObject(Object object)

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

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

private Annotation
getAnnotation(Binder binder, Method method)

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

public Class<?>
pack-priv <T> Key<T>
getKey(Errors errors, TypeLiteral<T> type, Member member, Annotation[] annotations)

public List<ProviderMethod<?>>
public ModuleAnnotatedMethodScanner
public int
hashCode()

Overrides java.lang.Object.hashCode.

Returns a hash code value for this object.
public boolean
isScanningBuiltInProvidesMethods()

Is it scanning the built-in @Provides* methods.

private boolean
private static boolean
overrides(Method a, Method b)

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

Inherited from java.lang.Object:
clonefinalizegetClassnotifynotifyAlltoStringwaitwaitwait

Field Detail

delegateback to summary
private final Object delegate
scannerback to summary
private final ModuleAnnotatedMethodScanner scanner
skipFastClassGenerationback to summary
private final boolean skipFastClassGeneration
typeLiteralback to summary
private final TypeLiteral<?> typeLiteral

Constructor Detail

ProviderMethodsModuleback to summary
private ProviderMethodsModule(Object delegate, boolean skipFastClassGeneration, ModuleAnnotatedMethodScanner scanner)

Method Detail

configureback to summary
public void configure(Binder binder)

Implements com.google.inject.Module.configure.

Doc from com.google.inject.Module.configure.

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.

Annotations
@Override
createProviderMethodback to summary
private <T> ProviderMethod<T> createProviderMethod(Binder binder, Method method, Annotation annotation)
equalsback to summary
public boolean equals(Object o)

Overrides java.lang.Object.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

  • It is reflexive: for any non-null reference value x, x.equals(x) should return true.
  • It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
  • It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
  • It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
  • For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters
o:Object

the reference object with which to compare.

Returns:boolean

true if this object is the same as the obj argument; false otherwise.

Annotations
@Override
forModuleback to summary
public static Module forModule(Module module)

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

forModuleback to summary
public static Module forModule(Object module, ModuleAnnotatedMethodScanner scanner)

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

forObjectback to summary
public static Module forObject(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.

forObjectback to summary
private static Module forObject(Object object, boolean skipFastClassGeneration, ModuleAnnotatedMethodScanner scanner)
getAnnotationback to summary
private Annotation getAnnotation(Binder binder, Method method)

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

getDelegateModuleClassback to summary
public Class<?> getDelegateModuleClass()
getKeyback to summary
pack-priv <T> Key<T> getKey(Errors errors, TypeLiteral<T> type, Member member, Annotation[] annotations)
getProviderMethodsback to summary
public List<ProviderMethod<?>> getProviderMethods(Binder binder)
getScannerback to summary
public ModuleAnnotatedMethodScanner getScanner()
hashCodeback to summary
public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

  • Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
  • If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
  • It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.
Returns:int

a hash code value for this object

Annotations
@Override
isScanningBuiltInProvidesMethodsback to summary
public boolean isScanningBuiltInProvidesMethods()

Is it scanning the built-in @Provides* methods.

isStaticModuleback to summary
private boolean isStaticModule()
overridesback to summary
private static boolean overrides(Method a, Method b)

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

com.google.inject.internal back to summary

private Class ProviderMethodsModule.MethodAndAnnotation

extends Object
Class Inheritance
  • java.lang.Object
  • com.google.inject.internal.ProviderMethodsModule.MethodAndAnnotation

Field Summary

Modifier and TypeField and Description
pack-priv final Annotation
pack-priv final Method

Constructor Summary

AccessConstructor and Description
pack-priv

Method Summary

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

annotationback to summary
pack-priv final Annotation annotation
methodback to summary
pack-priv final Method method

Constructor Detail

MethodAndAnnotationback to summary
pack-priv MethodAndAnnotation(Method method, Annotation annotation)
com.google.inject.internal back to summary

private final Class ProviderMethodsModule.Signature

extends Object
Class Inheritance

Field Summary

Modifier and TypeField and Description
pack-priv final int
pack-priv final String
pack-priv final Class<?>[]

Constructor Summary

AccessConstructor and Description
pack-priv
Signature(TypeLiteral<?> typeLiteral, Method method)

Method Summary

Modifier and TypeMethod and Description
public boolean
equals(Object
the reference object with which to compare.
obj
)

Overrides java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.
public int
hashCode()

Overrides java.lang.Object.hashCode.

Returns a hash code value for this object.
Inherited from java.lang.Object:
clonefinalizegetClassnotifynotifyAlltoStringwaitwaitwait

Field Detail

hashCodeback to summary
pack-priv final int hashCode
nameback to summary
pack-priv final String name
parametersback to summary
pack-priv final Class<?>[] parameters

Constructor Detail

Signatureback to summary
pack-priv Signature(TypeLiteral<?> typeLiteral, Method method)

Method Detail

equalsback to summary
public boolean equals(Object obj)

Overrides java.lang.Object.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

  • It is reflexive: for any non-null reference value x, x.equals(x) should return true.
  • It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
  • It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
  • It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
  • For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters
obj:Object

the reference object with which to compare.

Returns:boolean

true if this object is the same as the obj argument; false otherwise.

Annotations
@Override
hashCodeback to summary
public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

  • Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
  • If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
  • It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.
Returns:int

a hash code value for this object

Annotations
@Override