Package org.elasticsearch.common.inject

Interface Injector

public interface Injector
Builds the graphs of objects that make up your application. The injector tracks the dependencies for each type and uses bindings to inject them. This is the core of Guice, although you rarely interact with it directly. This "behind-the-scenes" operation is what distinguishes dependency injection from its cousin, the service locator pattern.

Contains several default bindings:

  • This Injector instance itself
  • A Provider<T> for each binding of type T
  • The Logger for the class being injected
  • The Stage in which the Injector was created

Injectors are created using the facade class Guice.

An injector can also inject the dependencies of already-constructed instances. This can be used to interoperate with objects created by other frameworks or services.

  • Method Summary

    Modifier and Type
    Method
    Description
    <T> List<Binding<T>>
    findBindingsByType(TypeLiteral<T> type)
    Returns all explicit bindings for type.
    <T> T
    getInstance(Class<T> type)
    Returns the appropriate instance for the given injection type; equivalent to getProvider(type).get().
    <T> T
    getInstance(Key<T> key)
    Returns the appropriate instance for the given injection key; equivalent to getProvider(key).get().
    <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.
    <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.
    <T> Provider<T>
    getProvider(Class<T> type)
    Returns the provider used to obtain instances for the given type.
    <T> Provider<T>
    getProvider(Key<T> key)
    Returns the provider used to obtain instances for the given injection key.
    void
    injectMembers(Object instance)
    Injects dependencies into the fields and methods of instance.

  • Method Details

    • injectMembers

      void injectMembers(Object instance)
      Injects dependencies into the fields and methods of instance. Ignores the presence or absence of an injectable constructor.

      Whenever Guice creates an instance, it performs this injection automatically (after first performing constructor injection), so if you're able to let Guice create all your objects for you, you'll never need to use this method.

      Parameters:
      instance - to inject members on
      See Also:
      for a preferred alternative that supports checks before run time

    • getMembersInjector

      <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.
      Parameters:
      typeLiteral - type to get members injector for
      Since:
      2.0
      See Also:
      for an alternative that offers up front error detection

    • getMembersInjector

      <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. When feasible, use Binder.getMembersInjector(TypeLiteral) instead to get increased up front error detection.
      Parameters:
      type - type to get members injector for
      Since:
      2.0
      See Also:
      for an alternative that offers up front error detection

    • findBindingsByType

      <T> List<Binding<T>> findBindingsByType(TypeLiteral<T> type)
      Returns all explicit bindings for type.

      This method is part of the Guice SPI and is intended for use by tools and extensions.

    • getProvider

      <T> Provider<T> getProvider(Key<T> key)
      Returns the provider used to obtain instances for the given injection key. When feasible, avoid using this method, in favor of having Guice inject your dependencies ahead of time.
      Throws:
      ConfigurationException - if this injector cannot find or create the provider.
      See Also:
      for an alternative that offers up front error detection

    • getProvider

      <T> Provider<T> getProvider(Class<T> type)
      Returns the provider used to obtain instances for the given type. When feasible, avoid using this method, in favor of having Guice inject your dependencies ahead of time.
      Throws:
      ConfigurationException - if this injector cannot find or create the provider.
      See Also:
      for an alternative that offers up front error detection

    • getInstance

      <T> T getInstance(Key<T> key)
      Returns the appropriate instance for the given injection key; equivalent to getProvider(key).get(). When feasible, avoid using this method, in favor of having Guice inject your dependencies ahead of time.
      Throws:
      ConfigurationException - if this injector cannot find or create the provider.
      ProvisionException - if there was a runtime failure while providing an instance.

    • getInstance

      <T> T getInstance(Class<T> type)
      Returns the appropriate instance for the given injection type; equivalent to getProvider(type).get(). When feasible, avoid using this method, in favor of having Guice inject your dependencies ahead of time.
      Throws:
      ConfigurationException - if this injector cannot find or create the provider.
      ProvisionException - if there was a runtime failure while providing an instance.