Class RealMultibinder<T>

java.lang.Object
com.google.inject.internal.RealMultibinder<T>
All Implemented Interfaces:
Module

public final class RealMultibinder<T> extends Object implements Module
The actual multibinder plays several roles:

As a Multibinder, it acts as a factory for LinkedBindingBuilders for each of the set's elements. Each binding is given an annotation that identifies it as a part of this set.

As a Module, it installs the binding to the set itself. As a module, this implements equals() and hashcode() in order to trick Guice into executing its configure() method only once. That makes it so that multiple multibinders can be created for the same target collection, but only one is bound. Since the list of bindings is retrieved from the injector itself (and not the multibinder), each multibinder has access to all contributions from all multibinders.

As a Provider, this constructs the set instances.

We use a subclass to hide 'implements Module, Provider' from the public API.

  • Method Details

    • newRealSetBinder

      public static <T> RealMultibinder<T> newRealSetBinder(Binder binder, Key<T> key)
      Implementation of newSetBinder.
    • configure

      public void configure(Binder binder)
      Description copied from interface: Module
      Contributes bindings and other configurations for this module to binder.

      Do not invoke this method directly to install submodules. Instead use Binder.install(Module), which ensures that provider methods are discovered.

      Specified by:
      configure in interface Module
    • permitDuplicates

      public void permitDuplicates()
    • addBinding

      public LinkedBindingBuilder<T> addBinding()
    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object
    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object