public interface

TypeEncounter

com.google.inject.spi.TypeEncounter<I>

Class Overview

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.

Summary

Public Methods
abstract void addError(String message, Object... arguments)
Records an error message for type I which will be presented to the user at a later time.
abstract 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.
abstract void addError(Message message)
Records an error message to be presented to the user at a later time.
abstract void bindInterceptor(Matcher<? super Method> methodMatcher, MethodInterceptor... interceptors)
Binds method interceptor[s] to methods matched in type I and its supertypes.
abstract <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.
abstract <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.
abstract <T> Provider<T> getProvider(Key<T> key)
Returns the provider used to obtain instances for the given injection key.
abstract <T> Provider<T> getProvider(Class<T> type)
Returns the provider used to obtain instances for the given injection type.
abstract void register(InjectionListener<? super I> listener)
Registers an injection listener for type I.
abstract void register(MembersInjector<? super I> membersInjector)
Registers a members injector for type I.

Public Methods

public abstract 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 format(String, Object[]) to insert the arguments into the message.

public abstract 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.

public abstract void addError (Message message)

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

public abstract 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 matches methods the interceptor should apply to. For example: annotatedWith(Transactional.class).
interceptors to bind

public abstract 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 type to get members injector for

public abstract 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 type to get members injector for

public abstract 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.

public abstract 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 injetor has been created. The provider will throw an IllegalStateException if you try to use it beforehand.

public abstract 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.

public abstract 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.