com.google.inject.multibindings

Class OptionalBinder.RealOptionalBinder.JavaOptionalProvider

java.lang.Object

com.google.inject.multibindings.OptionalBinder.RealOptionalBinder.RealOptionalBinderProviderWithDependencies

com.google.inject.multibindings.OptionalBinder.RealOptionalBinder.JavaOptionalProvider

All Implemented Interfaces:

OptionalBinderBinding, HasDependencies, ProviderWithDependencies, ProviderWithExtensionVisitor, javax.inject.Provider

Enclosing class:

OptionalBinder.RealOptionalBinder<T>

final class OptionalBinder.RealOptionalBinder.JavaOptionalProvider
extends OptionalBinder.RealOptionalBinder.RealOptionalBinderProviderWithDependencies
implements ProviderWithExtensionVisitor, OptionalBinderBinding

Constructor Summary

Constructors

Modifier	Constructor and Description
private	JavaOptionalProvider()

Method Summary

Modifier and Type	Method and Description
java.lang.Object	acceptExtensionVisitor(BindingTargetVisitor visitor, ProviderInstanceBinding binding) Instructs the extension determine if the visitor is an instance of a custom extension visitor, and if so, visit it using that method.
boolean	containsElement(Element element) Returns true if this OptionalBinder contains the given Element in order to build the optional binding or uses the given Element in order to support building and injecting its data.
java.lang.Object	get() Provides an instance of T.
Binding	getActualBinding() Returns the actual binding (set by OptionalBinder.setBinding()) or null if not set.
Binding	getDefaultBinding() Returns the default binding (set by OptionalBinder.setDefault()) if one exists or null if no default binding is set.
java.util.Set<Dependency<?>>	getDependencies() Returns the known dependencies for this type.
Key	getKey() Returns the Key for this binding.

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

equals, hashCode

Methods inherited from class java.lang.Object

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

Constructor Detail

JavaOptionalProvider

private JavaOptionalProvider()

Method Detail

get

public java.lang.Object get()

Description copied from interface: Provider

Provides an instance of T. Must never return null.

Specified by:

get in interface javax.inject.Provider

getDependencies

public java.util.Set<Dependency<?>> getDependencies()

Description copied from interface: HasDependencies

Returns the known dependencies for this type. If this has dependencies whose values are not known statically, a dependency for the Injector will be included in the returned set.

Specified by:

getDependencies in interface HasDependencies

Returns:

a possibly empty set

acceptExtensionVisitor

public java.lang.Object acceptExtensionVisitor(BindingTargetVisitor visitor,
                                               ProviderInstanceBinding binding)

Description copied from interface: ProviderWithExtensionVisitor

Instructs the extension determine if the visitor is an instance of a custom extension visitor, and if so, visit it using that method. If the visitor is not an instance of the custom extension visitor, this method MUST call visitor.visit(binding).

Due to issues with generics, the type parameters of this method do not relate to the type of the provider. In practice, the 'B' type will always be a supertype of 'T'.

Specified by:

acceptExtensionVisitor in interface ProviderWithExtensionVisitor

containsElement

public boolean containsElement(Element element)

Description copied from interface: OptionalBinderBinding

Returns true if this OptionalBinder contains the given Element in order to build the optional binding or uses the given Element in order to support building and injecting its data. This will work for OptionalBinderBinding retrieved from an injector and Elements.getElements(com.google.inject.Module...). Usually this is only necessary if you are working with elements retrieved from modules (without an Injector), otherwise OptionalBinderBinding.getDefaultBinding() and OptionalBinderBinding.getActualBinding() are better options.

Specified by:

containsElement in interface OptionalBinderBinding

getActualBinding

public Binding getActualBinding()

Description copied from interface: OptionalBinderBinding

Returns the actual binding (set by OptionalBinder.setBinding()) or null if not set. This will throw UnsupportedOperationException if it is called on an element retrieved from Elements.getElements(com.google.inject.Module...).

The Binding's type will always match the type Optional's generic type. For example, if getKey returns a key of Optional<String>, then this will always return a Binding<String>.

Specified by:

getActualBinding in interface OptionalBinderBinding

getDefaultBinding

public Binding getDefaultBinding()

Description copied from interface: OptionalBinderBinding

Returns the default binding (set by OptionalBinder.setDefault()) if one exists or null if no default binding is set. This will throw UnsupportedOperationException if it is called on an element retrieved from Elements.getElements(com.google.inject.Module...).

The Binding's type will always match the type Optional's generic type. For example, if getKey returns a key of Optional<String>, then this will always return a Binding<String>.

Specified by:

getDefaultBinding in interface OptionalBinderBinding

getKey

public Key getKey()

Description copied from interface: OptionalBinderBinding

Returns the Key for this binding.

Specified by:

getKey in interface OptionalBinderBinding