Package com.google.inject.internal

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.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private static class	RealMultibinder.BaseFactory<ValueT,ProvidedT>	Base implement of InternalProviderInstanceBindingImpl.Factory that works based on a RealMultibinder.BindingSelection, allowing provider instances for various bindings to be implemented with less duplication.
private static final class	RealMultibinder.BindingSelection<T>
private static final class	RealMultibinder.ExtensionRealMultibinderProvider<T>	Implementation of BaseFactory that exposes details about the multibinder through the extension SPI.
private static class	RealMultibinder.PermitDuplicatesModule	We install the permit duplicates configuration as its own binding, all by itself.
private static final class	RealMultibinder.RealMultibinderCollectionOfProvidersProvider<T>	Implementation of BaseFactory that exposes a collection of providers of the values in the set.
private static final class	RealMultibinder.RealMultibinderProvider<T>	Provider instance implementation that provides the actual set of values.

Field Summary

Fields

Modifier and Type	Field	Description
private final Binder	binder
private final RealMultibinder.BindingSelection<T>	bindingSelection

Constructor Summary

Constructors

Constructor	Description
RealMultibinder(Binder binder, Key<T> key)

Method Summary

Modifier and Type	Method	Description
LinkedBindingBuilder<T>	addBinding()
(package private) static <T> TypeLiteral<Collection<javax.inject.Provider<T>>>	collectionOfJavaxProvidersOf(TypeLiteral<T> elementType)
(package private) static <T> TypeLiteral<Collection<Provider<T>>>	collectionOfProvidersOf(TypeLiteral<T> elementType)
void	configure(Binder binder)	Contributes bindings and other configurations for this module to binder.
(package private) boolean	containsElement(Element element)
boolean	equals(Object o)
(package private) TypeLiteral<T>	getElementTypeLiteral()
(package private) Key<T>	getKeyForNewItem()	Adds a new entry to the set and returns the key for it.
(package private) Key<Set<T>>	getSetKey()
(package private) String	getSetName()
int	hashCode()
static <T> RealMultibinder<T>	newRealSetBinder(Binder binder, Key<T> key)	Implementation of newSetBinder.
void	permitDuplicates()
(package private) boolean	permitsDuplicates(Injector injector)
(package private) static <T> TypeLiteral<Set<T>>	setOf(TypeLiteral<T> elementType)
(package private) static <T> TypeLiteral<Set<? extends T>>	setOfExtendsOf(TypeLiteral<T> elementType)

Methods inherited from class java.lang.Object

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

Field Details

bindingSelection

private final RealMultibinder.BindingSelection<T> bindingSelection

binder

private final Binder binder

Constructor Details

RealMultibinder

RealMultibinder(Binder binder,
 Key<T> key)

Method Details

newRealSetBinder

public static <T> RealMultibinder<T> newRealSetBinder(Binder binder,
 Key<T> key)

Implementation of newSetBinder.

setOf

static <T> TypeLiteral<Set<T>> setOf(TypeLiteral<T> elementType)

collectionOfProvidersOf

static <T> TypeLiteral<Collection<Provider<T>>> collectionOfProvidersOf(TypeLiteral<T> elementType)

collectionOfJavaxProvidersOf

static <T>
TypeLiteral<Collection<javax.inject.Provider<T>>> collectionOfJavaxProvidersOf(TypeLiteral<T> elementType)

setOfExtendsOf

static <T> TypeLiteral<Set<? extends T>> setOfExtendsOf(TypeLiteral<T> elementType)

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()

getKeyForNewItem

Key<T> getKeyForNewItem()

Adds a new entry to the set and returns the key for it.

addBinding

public LinkedBindingBuilder<T> addBinding()

getSetKey

Key<Set<T>> getSetKey()

getElementTypeLiteral

TypeLiteral<T> getElementTypeLiteral()

getSetName

String getSetName()

permitsDuplicates

boolean permitsDuplicates(Injector injector)

containsElement

boolean containsElement(Element element)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object