OptionalBinder.RealOptionalBinder

java.lang.Object
- com.google.inject.multibindings.OptionalBinder<T>
- - com.google.inject.multibindings.OptionalBinder.RealOptionalBinder<T>

All Implemented Interfaces:

Module

Enclosing class:

OptionalBinder<T>
```
static final class OptionalBinder.RealOptionalBinder<T>
extends OptionalBinder<T>
implements Module
```
The actual OptionalBinder plays several roles. It implements Module to hide that fact from the public API, and installs the various bindings that are exposed to the user.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`(package private) class`	`OptionalBinder.RealOptionalBinder.JavaOptionalProvider`
`(package private) class`	`OptionalBinder.RealOptionalBinder.JavaOptionalProviderProvider`
`(package private) class`	`OptionalBinder.RealOptionalBinder.RealDirectTypeProvider`
`private static class`	`OptionalBinder.RealOptionalBinder.RealOptionalBinderProviderWithDependencies<T>` A base class for ProviderWithDependencies that need equality based on a specific object.
`(package private) class`	`OptionalBinder.RealOptionalBinder.RealOptionalKeyProvider`
`(package private) class`	`OptionalBinder.RealOptionalBinder.RealOptionalProviderProvider`

Nested classes/interfaces inherited from class com.google.inject.multibindings.OptionalBinder
OptionalBinder.Actual, OptionalBinder.ActualImpl, OptionalBinder.BaseAnnotation, OptionalBinder.Default, OptionalBinder.DefaultImpl, OptionalBinder.RealOptionalBinder<T>, OptionalBinder.Source

Field Summary

Fields
Modifier and Type	Field and Description
`private Binding<T>`	`actualBinding` the actual binding, for the SPI
`private Key<T>`	`actualKey`
`private Binder`	`binder` the target injector's binder.
`private Binding<T>`	`defaultBinding` the default binding, for the SPI.
`private Key<T>`	`defaultKey`
`private java.util.Set<Dependency<?>>`	`dependencies` the dependencies -- initialized with defaults & overridden when tooled.
`private Key`	`javaOptionalJavaxProviderKey`
`private Key`	`javaOptionalKey`
`private Key`	`javaOptionalProviderKey`
`private Key<com.google.common.base.Optional<javax.inject.Provider<T>>>`	`optionalJavaxProviderKey`
`private Key<com.google.common.base.Optional<T>>`	`optionalKey`
`private Key<com.google.common.base.Optional<Provider<T>>>`	`optionalProviderKey`
`private Provider<com.google.common.base.Optional<Provider<T>>>`	`optionalProviderT`
`private java.util.Set<Dependency<?>>`	`providerDependencies` the dependencies -- initialized with defaults & overridden when tooled.
`private Key<T>`	`typeKey`

Constructor Summary

Constructors
Modifier Constructor and Description

private RealOptionalBinder(Binder binder, Key<T> typeKey)

Constructors
Modifier	Constructor and Description
`private`	`RealOptionalBinder(Binder binder, Key<T> typeKey)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`private void`	`addDirectTypeBinding(Binder binder)` Adds a binding for T.
`private void`	`bindJava8Optional(Binder binder)`
`void`	`configure(Binder binder)` Contributes bindings and other configurations for this module to `binder`.
`private boolean`	`containsElement(Element element)`
`boolean`	`equals(java.lang.Object o)`
`private Binding<?>`	`getActualBinding()`
`private Binding<?>`	`getDefaultBinding()`
`(package private) Key<T>`	`getKeyForActualBinding()`
`(package private) Key<T>`	`getKeyForDefaultBinding()`
`int`	`hashCode()`
`private boolean`	`isInitialized()`
`private boolean`	`matchesJ8Keys(Key<?> elementKey)`
`private boolean`	`matchesTypeKey(Element element, Key<?> elementKey)` Returns true if the key & element indicate they were bound by this OptionalBinder.
`LinkedBindingBuilder<T>`	`setBinding()` Returns a binding builder used to set the actual value that will be injected.
`LinkedBindingBuilder<T>`	`setDefault()` Returns a binding builder used to set the default value that will be injected.

Methods inherited from class com.google.inject.multibindings.OptionalBinder
javaOptionalOf, javaOptionalOfJavaxProvider, javaOptionalOfProvider, newOptionalBinder, newOptionalBinder, newOptionalBinder, newRealOptionalBinder, optionalOf, optionalOfJavaxProvider, optionalOfProvider, providerOf

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - typeKey
```
private final Key<T> typeKey
```
  - optionalKey
```
private final Key<com.google.common.base.Optional<T>> optionalKey
```
  - optionalJavaxProviderKey
```
private final Key<com.google.common.base.Optional<javax.inject.Provider<T>>> optionalJavaxProviderKey
```
  - optionalProviderKey
```
private final Key<com.google.common.base.Optional<Provider<T>>> optionalProviderKey
```
  - optionalProviderT
```
private final Provider<com.google.common.base.Optional<Provider<T>>> optionalProviderT
```
  - defaultKey
```
private final Key<T> defaultKey
```
  - actualKey
```
private final Key<T> actualKey
```
  - javaOptionalKey
```
private final Key javaOptionalKey
```
  - javaOptionalJavaxProviderKey
```
private final Key javaOptionalJavaxProviderKey
```
  - javaOptionalProviderKey
```
private final Key javaOptionalProviderKey
```
  - binder
```
private Binder binder
```
    the target injector's binder. non-null until initialization, null afterwards
  - defaultBinding
```
private Binding<T> defaultBinding
```
    the default binding, for the SPI.
  - actualBinding
```
private Binding<T> actualBinding
```
    the actual binding, for the SPI
  - dependencies
```
private java.util.Set<Dependency<?>> dependencies
```
    the dependencies -- initialized with defaults & overridden when tooled.
  - providerDependencies
```
private java.util.Set<Dependency<?>> providerDependencies
```
    the dependencies -- initialized with defaults & overridden when tooled.
- Constructor Detail
  - RealOptionalBinder
```
private RealOptionalBinder(Binder binder,
                           Key<T> typeKey)
