Google Guice - Core Library 7.0.0 · com.google.inject.internal.ProviderMethod

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

Field Summary

Modifier and Type	Field and Description
private final Annotation	annotation
private final 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

Constructor Summary

Access	Constructor and Description
pack-priv	ProviderMethod(Key<T> key, Method the method to invoke. Its return type must be the same type as `key`. method, Object instance, ImmutableSet<Dependency<?>> dependencies, Class<? extends Annotation> scopeAnnotation, Annotation annotation)

Method Summary

Modifier and Type	Method and Description
public <B, V> V	acceptExtensionVisitor(BindingTargetVisitor<B, V> visitor, ProviderInstanceBinding<? extends B> binding) Implements com.google.inject.spi.ProviderWithExtensionVisitor.acceptExtensionVisitor. Instructs the extension determine if the visitor is an instance of a custom extension visitor, and if so, visit it using that method.
public void	configure(Binder binder)
pack-priv static <T> ProviderMethod<T>	create(Key<T> key, Method method, Object instance, ImmutableSet<Dependency<?>> dependencies, Class<? extends Annotation> scopeAnnotation, boolean skipFastClassGeneration, Annotation annotation) Creates a `ProviderMethod`.
protected T	doProvision(InternalContext context, Dependency<?> dependency) Implements abstract com.google.inject.internal.InternalProviderInstanceBindingImpl.Factory.doProvision. Creates an object to be injected.
pack-priv abstract T	doProvision(Object[] parameters) Extension point for our subclasses to implement the provisioning strategy.
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 Annotation	getAnnotation() Implements com.google.inject.spi.ProvidesMethodBinding.getAnnotation. Returns the annotation that caused this binding to be created.
public Set<Dependency<?>>	getDependencies() Implements com.google.inject.spi.HasDependencies.getDependencies. Returns the known dependencies for this type.
public Object	getEnclosingInstance() Implements com.google.inject.spi.ProvidesMethodBinding.getEnclosingInstance. Returns the instance of the object the method is defined in.
public Object	getInstance()
public Key<T>	getKey() Implements com.google.inject.spi.ProvidesMethodBinding.getKey. Returns the key of the binding.
public Method	getMethod() Implements com.google.inject.spi.ProvidesMethodBinding.getMethod. Returns the method this binding uses.
public int	hashCode() Overrides java.lang.Object.hashCode. Returns a hash code value for this object.
pack-priv void	initialize(InjectorImpl injector, Errors errors) Implements abstract com.google.inject.internal.InternalProviderInstanceBindingImpl.Factory.initialize. A callback that allows for implementations to fetch dependencies on other bindings.
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.

Inherited from com.google.inject.internal.InternalProviderInstanceBindingImpl.CyclicFactory:: get

Field Detail

annotation	back to summary
private final Annotation annotation

dependencies	back to summary
private final ImmutableSet<Dependency<?>> dependencies

exposed	back to summary
private final boolean exposed

instance	back to summary
protected final Object instance

key	back to summary
private final Key<T> key

method	back to summary
protected final Method method

parameterInjectors	back to summary
private SingleParameterInjector<?>[] parameterInjectors Set by `initialize(InjectorImpl, Errors)` so it is always available prior to injection.

scopeAnnotation	back to summary
private final Class<? extends Annotation> scopeAnnotation

Constructor Detail

ProviderMethod	back to summary
pack-priv ProviderMethod(Key<T> key, Method method, Object instance, ImmutableSet<Dependency<?>> dependencies, Class<? extends Annotation> scopeAnnotation, Annotation annotation) Parameters method:Method the method to invoke. Its return type must be the same type as `key`.

Method Detail

acceptExtensionVisitor	back to summary
public <B, V> V acceptExtensionVisitor(BindingTargetVisitor<B, V> visitor, ProviderInstanceBinding<? extends B> binding) Implements com.google.inject.spi.ProviderWithExtensionVisitor.acceptExtensionVisitor. Doc from com.google.inject.spi.ProviderWithExtensionVisitor.acceptExtensionVisitor. 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'. Annotations @Override @SuppressWarnings:unchecked

acceptExtensionVisitor

back to summary

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

Implements com.google.inject.spi.ProviderWithExtensionVisitor.acceptExtensionVisitor.

Doc from com.google.inject.spi.ProviderWithExtensionVisitor.acceptExtensionVisitor.

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'.

Annotations

@Override
@SuppressWarnings:unchecked

configure	back to summary
public void configure(Binder binder)

create back to summary

