Interface Injector
Contains several default bindings:
- This
Injector
instance itself - A
Provider<T>
for each binding of typeT
- The
Logger
for the class being injected - The
Stage
in which the Injector was created
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.
Injectors can be hierarchical
. Child injectors inherit
the configuration of their parent injectors, but the converse does not hold.
The injector's internal bindings
are available for introspection. This
enables tools and extensions to operate on an injector reflectively.
- Author:
- crazybob@google.com (Bob Lee), jessewilson@google.com (Jesse Wilson)
-
Method Summary
Modifier and TypeMethodDescriptioncreateChildInjector
(Module... modules) Returns a new injector that inherits all state from this injector.createChildInjector
(Iterable<? extends Module> modules) Returns a new injector that inherits all state from this injector.findBindingsByType
(TypeLiteral<T> type) Returns all explicit bindings fortype
.Returns a snapshot of this injector's bindings, both explicit and just-in-time.Map
<TypeLiteral<?>, List<InjectionPoint>> Returns the injection points created for calls togetMembersInjector(com.google.inject.TypeLiteral<T>)
(either directly or indirectly, e.g.<T> Binding
<T> getBinding
(Key<T> key) Returns the binding for the given injection key.<T> Binding
<T> getBinding
(Class<T> type) Returns the binding for the given type.Returns this injector's explicit bindings.Returns the elements that make up this injector.<T> Binding
<T> getExistingBinding
(Key<T> key) Returns the binding if it already exists, or null if does not exist.<T> T
getInstance
(Key<T> key) Returns the appropriate instance for the given injection key; equivalent togetProvider(key).get()
.<T> T
getInstance
(Class<T> type) Returns the appropriate instance for the given injection type; equivalent togetProvider(type).get()
.<T> MembersInjector
<T> getMembersInjector
(TypeLiteral<T> typeLiteral) Returns the members injector used to inject dependencies into methods and fields on instances of the given typeT
.<T> MembersInjector
<T> getMembersInjector
(Class<T> type) Returns the members injector used to inject dependencies into methods and fields on instances of the given typeT
.Returns this injector's parent, ornull
if this is a top-level injector.<T> Provider
<T> getProvider
(Key<T> key) Returns the provider used to obtain instances for the given injection key.<T> Provider
<T> getProvider
(Class<T> type) Returns the provider used to obtain instances for the given type.Map
<Class<? extends Annotation>, Scope> Returns a map containing all scopes in the injector.Returns a set containing all type converter bindings in the injector.void
injectMembers
(Object instance) Injects dependencies into the fields and methods ofinstance
.
-
Method Details
-
injectMembers
Injects dependencies into the fields and methods ofinstance
. 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:
-
getMembersInjector
Returns the members injector used to inject dependencies into methods and fields on instances of the given typeT
.- Parameters:
typeLiteral
- type to get members injector for- Since:
- 2.0
- See Also:
-
getMembersInjector
Returns the members injector used to inject dependencies into methods and fields on instances of the given typeT
. When feasible, useBinder.getMembersInjector(TypeLiteral)
instead to get increased up front error detection.- Parameters:
type
- type to get members injector for- Since:
- 2.0
- See Also:
-
getBindings
Returns this injector's explicit bindings.The returned map does not include bindings inherited from a
parent injector
, should one exist. The returned map is guaranteed to iterate (for example, with itsMap.entrySet()
iterator) in the order of insertion. In other words, the order in which bindings appear in user Modules.This method is part of the Guice SPI and is intended for use by tools and extensions.
-
getAllBindings
Returns a snapshot of this injector's bindings, both explicit and just-in-time. The returned map is immutable; it contains only the bindings that were present whengetAllBindings()
was invoked. Just-in-time bindings are only present if they have been requested at least once. Subsequent calls may return a map with additional just-in-time bindings.The returned map does not include bindings inherited from a
parent injector
, should one exist.This method is part of the Guice SPI and is intended for use by tools and extensions.
- Since:
- 3.0
-
getBinding
Returns the binding for the given injection key. This will be an explicit bindings if the key was bound explicitly by a module, or an implicit binding otherwise. The implicit binding will be created if necessary.This method is part of the Guice SPI and is intended for use by tools and extensions.
- Throws:
ConfigurationException
- if this injector cannot find or create the binding.
-
getBinding
Returns the binding for the given type. This will be an explicit bindings if the injection key was bound explicitly by a module, or an implicit binding otherwise. The implicit binding will be created if necessary.This method is part of the Guice SPI and is intended for use by tools and extensions.
- Throws:
ConfigurationException
- if this injector cannot find or create the binding.- Since:
- 2.0
-
getExistingBinding
Returns the binding if it already exists, or null if does not exist. UnlikegetBinding(Key)
, this does not attempt to create just-in-time bindings for keys that aren't bound.This method is part of the Guice SPI and is intended for use by tools and extensions.
- Since:
- 3.0
-
findBindingsByType
Returns all explicit bindings fortype
.This method is part of the Guice SPI and is intended for use by tools and extensions.
-
getProvider
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:
-
getProvider
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:
-
getInstance
Returns the appropriate instance for the given injection key; equivalent togetProvider(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
Returns the appropriate instance for the given injection type; equivalent togetProvider(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.
-
getParent
Injector getParent()Returns this injector's parent, ornull
if this is a top-level injector.- Since:
- 2.0
-
createChildInjector
Returns a new injector that inherits all state from this injector. All bindings, scopes, interceptors and type converters are inherited -- they are visible to the child injector. Elements of the child injector are not visible to its parent.Just-in-time bindings created for child injectors will be created in an ancestor injector whenever possible. This allows for scoped instances to be shared between injectors. Use explicit bindings to prevent bindings from being shared with the parent injector. Optional injections in just-in-time bindings (created in the parent injector) may be silently ignored if the optional dependencies are from the child injector.
No key may be bound by both an injector and one of its ancestors. This includes just-in-time bindings. The lone exception is the key for
Injector.class
, which is bound by each injector to itself.- Since:
- 2.0
-
createChildInjector
Returns a new injector that inherits all state from this injector. All bindings, scopes, interceptors and type converters are inherited -- they are visible to the child injector. Elements of the child injector are not visible to its parent.Just-in-time bindings created for child injectors will be created in an ancestor injector whenever possible. This allows for scoped instances to be shared between injectors. Use explicit bindings to prevent bindings from being shared with the parent injector.
No key may be bound by both an injector and one of its ancestors. This includes just-in-time bindings. The lone exception is the key for
Injector.class
, which is bound by each injector to itself.- Since:
- 2.0
-
getScopeBindings
Map<Class<? extends Annotation>,Scope> getScopeBindings()Returns a map containing all scopes in the injector. The maps keys are scoping annotations likeSingleton.class
, and the values are scope instances, such asScopes.SINGLETON
. The returned map is immutable.This method is part of the Guice SPI and is intended for use by tools and extensions.
- Since:
- 3.0
-
getTypeConverterBindings
Set<TypeConverterBinding> getTypeConverterBindings()Returns a set containing all type converter bindings in the injector. The returned set is immutable.This method is part of the Guice SPI and is intended for use by tools and extensions.
- Since:
- 3.0
-
getElements
Returns the elements that make up this injector. Note that not all kinds of elements are returned.The returned list does not include elements inherited from a
parent injector
, should one exist.The returned list is immutable; it contains only the elements that were present when
getElements()
was invoked. Subsequent calls may return a list with additional elements.The returned list does not include data inherited from a
parent injector
, should one exist.This method is part of the Guice SPI and is intended for use by tools and extensions.
- Since:
- 4.2.3
-
getAllMembersInjectorInjectionPoints
Map<TypeLiteral<?>,List<InjectionPoint>> getAllMembersInjectorInjectionPoints()Returns the injection points created for calls togetMembersInjector(com.google.inject.TypeLiteral<T>)
(either directly or indirectly, e.g. throughinjectMembers(java.lang.Object)
.This excludes any injection points from elements (which are accessible from each element via the SPI), unless
getMembersInjector(com.google.inject.TypeLiteral<T>)
orinjectMembers(java.lang.Object)
were also called for the same key.The returned multimap does not include data inherited from a
parent injector
, should one exist.This method is part of the Guice SPI and is intended for use by tools and extensions.
- Since:
- 4.2.3
-