Top Description Methods
com.google.inject.spi

public Interface TypeEncounter<I>

Known Direct Implementers
com.google.inject.internal.EncounterImpl
Type Parameters
<I>
the injectable type encountered
Imports
com.google.inject.Key, .MembersInjector, .Provider, .TypeLiteral, com.google.inject.matcher.Matcher, java.lang.reflect.Method, org.aopalliance.intercept.MethodInterceptor
Context of an injectable type encounter. Enables reporting errors, registering injection listeners and binding method interceptors for injectable type I. It is an error to use an encounter after the hear() method has returned.
Since
2.0

Method Summary

Modifier and TypeMethod and Description
public void
addError(String message, Object... arguments)

Records an error message for type I which will be presented to the user at a later time.

public void
addError(Throwable t)

Records an exception for type I, the full details of which will be logged, and the message of which will be presented to the user at a later time.

public void
addError(Message message)

Records an error message to be presented to the user at a later time.

public void
bindInterceptor(Matcher<? super Method>
matches methods the interceptor should apply to. For example: annotatedWith(Transactional.class).
methodMatcher, MethodInterceptor...
to bind
interceptors)

Binds method interceptor[s] to methods matched in type I and its supertypes.

public <T> MembersInjector<T>
getMembersInjector(TypeLiteral<T>
type to get members injector for
typeLiteral)

Returns the members injector used to inject dependencies into methods and fields on instances of the given type T.

public <T> MembersInjector<T>
getMembersInjector(Class<T>
type to get members injector for
type)

Returns the members injector used to inject dependencies into methods and fields on instances of the given type T.

public <T> Provider<T>
getProvider(Key<T> key)

Returns the provider used to obtain instances for the given injection key.

public <T> Provider<T>
getProvider(Class<T> type)

Returns the provider used to obtain instances for the given injection type.

public void
register(MembersInjector<? super I> membersInjector)

Registers a members injector for type I.

public void
register(InjectionListener<? super I> listener)

Registers an injection listener for type I.

Method Detail

addErrorback to summary
public void addError(String message, Object... arguments)

Records an error message for type I which will be presented to the user at a later time. Unlike throwing an exception, this enable us to continue configuring the Injector and discover more errors. Uses String#format(String, Object[]) to insert the arguments into the message.

addErrorback to summary
public void addError(Throwable t)

Records an exception for type I, the full details of which will be logged, and the message of which will be presented to the user at a later time. If your type listener calls something that you worry may fail, you should catch the exception and pass it to this method.

addErrorback to summary
public void addError(Message message)

Records an error message to be presented to the user at a later time.

bindInterceptorback to summary
public void bindInterceptor(Matcher<? super Method> methodMatcher, MethodInterceptor... interceptors)

Binds method interceptor[s] to methods matched in type I and its supertypes. A method is eligible for interception if:

  • Guice created the instance the method is on
  • Neither the enclosing type nor the method is final
  • And the method is package-private or more accessible
Parameters
methodMatcher:Matcher<? super Method>

matches methods the interceptor should apply to. For example: annotatedWith(Transactional.class).

interceptors:MethodInterceptor[]

to bind

getMembersInjectorback to summary
public <T> MembersInjector<T> getMembersInjector(TypeLiteral<T> typeLiteral)

Returns the members injector used to inject dependencies into methods and fields on instances of the given type T. The returned members injector will not be valid until the main injector has been created. The members injector will throw an IllegalStateException if you try to use it beforehand.

Parameters
typeLiteral:TypeLiteral<T>

type to get members injector for

getMembersInjectorback to summary
public <T> MembersInjector<T> getMembersInjector(Class<T> type)

Returns the members injector used to inject dependencies into methods and fields on instances of the given type T. The returned members injector will not be valid until the main injector has been created. The members injector will throw an IllegalStateException if you try to use it beforehand.

Parameters
type:Class<T>

type to get members injector for

getProviderback to summary
public <T> Provider<T> getProvider(Key<T> key)

Returns the provider used to obtain instances for the given injection key. The returned provider will not be valid until the injector has been created. The provider will throw an IllegalStateException if you try to use it beforehand.

getProviderback to summary
public <T> Provider<T> getProvider(Class<T> type)

Returns the provider used to obtain instances for the given injection type. The returned provider will not be valid until the injector has been created. The provider will throw an IllegalStateException if you try to use it beforehand.

registerback to summary
public void register(MembersInjector<? super I> membersInjector)

Registers a members injector for type I. Guice will use the members injector after its performed its own injections on an instance of I.

registerback to summary
public void register(InjectionListener<? super I> listener)

Registers an injection listener for type I. Guice will notify the listener after all injections have been performed on an instance of I.