create	back to summary
pack-priv static <T> ProviderMethod<T> create(Key<T> key, Method method, Object instance, 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.

pack-priv static <T> ProviderMethod<T> create(Key<T> key, Method method, Object instance, 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.

doProvision	back to summary
protected T doProvision(InternalContext context, Dependency<?> dependency) throws InternalProvisionException Implements abstract com.google.inject.internal.InternalProviderInstanceBindingImpl.Factory.doProvision. Doc from com.google.inject.internal.InternalProviderInstanceBindingImpl.Factory.doProvision. Creates an object to be injected. Returns:T instance to be injected Annotations @Override Exceptions InternalProvisionException: if a value cannot be provided

doProvision

back to summary

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

Implements abstract com.google.inject.internal.InternalProviderInstanceBindingImpl.Factory.doProvision.

Doc from com.google.inject.internal.InternalProviderInstanceBindingImpl.Factory.doProvision.

Creates an object to be injected.

Returns:T

instance to be injected

Annotations

@Override

Exceptions

InternalProvisionException:: if a value cannot be provided

doProvision	back to summary
pack-priv abstract T doProvision(Object[] parameters) throws IllegalAccessException, InvocationTargetException Extension point for our subclasses to implement the provisioning strategy.

equals back to summary

equals	back 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

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

getAnnotation back to summary

getAnnotation	back to summary
public Annotation getAnnotation() Implements com.google.inject.spi.ProvidesMethodBinding.getAnnotation. Doc from com.google.inject.spi.ProvidesMethodBinding.getAnnotation. 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. Annotations @Override

public Annotation getAnnotation()

Implements com.google.inject.spi.ProvidesMethodBinding.getAnnotation.

Doc from com.google.inject.spi.ProvidesMethodBinding.getAnnotation.

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.

Annotations

@Override

getDependencies back to summary

getDependencies	back to summary
public Set<Dependency<?>> getDependencies() Implements com.google.inject.spi.HasDependencies.getDependencies. Doc from com.google.inject.spi.HasDependencies.getDependencies. 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. Returns:Set<Dependency<?>> a possibly empty set Annotations @Override

public Set<Dependency<?>> getDependencies()

Implements com.google.inject.spi.HasDependencies.getDependencies.

Doc from com.google.inject.spi.HasDependencies.getDependencies.

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.

Returns:Set<Dependency<?>>

a possibly empty set

Annotations

@Override

getEnclosingInstance	back to summary
public Object getEnclosingInstance() Implements com.google.inject.spi.ProvidesMethodBinding.getEnclosingInstance. Doc from com.google.inject.spi.ProvidesMethodBinding.getEnclosingInstance. Returns the instance of the object the method is defined in. Annotations @Override

getEnclosingInstance

back to summary

public Object getEnclosingInstance()

Implements com.google.inject.spi.ProvidesMethodBinding.getEnclosingInstance.

Doc from com.google.inject.spi.ProvidesMethodBinding.getEnclosingInstance.

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

Annotations

@Override

getInstance	back to summary
public Object getInstance()

getKey	back to summary
public Key<T> getKey() Implements com.google.inject.spi.ProvidesMethodBinding.getKey. Doc from com.google.inject.spi.ProvidesMethodBinding.getKey. Returns the key of the binding. Annotations @Override

getKey

back to summary

public Key<T> getKey()

Implements com.google.inject.spi.ProvidesMethodBinding.getKey.

Doc from com.google.inject.spi.ProvidesMethodBinding.getKey.

Returns the key of the binding.

Annotations

@Override

getMethod	back to summary
public Method getMethod() Implements com.google.inject.spi.ProvidesMethodBinding.getMethod. Doc from com.google.inject.spi.ProvidesMethodBinding.getMethod. Returns the method this binding uses. Annotations @Override

getMethod

back to summary

public Method getMethod()

Implements com.google.inject.spi.ProvidesMethodBinding.getMethod.

Doc from com.google.inject.spi.ProvidesMethodBinding.getMethod.

Returns the method this binding uses.

Annotations

@Override

hashCode back to summary

hashCode	back 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

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

initialize back to summary

initialize	back to summary
pack-priv void initialize(InjectorImpl injector, Errors errors) throws ErrorsException Implements abstract com.google.inject.internal.InternalProviderInstanceBindingImpl.Factory.initialize. Doc from com.google.inject.internal.InternalProviderInstanceBindingImpl.Factory.initialize. A callback that allows for implementations to fetch dependencies on other bindings. Will be called exactly once, prior to any call to `doProvision`. Annotations @Override

pack-priv void initialize(InjectorImpl injector, Errors errors) throws ErrorsException

Implements abstract com.google.inject.internal.InternalProviderInstanceBindingImpl.Factory.initialize.

Doc from com.google.inject.internal.InternalProviderInstanceBindingImpl.Factory.initialize.

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

Will be called exactly once, prior to any call to doProvision.

Annotations

@Override

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Doc from java.lang.Object.toString. Returns a string representation of the object. Returns:String a string representation of the object Annotations @Override

toString

back to summary

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object.

Returns:String

a string representation of the object

Annotations

@Override

Field Summary

Modifier and Type	Field and Description
pack-priv final BiFunction<Object, Object[], Object>	fastMethod

Inherited from com.google.inject.internal.ProviderMethod:: instance method

Constructor Summary

Access	Constructor and Description
pack-priv	FastClassProviderMethod(Key<T> key, Method method, Object instance, ImmutableSet<Dependency<?>> dependencies, Class<? extends Annotation> scopeAnnotation, Annotation annotation, BiFunction<Object, Object[], Object> fastMethod)

Method Summary

Modifier and Type	Method and Description
public T	doProvision(Object[] parameters) Implements abstract com.google.inject.internal.ProviderMethod.doProvision. Extension point for our subclasses to implement the provisioning strategy.

Inherited from com.google.inject.internal.ProviderMethod:: acceptExtensionVisitor configure create doProvision equals getAnnotation getDependencies getEnclosingInstance getInstance getKey getMethod hashCode initialize toString

Field Detail

fastMethod	back to summary
pack-priv final BiFunction<Object, Object[], Object> fastMethod

Constructor Detail

FastClassProviderMethod	back to summary
pack-priv FastClassProviderMethod(Key<T> key, Method method, Object instance, ImmutableSet<Dependency<?>> dependencies, Class<? extends Annotation> scopeAnnotation, Annotation annotation, BiFunction<Object, Object[], Object> fastMethod)

Method Detail

doProvision	back to summary
public T doProvision(Object[] parameters) throws InvocationTargetException Implements abstract com.google.inject.internal.ProviderMethod.doProvision. Doc from com.google.inject.internal.ProviderMethod.doProvision. Extension point for our subclasses to implement the provisioning strategy. Annotations @SuppressWarnings:unchecked @Override

doProvision

back to summary

public T doProvision(Object[] parameters) throws InvocationTargetException

Implements abstract com.google.inject.internal.ProviderMethod.doProvision.

Doc from com.google.inject.internal.ProviderMethod.doProvision.

Extension point for our subclasses to implement the provisioning strategy.

Annotations

@SuppressWarnings:unchecked
@Override

Constructor Summary

Access	Constructor and Description
pack-priv	ReflectionProviderMethod(Key<T> key, Method method, Object instance, ImmutableSet<Dependency<?>> dependencies, Class<? extends Annotation> scopeAnnotation, Annotation annotation)

Method Summary

Modifier and Type	Method and Description
pack-priv T	doProvision(Object[] parameters) Implements abstract com.google.inject.internal.ProviderMethod.doProvision. Extension point for our subclasses to implement the provisioning strategy.

Inherited from com.google.inject.internal.ProviderMethod:: acceptExtensionVisitor configure create doProvision equals getAnnotation getDependencies getEnclosingInstance getInstance getKey getMethod hashCode initialize toString

Constructor Detail

ReflectionProviderMethod	back to summary
pack-priv ReflectionProviderMethod(Key<T> key, Method method, Object instance, ImmutableSet<Dependency<?>> dependencies, Class<? extends Annotation> scopeAnnotation, Annotation annotation)

Method Detail

doProvision	back to summary
pack-priv T doProvision(Object[] parameters) throws IllegalAccessException, InvocationTargetException Implements abstract com.google.inject.internal.ProviderMethod.doProvision. Doc from com.google.inject.internal.ProviderMethod.doProvision. Extension point for our subclasses to implement the provisioning strategy. Annotations @SuppressWarnings:unchecked @Override

doProvision

back to summary

pack-priv T doProvision(Object[] parameters) throws IllegalAccessException, InvocationTargetException

Implements abstract com.google.inject.internal.ProviderMethod.doProvision.

Doc from com.google.inject.internal.ProviderMethod.doProvision.

Extension point for our subclasses to implement the provisioning strategy.

Annotations

@SuppressWarnings:unchecked
@Override

public abstract Class ProviderMethod<T>

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private final Class ProviderMethod.FastClassProviderMethod<T>

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private final Class ProviderMethod.ReflectionProviderMethod<T>

Field Summary

Constructor Summary

Method Summary

Constructor Detail

Method Detail