Difference between revisions of "GEF/GEF4/Common"

Revision as of 14:10, 9 May 2015

Note to non-wiki readers: This documentation is generated from the Eclipse wiki - if you have corrections or additions it would be awesome if you added them in the original wiki page.

Introduction

The GEF4 Common component provides key concepts and infrastructure to be potentially used by all other GEF4 components.

Activate

• package: org.eclipse.gef4.common.activate

IActivatable

ActivatableSupport

Adapt

• package: org.eclipse.gef4.common.adapt

The adapt package provides a modernized interpretation of the Eclipse Core Runtime's IAdaptable, providing the following enhancements:

1. Adapters may be registered and retrieved by means of a TypeToken key as an alternative to a Class key, which ensures that adapters with parameterized types may also be registered and retrieved in a type-safe manner, not only via their raw type. For instance, an adapter instance a1 of parameterized type A<T1> and an instance a2 of type A<T2> can both be registered at an IAdaptable. The GEF/GEF4/MVC GEF4 MVC component makes use of this intensively, when registering providers, i.e. a Provider<IGeometry> and a Provider<IFXAnchor> can now both be registered at an IAdaptable simultaneously.
2. Adapters may (optionally) be registered and retrieved by providing an additional role key, which allows to register multiple adapters of the same type (using different roles) at an IAdaptable. For instance, adapter instances a1 and a2 of type A can both be registered at an IAdaptable using different roles. The GEF/GEF4/MVC GEF4 MVC component again makes use of this, when registering providers. Different geometry providers (Provider<IGeometry>) are e.g. registered for selection and hover feedback, by registering respective providers with respective roles.
3. Adapters may request a back-reference to the respective IAdaptable they get registered at, by implementing a respective back-interface (IAdaptable.Bound). Again, this is intensively used within GEF/GEF4/MVC GEF4 MVC, where an IBehavior or IPolicy for instance needs to be aware of the host IVisualPart it is registered at.
4. IAdaptable provides support for registering property change listeners, to be notified whenever adapters are registered or unregistered.

Besides the IAdaptable, IAdaptable.Bound, and AdapterKey abstractions that formalize the modernized adaptable pattern, the package also provides a supporting class (AdaptableSupport) to implement IAdaptable in compliance with its contract, as well as a standalone implementation (AdapterStore) of an IAdaptable.

IAdaptable, AdapterKey

The first two enhancements listed above are realized by the option to register and retrieve adapters via an AdapterKey, which combines a type key (Class or TypeToken) with an (optional) role. Having the option to use a TypeToken instead of a simple Class key, enables the type-safe registration of adapters with parameterized types. The combination with an additional (optional) role enables that multiple adapters of the same type may be registered at an Adaptable.

The 'traditional' getAdapter(Class<? super T>) method now is just a convenience operation that will retrieve the adapter registered with the respective Class key and the default role (or the only adapter registered under the given Class key, if there is only one adapter for that type key).

An adapter can thus now be registered and retrieved in various ways:

  // register and retrieve adapter 'a' of raw type 'A' under 'default' role (traditional adaptable objects pattern).
  adaptable.setAdapter(A.class, a); 
  A a = adaptable.getAdapter(A.class);
 
  // register and retrieve adapter 'a' of parameterized type 'A<T>' under 'default' role
  adaptable.setAdapter(new TypeToken<A<T>>(){}, a);
  A<T> a = adaptable.getAdapter(new TypeToken<A<T>>(){});
 
  // register and retrieve adapter 'a' of raw type 'A' under role 'a1'
  adaptable.setAdapter(AdapterKey.get(A.class, "a1"));
  A a = adaptable.getAdapter(AdapterKey.get(A.class));
 
  // register and retrieve adapter 'a' of parameterized type 'A<T>' under role 'a1'
  adaptable.setAdapter(AdapterKey.get(new TypeToken<A<T>>(){}, "a1"));
  A a = adaptable.getAdapter(AdapterKey.get(new TypeToken<A<T>>(){}, "a1"));

To formalize support for notifying listeners about registration and unregistration of adapters, IAdaptable furthermore extends IPropertyChangeNotifier, which provides capabilities for registering and unregistering respective listeners.

IAdaptable.Bound

To formalize that an adapter may need to obtain a back reference to an IAdaptable, the IAdaptable.Bound interface was introduced. If an adapter implements this interface, the adaptable at which the adapter is registered is responsible of providing a back reference to the adapter as follows:

public class MyAdaptable implements IAdaptable {
 
  public <T> void setAdapter(AdapterKey<? super T> key, T adapter) {
    ...
    if (adapter instanceof IAdaptable.Bound) {
      ((IAdaptable.Bound<A>) adapter).setAdaptable(this);
    ...
  }
 
  public <T> T unsetAdapter(AdapterKey<? super T> key) {
    ...
    if (adapter instanceof IAdaptable.Bound) {
      ((IAdaptable.Bound<A>) adapter).setAdaptable(null);
    }
    ...
  }
}

AdaptableSupport

To enforce that implementers of IAdaptable properly follow the above outlined contract, the package furthermore provides an AdaptableSupport class, which does not formally implement the IAdaptable interface but provides implementations for all its methods and can thus be simply used as a delegate, as follows:

public class MyAdaptable implements IAdaptable {
 
