Uses of Class
com.google.inject.Key
-
Packages that use Key Package Description com.google.inject Google Guice (pronounced "juice") is an ultra-lightweight dependency injection framework.com.google.inject.binder Interfaces which make upBinder
's expression language.com.google.inject.internal Guice (sounds like "juice")com.google.inject.multibindings Extension for binding multiple instances in a collection; this extension requiresguice-multibindings.jar
.com.google.inject.spi Guice service provider interface -
-
Uses of Key in com.google.inject
Methods in com.google.inject that return Key Modifier and Type Method Description static <T> Key<T>
Key. get(TypeLiteral<T> typeLiteral)
Gets a key for an injection type.static <T> Key<T>
Key. get(TypeLiteral<T> typeLiteral, java.lang.annotation.Annotation annotation)
Gets a key for an injection type and an annotation.static <T> Key<T>
Key. get(TypeLiteral<T> typeLiteral, java.lang.Class<? extends java.lang.annotation.Annotation> annotationType)
Gets a key for an injection type and an annotation type.static <T> Key<T>
Key. get(java.lang.Class<T> type)
Gets a key for an injection type.static <T> Key<T>
Key. get(java.lang.Class<T> type, java.lang.annotation.Annotation annotation)
Gets a key for an injection type and an annotation.static <T> Key<T>
Key. get(java.lang.Class<T> type, java.lang.Class<? extends java.lang.annotation.Annotation> annotationType)
Gets a key for an injection type and an annotation type.static Key<?>
Key. get(java.lang.reflect.Type type)
Gets a key for an injection type.static Key<?>
Key. get(java.lang.reflect.Type type, java.lang.annotation.Annotation annotation)
Gets a key for an injection type and an annotation.static Key<?>
Key. get(java.lang.reflect.Type type, java.lang.Class<? extends java.lang.annotation.Annotation> annotationType)
Gets a key for an injection type and an annotation type.Key<T>
Binding. getKey()
Returns the key for this binding.<U> Key<U>
Key. ofType(TypeLiteral<U> type)
Returns a new key of the specified type with the same annotation as this key.<U> Key<U>
Key. ofType(java.lang.Class<U> type)
Returns a new key of the specified type with the same annotation as this key.Key<?>
Key. ofType(java.lang.reflect.Type type)
Returns a new key of the specified type with the same annotation as this key.Key<T>
Key. withAnnotation(java.lang.annotation.Annotation annotation)
Returns a new key of the same type with the specified annotation.Key<T>
Key. withAnnotation(java.lang.Class<? extends java.lang.annotation.Annotation> annotationType)
Returns a new key of the same type with the specified annotation.Key<T>
Key. withoutAttributes()
Returns this key without annotation attributes, i.e.Methods in com.google.inject that return types with arguments of type Key Modifier and Type Method Description java.util.Map<Key<?>,Binding<?>>
Injector. getAllBindings()
Returns a snapshot of this injector's bindings, both explicit and just-in-time.java.util.Map<Key<?>,Binding<?>>
Injector. getBindings()
Returns this injector's explicit bindings.Methods in com.google.inject with parameters of type Key Modifier and Type Method Description protected <T> LinkedBindingBuilder<T>
AbstractModule. bind(Key<T> key)
<T> LinkedBindingBuilder<T>
Binder. bind(Key<T> key)
See the EDSL examples atBinder
.protected <T> LinkedBindingBuilder<T>
PrivateModule. bind(Key<T> key)
void
PrivateBinder. expose(Key<?> key)
Makes the binding forkey
available to the enclosing environmentprotected <T> void
PrivateModule. expose(Key<T> key)
Makes the binding forkey
available to other modules and the injector.<T> Binding<T>
Injector. getBinding(Key<T> key)
Returns the binding for the given injection key.<T> Binding<T>
Injector. getExistingBinding(Key<T> key)
Returns the binding if it already exists, or null if does not exist.<T> T
Injector. getInstance(Key<T> key)
Returns the appropriate instance for the given injection key; equivalent togetProvider(key).get()
.protected <T> Provider<T>
AbstractModule. getProvider(Key<T> key)
<T> Provider<T>
Binder. getProvider(Key<T> key)
Returns the provider used to obtain instances for the given injection key.<T> Provider<T>
Injector. getProvider(Key<T> key)
Returns the provider used to obtain instances for the given injection key.protected <T> Provider<T>
PrivateModule. getProvider(Key<T> key)
protected void
AbstractModule. requireBinding(Key<?> key)
Adds a dependency from this module tokey
.protected void
PrivateModule. requireBinding(Key<?> key)
Instructs Guice to require a binding to the given key.<T> Provider<T>
Scope. scope(Key<T> key, Provider<T> unscoped)
Scopes a provider. -
Uses of Key in com.google.inject.binder
Methods in com.google.inject.binder with parameters of type Key Modifier and Type Method Description ScopedBindingBuilder
LinkedBindingBuilder. to(Key<? extends T> targetKey)
See the EDSL examples atBinder
.ScopedBindingBuilder
LinkedBindingBuilder. toProvider(Key<? extends javax.inject.Provider<? extends T>> providerKey)
See the EDSL examples atBinder
. -
Uses of Key in com.google.inject.internal
Fields in com.google.inject.internal declared as Key Modifier and Type Field Description protected static Key<?>
AbstractBindingBuilder. NULL_KEY
Methods in com.google.inject.internal that return Key Modifier and Type Method Description static <T> Key<T>
MoreTypes. canonicalizeKey(Key<T> key)
Returns a key that doesn't hold any references to parent classes.static Key<?>
Annotations. getKey(TypeLiteral<?> type, java.lang.reflect.Member member, java.lang.annotation.Annotation[] annotations, Errors errors)
Gets a key for the given type, member and annotations.Key<T>
BindingImpl. getKey()
Key<?>
ExposureBuilder. getKey()
Key<T>
ProviderMethod. getKey()
Methods in com.google.inject.internal that return types with arguments of type Key Modifier and Type Method Description java.util.Set<Key<?>>
PrivateElementsImpl. getExposedKeys()
Methods in com.google.inject.internal with parameters of type Key Modifier and Type Method Description Errors
Errors. bindingAlreadySet(Key<?> key, java.lang.Object source)
static <T> Key<T>
MoreTypes. canonicalizeKey(Key<T> key)
Returns a key that doesn't hold any references to parent classes.Errors
Errors. childBindingAlreadySet(Key<?> key, java.util.Set<java.lang.Object> sources)
<K,V>
ErrorsErrors. duplicateMapKey(Key<java.util.Map<K,V>> mapKey, com.google.common.collect.Multimap<K,Binding<V>> duplicates)
Errors
Errors. errorCheckingDuplicateBinding(Key<?> key, java.lang.Object source, java.lang.Throwable t)
Errors
Errors. exposedButNotBound(Key<?> key)
java.lang.Object
PrivateElementsImpl. getExposedSource(Key<?> key)
Errors
Errors. jitBindingAlreadySet(Key<?> key)
Errors
Errors. jitDisabled(Key<?> key)
static InternalProvisionException
InternalProvisionException. jitDisabled(Key<?> key)
Errors
Errors. jitDisabledInParent(Key<?> key)
Errors
Errors. missingImplementation(Key<?> key)
We use a fairly generic error message here.static java.lang.String
Annotations. nameOf(Key<?> key)
Returns the name the binding should use.static <T> RealOptionalBinder<T>
RealOptionalBinder. newRealOptionalBinder(Binder binder, Key<T> type)
static <T> RealMultibinder<T>
RealMultibinder. newRealSetBinder(Binder binder, Key<T> key)
Implementation of newSetBinder.Errors
Errors. recursiveBinding(Key<?> key, Key<?> linkedKey)
<T> Provider<T>
SingletonScope. scope(Key<T> key, Provider<T> creator)
Provides singleton scope with the following properties: creates no more than one instance per Key as a creator is used no more than once result is cached and returned quickly on subsequent calls exception in a creator is not treated as instance creation and is not cached creates singletons in parallel whenever possible waits for dependent singletons to be created even across threads and when dependencies are shared as long as no circular dependencies are detected returns circular proxy only when circular dependencies are detected aside from that, blocking synchronization is only used for proxy creation and initializationBindingBuilder<T>
BindingBuilder. to(Key<? extends T> linkedKey)
BindingBuilder<T>
BindingBuilder. toProvider(Key<? extends javax.inject.Provider<? extends T>> providerKey)
protected BindingImpl<T>
BindingImpl. withKey(Key<T> key)
Constructors in com.google.inject.internal with parameters of type Key Constructor Description AbstractBindingBuilder(Binder binder, java.util.List<Element> elements, java.lang.Object source, Key<T> key)
BindingBuilder(Binder binder, java.util.List<Element> elements, java.lang.Object source, Key<T> key)
ExposureBuilder(Binder binder, java.lang.Object source, Key<T> key)
-
Uses of Key in com.google.inject.multibindings
Methods in com.google.inject.multibindings that return Key Modifier and Type Method Description Key<T>
OptionalBinderBinding. getKey()
Returns theKey
for this binding.Key<T>
MapBinderBinding. getMapKey()
Returns theKey
for the map.Key<T>
MultibinderBinding. getSetKey()
Returns the key for the set.Methods in com.google.inject.multibindings that return types with arguments of type Key Modifier and Type Method Description java.util.Set<Key<?>>
OptionalBinderBinding. getAlternateKeys()
Returns the keys of other bindings that represent this OptionalBinder.java.util.Set<Key<?>>
MapBinderBinding. getAlternateMapKeys()
Returns the keys of other bindings that represent this map.java.util.Set<Key<?>>
MultibinderBinding. getAlternateSetKeys()
Returns the keys of other bindings that represent this set.Methods in com.google.inject.multibindings with parameters of type Key Modifier and Type Method Description static <T> OptionalBinder<T>
OptionalBinder. newOptionalBinder(Binder binder, Key<T> type)
static <T> Multibinder<T>
Multibinder. newSetBinder(Binder binder, Key<T> key)
Returns a new multibinder that collects instances of the key's type in aSet
that is itself bound with the annotation (if any) of the key. -
Uses of Key in com.google.inject.spi
Methods in com.google.inject.spi that return Key Modifier and Type Method Description Key<T>
Dependency. getKey()
Returns the key to the binding that satisfies this dependency.Key<T>
ProviderLookup. getKey()
Key<T>
ProvidesMethodBinding. getKey()
Returns the key of the binding.Key<? extends T>
LinkedKeyBinding. getLinkedKey()
Returns the linked key used to resolve injections.Key<?>
ProviderBinding. getProvidedKey()
Returns the key whose binding is used toprovide instances
.Key<? extends javax.inject.Provider<? extends T>>
ProviderKeyBinding. getProviderKey()
Returns the key used to resolve the provider's binding.Key<java.lang.String>
ConvertedConstantBinding. getSourceKey()
Returns the key for the source binding.abstract <T> Key<T>
ModuleAnnotatedMethodScanner. prepareMethod(Binder binder, java.lang.annotation.Annotation annotation, Key<T> key, InjectionPoint injectionPoint)
Prepares a method for binding.Methods in com.google.inject.spi that return types with arguments of type Key Modifier and Type Method Description java.util.Set<Key<?>>
PrivateElements. getExposedKeys()
Returns the unique exposed keys for these private elements.Methods in com.google.inject.spi with parameters of type Key Modifier and Type Method Description static <T> Dependency<T>
Dependency. get(Key<T> key)
Returns a new dependency that is not attached to an injection point.java.lang.Object
PrivateElements. getExposedSource(Key<?> key)
Returns an arbitrary object containing information about the "place" where this key was exposed.static java.util.Optional<java.lang.String>
BindingSourceRestriction. getMissingImplementationSuggestion(GuiceInternal guiceInternal, Key<?> key)
Returns a suggestion for how a restricted binding should be created in case it's missing.<T> Provider<T>
TypeEncounter. getProvider(Key<T> key)
Returns the provider used to obtain instances for the given injection key.abstract <T> Key<T>
ModuleAnnotatedMethodScanner. prepareMethod(Binder binder, java.lang.annotation.Annotation annotation, Key<T> key, InjectionPoint injectionPoint)
Prepares a method for binding.Constructors in com.google.inject.spi with parameters of type Key Constructor Description ProviderLookup(java.lang.Object source, Key<T> key)
-