org.eclipse.gef4.common.inject

Class AdapterMapInjector

java.lang.Object

org.eclipse.gef4.common.inject.AdapterMapInjector

All Implemented Interfaces:

com.google.inject.MembersInjector<IAdaptable>

public class AdapterMapInjector
extends java.lang.Object
implements com.google.inject.MembersInjector<IAdaptable>

A specific MembersInjector to support adapter map injection, i.e. injection of adapters into IAdaptable instances. Will be able to perform adapter map injection if being registered (by an AdaptableTypeListener) on an IAdaptable encounter, which:

• is annotated with Inject, and
• contains a single parameter of type Map<AdapterKey<?>, Object>, which is annotated with an AdapterMap annotation.

Being registered for a specific IAdaptable an AdapterMapInjector will inject all instances of that type or any sub-type, evaluating all AdapterMap bindings that can be obtained from the Injector which was forwarded by the AdaptableTypeListener via setInjector(Injector). This means, that it will inject via the respective method all adapters, for which bindings with a matching AdapterMap annotation exist. Here, matching means, that the type provided in the AdapterMap annotation of the IAdaptable#s method (AdapterMap.adaptableType()) is either the same or a sub-type of the type used with the AdapterMap annotation of the related binding.

See Also:

AdapterMap, AdaptableTypeListener

Constructor Summary

Constructors

Constructor and Description
AdapterMapInjector(java.lang.reflect.Method method, AdapterMap methodAnnotation) Creates a new AdapterMapInjector to inject the given Method, annotated with the given AdapterMap method annotation.

Method Summary

Modifier and Type	Method and Description
protected java.util.SortedMap<com.google.inject.Key<?>,com.google.inject.Binding<?>>	getPolymorphicAdapterMapBindings(java.lang.Class<?> adaptableType, java.lang.reflect.Method method, AdapterMap methodAnnotation) Retrieves all adapter map bindings where the adaptable type of the map binding is a true super type or true super interface of the one referred to in the given method annotation, and assignable from the given adaptable type.
protected void	injectAdapters(java.lang.Object adaptable) Performs the adapter map injection for the given adaptable instance.
void	injectMembers(IAdaptable instance)
void	setInjector(com.google.inject.Injector injector) Sets the Injector, being used for adapter map injection.

Methods inherited from class java.lang.Object

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

Constructor Detail

AdapterMapInjector

public AdapterMapInjector(java.lang.reflect.Method method,
                          AdapterMap methodAnnotation)

Creates a new AdapterMapInjector to inject the given Method, annotated with the given AdapterMap method annotation.

Parameters:

method - The Method to be injected.

methodAnnotation - The AdapterMap annotation specified at the single parameter of the to be injected method.

Method Detail

getPolymorphicAdapterMapBindings

protected java.util.SortedMap<com.google.inject.Key<?>,com.google.inject.Binding<?>> getPolymorphicAdapterMapBindings(java.lang.Class<?> adaptableType,
                                                                                                                      java.lang.reflect.Method method,
                                                                                                                      AdapterMap methodAnnotation)

Retrieves all adapter map bindings where the adaptable type of the map binding is a true super type or true super interface of the one referred to in the given method annotation, and assignable from the given adaptable type. The bindings are returned mapped to their keys, sorted following the inheritance hierarchy of their respective adaptable types.

As Guice will already inject those map bindings, where the adaptable type of the map binding is the same as the one given in the method annotation, these are ignored here. Instead, only those bindings are computed where the type in the method annotation is not equal to the one of the map binding, and where the type of the map binding is assignable from the given concrete adaptable type.

Parameters:

adaptableType - The concrete (runtime) adaptable type of the adaptable, whose method is to be injected.

method - The to be injected method of the adaptable type.

methodAnnotation - The AdapterMap method annotation of the to be injected adaptable's method.

Returns:

All adapter map bindings (mapped to their binding keys), sorted along the type hierarchy of the bindings adaptable types, where the adaptable type of the binding is a true super type or true interface of the adaptable type given in the method annotation, and is furthermore assignable from the given adaptable type.

injectAdapters

protected void injectAdapters(java.lang.Object adaptable)

Performs the adapter map injection for the given adaptable instance.

Parameters:

adaptable - The adaptable to inject adapters into.

injectMembers

public void injectMembers(IAdaptable instance)

Specified by:

injectMembers in interface com.google.inject.MembersInjector<IAdaptable>

setInjector

@Inject
public void setInjector(com.google.inject.Injector injector)

Sets the Injector, being used for adapter map injection.

Parameters:

injector - The Injector to use.