  // create delegates
  private PropertyChangeSupport pcs = new PropertyChangeSupport(this);
  private AdaptableSupport<MyAdaptable> ads = new AdaptableSupport<MyAdaptable>(this, pcs);
 
  public <T> T getAdapter(AdapterKey<? super T> key){
    return ads.getAdapter(key);
  }
 
  ...
}

It needs to be provided with a PropertyChangeSupport, which will be used to notify listeners about registration and unregistration of adapters. In case the adaptable, by which it is used as a delegate, is also IActivatable, it will ensure that all IActivatable adapters are properly activated/deactivated when being registered/unregistered dependent on the active state of the adaptable at that moment.

AdapterStore

The package furthermore provides an AdaptableStore, which can be used as a standalone IAdaptable.

Dispose

• package: org.eclipse.gef4.common.dispose

Inject

• package: org.eclipse.gef4.common.inject

This package contains Google Guice-based support for injection of adapters to IAdaptables. That is, if an IAdaptable implementation provides a method with a single Map<AdapterKey<?>, Object> parameter that is annotated with a respective inject annotation (@AdapterMap), and if respective adapter bindings are provided within a Guice Module, adapter instances can automatically be injected into instances of the IAdaptable by means of a specific MembersInjector. It needs to be pointed out that respective adapter bindings are evaluated polymorphically, i.e. a concrete IAdaptable will also be injected with all adapters that registered for super types of it.

AdapterMapInjectionSupport, AdaptableTypeListener, AdapterMapInjector

To enable injection of adapters to IAdaptables, a specific TypeListener (AdaptableTypeListener) needs to be registered in the Guice Module. To ensure this is properly done, a respective support Module is provided, namely AdapterMapInjectionSupport, which can easily be integrated into a custom Module as follows:

public class MyModule extends AbstractModule {
 
  @Override
  protected void configure() {
    // register adapter map injection support
    install(new AdapterMapInjectionSupport());
 
    ...
  }
}

This will ensure that the AdaptableTypeListener is properly registered (and itself injected). The AdaptableTypeListener will register a dedicated MembersInjector (AdapterMapInjector) on all suitable IAdaptable implementations it encounters.

AdapterMap, AdapterMaps

The @AdapterMap annotation is used in two ways. First, it is used to specify respective adapter map-bindings within the Guice Module. Second, it is used to specify the injection point, i.e. the method within the IAdaptable implementation that should be injected with adapters.

Specifying the injection point within a respective IAdaptable implementation is achieved by means of a method, which is marked for injection by means of an @Inject annotation, and furthermore provides a single Map<AdapterKey<?>, Object> parameter that is annotated with @AdapterMap as follows:

public class MyAdaptable implements IAdaptable {
 
  @Inject(optional = true)
  public void setAdapters(@AdapterMap Map<AdapterKey<?>, Object> adaptersWithKeys) {
    ...
  }
}

Specifying the to be injected adapters is performed by means of map-bindings in the Module.

public class MyModule extends AbstractModule {
 
  @Override
  protected void configure() {
    ...
 
    // obtain a map binder to bind adapters for the respective IAdaptable type.
    MapBinder<AdapterKey<?>, Object> adapterMapBinder = AdapterMaps.getAdapterMapBinder(binder(), MyAdaptable.class);
 
   // add adapter (map) binding for binding adapter 'a' of raw type 'A' to each MyAdaptable instance
   adapterMapBinder.addBinding(AdapterKey.get(A.class)).toInstance(a);
 
  // add adapter (map) binding for binding an instance of raw type 'A' to each MyAdaptable instance
   adapterMapBinder.addBinding(AdapterKey.get(A.class)).to(A.class);
 
   // add adapter (map) binding for binding adapter 'a' with parameterized type 'A<T>' to each MyAdaptable instance
   adapterMapBinder.addBinding(AdapterKey.get(new TypeToken<A<T>>(){})).toInstance(a); 
 
   ...
  }
}

When adapter map injection is properly enabled in the Module, all suitable IAdaptable instances that are created through an Injector will be injected. To this extend, the @AdapterMap bindings can be compared to the Guice @Named bindings, only that a 'Class' instead of a 'String' key is used. However, @AdapterMap bindings are more powerful, as they are evaluated polymorphically. That is, if an adapter map binding is specified for a specific IAdaptable type, let's say 'A', it will be evaluated for instances of all subtypes of 'A' as well, as long as they are suitable for injection (i.e. they directly or via inheritance provide a respective method for adapter map injection). This is a very powerful mechanism that is used intensively by the GEF4 MVC component. It allows to register certain adapters already for some abstract base type, so that each concrete sub-type will be injected with a respective adapter instance.

AdaptableScope, AdaptableScopes

In addition to basic injection support for adapters, the package also provides support for scoping the to be injected adapter instances by means of a dedicated Guice Scope (AdaptableScope).

AdaptableScope

An AdaptableScope is a Guice Scope that is bound to an IAdaptable instance. It can be used to scope the adapter instances injected through adapter map injection. To enable this, the respective adapter map bindings have to be 'scoped' and the scope has to be entered for the respective IAdaptables before injection of adapters is triggered.

Notify

• package: org.eclipse.gef4.common.notify

Properties

• package: org.eclipse.gef4.common.properties

IPropertyChangeNotifier

Reflect

• package: org.eclipse.gef4.common.reflect