org.eclipse.gef4.common.inject

Class AdaptableTypeListener

java.lang.Object

org.eclipse.gef4.common.inject.AdaptableTypeListener

All Implemented Interfaces:

com.google.inject.spi.TypeListener

public class AdaptableTypeListener
extends java.lang.Object
implements com.google.inject.spi.TypeListener

A specific TypeListener to support adapter map injection. It will register an AdapterMapInjector for each IAdaptable it encounters, which provides a method that:

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

The registered AdapterMapInjector is in turn responsible of performing the actual adapter map injection.

In order to function properly, an AdaptableTypeListener has to be bound in a Guice Module as follows:

 AdaptableTypeListener adaptableTypeListener = new AdaptableTypeListener();
 requestInjection(adaptableTypeListener);
 bindListener(Matchers.any(), adaptableTypeListener);
 

Here, the call to requestInjection() is important to ensure that setInjector(Injector) will get injected. Without it, the AdaptableTypeListener will not function properly.

See Also:

AdapterMap

Constructor Summary

Constructors

Constructor and Description
AdaptableTypeListener()

Method Summary

Modifier and Type	Method and Description
<I> void	hear(com.google.inject.TypeLiteral<I> type, com.google.inject.spi.TypeEncounter<I> encounter)
void	setInjector(com.google.inject.Injector injector) In order to work, the AdaptableTypeListener needs to obtain a reference to an Injector, which is forwarded to the AdapterMapInjector, which it registers for any IAdaptable encounters, to obtain the AdapterMap bindings to be injected.

Methods inherited from class java.lang.Object

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

Constructor Detail

AdaptableTypeListener

public AdaptableTypeListener()

Method Detail

setInjector

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

In order to work, the AdaptableTypeListener needs to obtain a reference to an Injector, which is forwarded to the AdapterMapInjector, which it registers for any IAdaptable encounters, to obtain the AdapterMap bindings to be injected.

Parameters:

injector - The injector that is forwarded (used to inject) the AdapterMapInjector.

hear

public <I> void hear(com.google.inject.TypeLiteral<I> type,
                     com.google.inject.spi.TypeEncounter<I> encounter)

Specified by:

hear in interface com.google.inject.spi.TypeListener