org.eclipse.gef4.common.adapt

Class AdaptableSupport<A extends IAdaptable>

java.lang.Object

org.eclipse.gef4.common.adapt.AdaptableSupport<A>

Type Parameters:

A - The type of IAdaptable supported by this class. If passed-in adapters implement the IAdaptable.Bound interface, the generic type parameter of IAdaptable.Bound has to match this one.

All Implemented Interfaces:

IDisposable

public class AdaptableSupport<A extends IAdaptable>
extends java.lang.Object
implements IDisposable

A support class to manage adapters for a source IAdaptable. It offers all methods defined by IAdaptable, while not formally implementing the interface, and can thus be used by a source IAdaptable as a delegate.

In addition to the source IAdaptable a PropertyChangeSupport is expected to be passe in during construction. It will be used to fire PropertyChangeEvents whenever an adapter is set ( setAdapter(AdapterKey, Object)) or unset ( unsetAdapter(AdapterKey)). IAdaptable.ADAPTERS_PROPERTY will be used as the property name within all change events.

If the IAdaptable is also IActivatable, it will ensure adapters are activated/deactivated when being set/unset dependent on the active state of the adaptable at that moment. However, the AdaptableSupport will not register a listener for the active state of the source IAdaptable, so changes to its active state will not result in state changes of the registered adapters. For this purpose, an ActivatableSupport may be used by the source IAdaptable as a second delegate.

Constructor Summary

Constructors

Constructor and Description
AdaptableSupport(A source, java.beans.PropertyChangeSupport pcs) Creates a new AdaptableSupport for the given source IAdaptable and a related PropertyChangeSupport.

Method Summary

