com.google.inject.spi

Class ModuleAnnotatedMethodScanner

java.lang.Object

com.google.inject.spi.ModuleAnnotatedMethodScanner

public abstract class ModuleAnnotatedMethodScanner
extends Object

Allows extensions to scan modules for annotated methods and bind those methods as providers, similar to @Provides methods.

Since:

4.0

Constructor Summary

Constructors

Constructor and Description
ModuleAnnotatedMethodScanner()

Method Summary

Modifier and Type	Method and Description
abstract Set<? extends Class<? extends Annotation>>	annotationClasses() Returns the annotations this should scan for.
abstract <T> Key<T>	prepareMethod(Binder binder, Annotation annotation, Key<T> key, InjectionPoint injectionPoint) Prepares a method for binding.

Methods inherited from class java.lang.Object

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

Constructor Detail

ModuleAnnotatedMethodScanner

public ModuleAnnotatedMethodScanner()

Method Detail

annotationClasses

public abstract Set<? extends Class<? extends Annotation>> annotationClasses()

Returns the annotations this should scan for. Every method in the module that has one of these annotations will create a Provider binding, with the return value of the binding being what's provided and the parameters of the method being dependencies of the provider.

prepareMethod

public abstract <T> Key<T> prepareMethod(Binder binder,
                                         Annotation annotation,
                                         Key<T> key,
                                         InjectionPoint injectionPoint)

Prepares a method for binding. This key parameter is the key discovered from looking at the binding annotation and return value of the method. Implementations can modify the key to instead bind to another key. For example, Multibinder may want to change @ProvidesIntoSet String provideFoo() to bind into a unique Key within the multibinder instead of binding String.

The injection point and annotation are provided in case the implementation wants to set the key based on the property of the annotation or if any additional preparation is needed for any of the dependencies. The annotation is guaranteed to be an instance of one the classes returned by annotationClasses().

If injectionPoint represents an abstract method, null must be returned from this method. This scanner can use binder to bind alternative bindings in place of the abstract method. In all other cases, this method may not return null.