```
- Method Detail
  - addDirectTypeBinding
```
private void addDirectTypeBinding(Binder binder)
```
    Adds a binding for T. Multiple calls to this are safe, and will be collapsed as duplicate bindings.
  - getKeyForDefaultBinding
```
Key<T> getKeyForDefaultBinding()
```
  - setDefault
```
public LinkedBindingBuilder<T> setDefault()
```
    Description copied from class: OptionalBinder
    
    Returns a binding builder used to set the default value that will be injected. The binding set by this method will be ignored if OptionalBinder.setBinding() is called.
    It is an error to call this method without also calling one of the to methods on the returned binding builder.
    
    Specified by:
    
    setDefault in class OptionalBinder<T>
  - getKeyForActualBinding
```
Key<T> getKeyForActualBinding()
```
  - setBinding
```
public LinkedBindingBuilder<T> setBinding()
```
    Description copied from class: OptionalBinder
    
    Returns a binding builder used to set the actual value that will be injected. This overrides any binding set by OptionalBinder.setDefault().
    It is an error to call this method without also calling one of the to methods on the returned binding builder.
    
    Specified by:
    
    setBinding in class OptionalBinder<T>
  - 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
  - bindJava8Optional
```
private void bindJava8Optional(Binder binder)
```
  - getActualBinding
```
private Binding<?> getActualBinding()
```
  - getDefaultBinding
```
private Binding<?> getDefaultBinding()
```
  - containsElement
```
private boolean containsElement(Element element)
```
  - matchesJ8Keys
```
private boolean matchesJ8Keys(Key<?> elementKey)
```
  - matchesTypeKey
```
private boolean matchesTypeKey(Element element,
                               Key<?> elementKey)
```
    Returns true if the key & element indicate they were bound by this OptionalBinder.
  - isInitialized
```
private boolean isInitialized()
```
  - equals
```
public boolean equals(java.lang.Object o)
```
    Overrides:
    
    equals in class java.lang.Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object

Class OptionalBinder.RealOptionalBinder<T>

Nested Class Summary

Nested classes/interfaces inherited from class com.google.inject.multibindings.OptionalBinder

Field Summary

Constructor Summary

Method Summary

Methods inherited from class com.google.inject.multibindings.OptionalBinder

Methods inherited from class java.lang.Object

Field Detail

typeKey

optionalKey

optionalJavaxProviderKey

optionalProviderKey

optionalProviderT

defaultKey

actualKey

javaOptionalKey

javaOptionalJavaxProviderKey

javaOptionalProviderKey

binder

defaultBinding

actualBinding

dependencies

providerDependencies

Constructor Detail

RealOptionalBinder

Method Detail

addDirectTypeBinding

getKeyForDefaultBinding

setDefault

getKeyForActualBinding

setBinding

configure

bindJava8Optional

getActualBinding

getDefaultBinding

containsElement

matchesJ8Keys

matchesTypeKey

isInitialized

equals

hashCode