Modifier and Type	Method and Description
void	dispose() Disposes this AdaptableSupport, which will unregister all currently registered adapters, unbind them from their source IAdaptable (in case they are IAdaptable.Bound), and dispose them (if they are IDisposable).
<T> T	getAdapter(AdapterKey<? super T> key) Returns an adapter for the given AdapterKey if one can unambiguously be retrieved, i.e. if there is only a single adapter registered under a key that 'matches' the given AdapterKey.
<T> T	getAdapter(java.lang.Class<? super T> key) Returns an adapter for the given Class key if one can unambiguously be retrieved.
<T> T	getAdapter(com.google.common.reflect.TypeToken<? super T> key) Returns an adapter for the given TypeToken key if one can unambiguously be retrieved.
java.util.Map<AdapterKey<?>,java.lang.Object>	getAdapters() Retrieves all registered adapters, mapped to the respective AdapterKeys they are registered.
<T> java.util.Map<AdapterKey<? extends T>,T>	getAdapters(java.lang.Class<? super T> key) Returns all adapters 'matching' the given Class key, i.e. all adapters whose AdapterKey's TypeToken key AdapterKey.getKey()) refers to the same or a sub-type of the given Class key (see TypeToken.isAssignableFrom(Type)).
<T> java.util.Map<AdapterKey<? extends T>,T>	getAdapters(com.google.common.reflect.TypeToken<? super T> key) Returns all adapters 'matching' the given TypeToken key, i.e. all adapters whose AdapterKey's TypeToken key AdapterKey.getKey()) refers to the same or a sub-type or of the given TypeToken key (see TypeToken.isAssignableFrom(TypeToken)).
<T> void	setAdapter(AdapterKey<? super T> key, T adapter) Registers the given adapter under the given AdapterKey.
<T> void	setAdapter(java.lang.Class<? super T> key, T adapter) Registers the given adapter under an AdapterKey, which will use a TypeToken representing the given Class key, i.e. using TypeToken.of(Class), as well as the default role (see AdapterKey.DEFAULT_ROLE.
<T> void	setAdapter(com.google.common.reflect.TypeToken<? super T> key, T adapter) Registers the given adapter under an AdapterKey, which will use the given TypeToken key as well as the default role (see AdapterKey.DEFAULT_ROLE.
void	setAdapters(java.util.Map<AdapterKey<?>,java.lang.Object> adaptersWithKeys, boolean overwrite) Registers the given adapters under the provided keys by delegating to setAdapter(AdapterKey, Object).
<T> T	unsetAdapter(AdapterKey<? super T> key) Unregisters the adapter registered under the exact AdapterKey given, returning it for convenience.

Methods inherited from class java.lang.Object

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

Constructor Detail

AdaptableSupport

public AdaptableSupport(A source,
                        java.beans.PropertyChangeSupport pcs)

Creates a new AdaptableSupport for the given source IAdaptable and a related PropertyChangeSupport.

Parameters:

source - The IAdaptable that encloses the to be created AdaptableSupport, delegating calls to it. May not be null

pcs - An PropertyChangeSupport, which will be used to fire PropertyChangeEvent's whenever adapters are set or unset. May not be null

Method Detail

getAdapter

public <T> T getAdapter(AdapterKey<? super T> key)

Returns an adapter for the given AdapterKey if one can unambiguously be retrieved, i.e. if there is only a single adapter registered under a key that 'matches' the given AdapterKey.

Type Parameters:

T - The adapter type.

Parameters:

key - The AdapterKey used to retrieve a registered adapter.

Returns:

The unambiguously retrievable adapter for the given AdapterKey or null if none could be retrieved.

See Also:

IAdaptable.getAdapter(AdapterKey)

getAdapter

public <T> T getAdapter(java.lang.Class<? super T> key)

Returns an adapter for the given Class key if one can unambiguously be retrieved. That is, if there is only a single adapter that 'matches' the given Class key, this adapter is returned, ignoring the role under which it is registered (see AdapterKey.getRole()).

Type Parameters:

T - The adapter type.

Parameters:

key - The Class key used to retrieve a registered adapter.

Returns:

The unambiguously retrievable adapter for the given Class key or null if none could be retrieved.

See Also:

IAdaptable.getAdapter(Class)

getAdapter

public <T> T getAdapter(com.google.common.reflect.TypeToken<? super T> key)

Returns an adapter for the given TypeToken key if one can unambiguously be retrieved. That is, if there is only a single adapter that 'matches' the given TypeToken key, this adapter is returned, ignoring the role under which it is registered (see AdapterKey.getRole()).

Type Parameters:

T - The adapter type.

Parameters:

key - The TypeToken key used to retrieve a registered adapter.

Returns:

The unambiguously retrievable adapter for the given TypeToken key or null if none could be retrieved.

See Also:

IAdaptable.getAdapter(TypeToken)

getAdapters

public java.util.Map<AdapterKey<?>,java.lang.Object> getAdapters()

Retrieves all registered adapters, mapped to the respective AdapterKeys they are registered.

Returns:

A map containing the registered adapters under their AdapterKeys as a copy.

getAdapters

public <T> java.util.Map<AdapterKey<? extends T>,T> getAdapters(java.lang.Class<? super T> key)

Returns all adapters 'matching' the given Class key, i.e. all adapters whose AdapterKey's TypeToken key AdapterKey.getKey()) refers to the same or a sub-type of the given Class key (see TypeToken.isAssignableFrom(Type)).

Type Parameters:

T - The adapter type.

Parameters:

key - The Class key to retrieve adapters for.

Returns:

A Map containing all those adapters registered at this AdaptableSupport, whose AdapterKey's TypeToken key (AdapterKey.getKey()) refers to the same or a sub-type of the given Class key, qualified by their respective AdapterKeys.

See Also:

IAdaptable.getAdapters(Class)

getAdapters

public <T> java.util.Map<AdapterKey<? extends T>,T> getAdapters(com.google.common.reflect.TypeToken<? super T> key)

Returns all adapters 'matching' the given TypeToken key, i.e. all adapters whose AdapterKey's TypeToken key AdapterKey.getKey()) refers to the same or a sub-type or of the given TypeToken key (see TypeToken.isAssignableFrom(TypeToken)).

Type Parameters:

T - The adapter type.

Parameters:

key - The TypeToken key to retrieve adapters for.

Returns:

A Map containing all those adapters registered at this AdaptableSupport, whose AdapterKey's TypeToken key (AdapterKey.getKey()) refers to the same or a sub-type of the given TypeToken key, qualified by their respective AdapterKeys.

See Also:

IAdaptable.getAdapters(TypeToken)

setAdapter

public <T> void setAdapter(java.lang.Class<? super T> key,
                           T adapter)

Registers the given adapter under an AdapterKey, which will use a TypeToken representing the given Class key, i.e. using TypeToken.of(Class), as well as the default role (see AdapterKey.DEFAULT_ROLE.

Type Parameters:

T - The adapter type.

Parameters:

key - The Class under which to register the given adapter.

adapter - The adapter to register under the given Class key.

See Also:

IAdaptable.setAdapter(Class, Object)

setAdapter

public <T> void setAdapter(com.google.common.reflect.TypeToken<? super T> key,
                           T adapter)

Registers the given adapter under an AdapterKey, which will use the given TypeToken key as well as the default role (see AdapterKey.DEFAULT_ROLE.

Type Parameters:

T - The adapter type.

Parameters:

key - The TypeToken under which to register the given adapter.

adapter - The adapter to register under the given TypeToken key.

See Also:

IAdaptable.setAdapter(TypeToken, Object)

setAdapter

public <T> void setAdapter(AdapterKey<? super T> key,
                           T adapter)

Registers the given adapter under the given AdapterKey. The adapter has to be compliant to the AdapterKey, i.e. it has to be of the same type or a sub-type of the AdapterKey's type key ( AdapterKey.getKey()).

Type Parameters:

T - The adapter type.

Parameters:

key - The AdapterKey under which to register the given adapter.

adapter - The adapter to register under the given AdapterKey.

See Also:

IAdaptable.setAdapter(AdapterKey, Object)

setAdapters

public void setAdapters(java.util.Map<AdapterKey<?>,java.lang.Object> adaptersWithKeys,
                        boolean overwrite)

Registers the given adapters under the provided keys by delegating to setAdapter(AdapterKey, Object). Note, that delegation will only occur for those adapters, whose key is not already bound to an adapter, in case overwrite is set to false.

Parameters:

adaptersWithKeys - A map of class keys and related adapters to be added via setAdapter(AdapterKey, Object).

overwrite - Indicates whether adapters whose keys are already registered for another adapter should be ignored. If set to true existing entries will be overwritten, otherwise, existing entries will be preserved.

unsetAdapter

public <T> T unsetAdapter(AdapterKey<? super T> key)

Unregisters the adapter registered under the exact AdapterKey given, returning it for convenience.

Type Parameters:

T - The adapter type.

Parameters:

key - The AdapterKey for which to remove a registered adapter.

Returns:

The adapter, which has been removed.

See Also:

IAdaptable.unsetAdapter(AdapterKey)

dispose

public void dispose()

Disposes this AdaptableSupport, which will unregister all currently registered adapters, unbind them from their source IAdaptable (in case they are IAdaptable.Bound), and dispose them (if they are IDisposable). No notification will be fired to notify listeners about the unregistering of adapters. It is expected that in case the source IAdaptable is IActivatable, it is deactivated before disposing this AdaptableSupport.

Specified by:

dispose in interface IDisposable