com.google.inject.spi

Interface ProviderWithExtensionVisitor<T>

All Superinterfaces:

javax.inject.Provider<T>

All Known Implementing Classes:

ProviderMethod

public interface ProviderWithExtensionVisitor<T>
extends Provider<T>

A Provider that is part of an extension which supports a custom BindingTargetVisitor.

When an extension binds a provider instance, the provider can implement this interface to allow users using the Binding.acceptTargetVisitor(BindingTargetVisitor) method to visit a custom visitor designed for that extension. A typical implementation within the extension would look like

 <V, B> V acceptExtensionVisitor(BindingTargetVisitor<B, V> visitor, ProviderInstanceBinding<? extends B> binding) {
   if(visitor instanceof MyCustomExtensionVisitor) {
     return ((MyCustomExtensionVisitor<B, V>)visitor).visitCustomExtension(customProperties, binding);
   } else {
     return visitor.visit(binding);
   }
 }

'MyCustomExtensionVisitor' in the example above would be an interface the extension provides that users can implement in order to be notified of custom extension information. These visitor interfaces must extend from BindingTargetVisitor.

Since:

3.0

Author:

sameb@google.com (Sam Berlin)

Method Summary

Methods

Modifier and Type	Method and Description
<B,V> V	acceptExtensionVisitor(BindingTargetVisitor<B,V> visitor, ProviderInstanceBinding<? extends B> binding) Instructs the extension determine if the visitor is an instance of a custom extension visitor, and if so, visit it using that method.

Methods inherited from interface com.google.inject.Provider

get

Method Detail

acceptExtensionVisitor

<B,V> V acceptExtensionVisitor(BindingTargetVisitor<B,V> visitor,
                             ProviderInstanceBinding<? extends B> binding)

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'.