org.eclipse.core.internal.runtime

Class AdapterManager

java.lang.Object

org.eclipse.core.internal.runtime.AdapterManager

All Implemented Interfaces:

IAdapterManager

public final class AdapterManager
extends java.lang.Object
implements IAdapterManager

This class is the standard implementation of IAdapterManager. It provides fast lookup of property values with the following semantics:

• If multiple installed factories provide the same adapter, iterate until one of the factories return a non-null value. Remaining factories won't be invoked.
• The search order from a class with the definition
  class X extends Y implements A, B
  is as follows:
  • the target's class: X
  • X's superclasses in order to Object
  • a breadth-first traversal of each class's interfaces in the order returned by getInterfaces (in the example, X's superinterfaces then Y's superinterfaces)

See Also:

IAdapterFactory, IAdapterManager

Field Summary

Fields inherited from interface org.eclipse.core.runtime.IAdapterManager

LOADED, NONE, NOT_LOADED

Method Summary

Modifier and Type	Method and Description
java.lang.String[]	computeAdapterTypes(java.lang.Class<? extends java.lang.Object> adaptable) Returns the types that can be obtained by converting adaptableClass via this manager.
<T> java.lang.Class<? super T>[]	computeClassOrder(java.lang.Class<T> adaptable) Returns the super-type search order starting with adaptable.
void	flushLookup() Flushes the cache of adapter search paths.
<T> T	getAdapter(java.lang.Object adaptable, java.lang.Class<T> adapterType) Returns an object which is an instance of the given class associated with the given object.
java.lang.Object	getAdapter(java.lang.Object adaptable, java.lang.String adapterType) Returns an object which is an instance of the given class name associated with the given object.
static AdapterManager	getDefault()
java.util.Map<java.lang.String,java.util.List<IAdapterFactory>>	getFactories()
boolean	hasAdapter(java.lang.Object adaptable, java.lang.String adapterTypeName) Returns whether there is an adapter factory registered that may be able to convert adaptable to an object of type adapterTypeName.
java.lang.Object	loadAdapter(java.lang.Object adaptable, java.lang.String adapterTypeName) Returns an object that is an instance of the given class name associated with the given object.
int	queryAdapter(java.lang.Object adaptable, java.lang.String adapterTypeName) Returns a status of an adapter factory registered that may be able to convert adaptable to an object of type adapterTypeName.
void	registerAdapters(IAdapterFactory factory, java.lang.Class<?> adaptable) Registers the given adapter factory as extending objects of the given type.
void	registerFactory(IAdapterFactory factory, java.lang.String adaptableType)
void	registerLazyFactoryProvider(IAdapterManagerProvider factoryProvider)
void	unregisterAdapters(IAdapterFactory factory) Removes the given adapter factory completely from the list of registered factories.
void	unregisterAdapters(IAdapterFactory factory, java.lang.Class<?> adaptable) Removes the given adapter factory from the list of factories registered as extending the given class.
void	unregisterAllAdapters()
boolean	unregisterLazyFactoryProvider(IAdapterManagerProvider factoryProvider)

Methods inherited from class java.lang.Object

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

Method Detail

getDefault

public static AdapterManager getDefault()

computeAdapterTypes

public java.lang.String[] computeAdapterTypes(java.lang.Class<? extends java.lang.Object> adaptable)

Description copied from interface: IAdapterManager

Returns the types that can be obtained by converting adaptableClass via this manager. Converting means that subsequent calls to getAdapter() or loadAdapter() could result in an adapted object.

Note that the returned types do not guarantee that a subsequent call to getAdapter with the same type as an argument will return a non-null result. If the factory's plug-in has not yet been loaded, or if the factory itself returns null, then getAdapter will still return null.

Specified by:

computeAdapterTypes in interface IAdapterManager

Parameters:

adaptable - the adaptable class being queried

Returns:

an array of type names that can be obtained by converting adaptableClass via this manager. An empty array is returned if there are none.

computeClassOrder

public <T> java.lang.Class<? super T>[] computeClassOrder(java.lang.Class<T> adaptable)

Returns the super-type search order starting with adaptable. The search order is defined in this class' comment.

Specified by:

computeClassOrder in interface IAdapterManager

Parameters:

adaptable - the class for which to return the class order.

Returns:

the class search order for the given class. The returned search order will minimally contain the target class.

flushLookup

public void flushLookup()

Flushes the cache of adapter search paths. This is generally required whenever an adapter is added or removed.

It is likely easier to just toss the whole cache rather than trying to be smart and remove only those entries affected.

getAdapter

public <T> T getAdapter(java.lang.Object adaptable,
                        java.lang.Class<T> adapterType)

Description copied from interface: IAdapterManager

Returns an object which is an instance of the given class associated with the given object. Returns null if no such object can be found.

Note that this method will never cause plug-ins to be loaded. If the only suitable factory is not yet loaded, this method will return null.

In most cases, it is preferable for client code to use Adapters.adapt(Object, Class, boolean) rather than calling this method directly since doing so will also detect interfaces supplied by the IAdaptable interface

Specified by:

getAdapter in interface IAdapterManager

Parameters:

adaptable - the adaptable object being queried (usually an instance of IAdaptable)

adapterType - the type of adapter to look up

Returns:

an object of the given adapter type, or null if the given adaptable object does not have an available adapter of the given type

getAdapter

public java.lang.Object getAdapter(java.lang.Object adaptable,
                                   java.lang.String adapterType)

Description copied from interface: IAdapterManager

Returns an object which is an instance of the given class name associated with the given object. Returns null if no such object can be found.

Note that this method will never cause plug-ins to be loaded. If the only suitable factory is not yet loaded, this method will return null. If activation of the plug-in providing the factory is required, use the loadAdapter method instead.

In most cases, it is preferable for client code to use Adapters.adapt(Object, Class, boolean) rather than calling this method directly since doing so will also detect interfaces supplied by the IAdaptable interface

Specified by:

getAdapter in interface IAdapterManager

Parameters:

adaptable - the adaptable object being queried (usually an instance of IAdaptable)

adapterType - the fully qualified name of the type of adapter to look up

Returns:

an object castable to the given adapter type, or null if the given adaptable object does not have an available adapter of the given type

hasAdapter

public boolean hasAdapter(java.lang.Object adaptable,
                          java.lang.String adapterTypeName)

Description copied from interface: IAdapterManager

Returns whether there is an adapter factory registered that may be able to convert adaptable to an object of type adapterTypeName.

Note that a return value of true does not guarantee that a subsequent call to getAdapter with the same arguments will return a non-null result. If the factory's plug-in has not yet been loaded, or if the factory itself returns null, then getAdapter will still return null.

Specified by:

hasAdapter in interface IAdapterManager

Parameters:

adaptable - the adaptable object being queried (usually an instance of IAdaptable)

adapterTypeName - the fully qualified class name of an adapter to look up

Returns:

true if there is an adapter factory that claims it can convert adaptable to an object of type adapterType, and false otherwise.

queryAdapter

public int queryAdapter(java.lang.Object adaptable,
                        java.lang.String adapterTypeName)

Description copied from interface: IAdapterManager

Returns a status of an adapter factory registered that may be able to convert adaptable to an object of type adapterTypeName.

One of the following values can be returned:

• IAdapterManager.NONE if no applicable adapter factory was found;
• IAdapterManager.NOT_LOADED if an adapter factory was found, but has not been loaded;
• IAdapterManager.LOADED if an adapter factory was found, and it is loaded.

Specified by:

queryAdapter in interface IAdapterManager

Parameters:

adaptable - the adaptable object being queried (usually an instance of IAdaptable)

adapterTypeName - the fully qualified class name of an adapter to look up

Returns:

a status of the adapter

loadAdapter

public java.lang.Object loadAdapter(java.lang.Object adaptable,
                                    java.lang.String adapterTypeName)

Description copied from interface: IAdapterManager

Returns an object that is an instance of the given class name associated with the given object. Returns null if no such object can be found.

Note that unlike the getAdapter methods, this method will cause the plug-in that contributes the adapter factory to be loaded if necessary. As such, this method should be used judiciously, in order to avoid unnecessary plug-in activations. Most clients should avoid activation by using getAdapter instead.

In most cases, it is preferable for client code to use Adapters.adapt(Object, Class, boolean) rather than calling this method directly since doing so will also detect interfaces supplied by the IAdaptable interface.

Specified by:

loadAdapter in interface IAdapterManager

Parameters:

adaptable - the adaptable object being queried (usually an instance of IAdaptable)

adapterTypeName - the fully qualified name of the type of adapter to look up

Returns:

an object castable to the given adapter type, or null if the given adaptable object does not have an available adapter of the given type

registerAdapters

public void registerAdapters(IAdapterFactory factory,
                             java.lang.Class<?> adaptable)

Description copied from interface: IAdapterManager

Registers the given adapter factory as extending objects of the given type.

If the type being extended is a class, the given factory's adapters are available on instances of that class and any of its subclasses. If it is an interface, the adapters are available to all classes that directly or indirectly implement that interface.

Specified by:

registerAdapters in interface IAdapterManager

Parameters:

factory - the adapter factory

adaptable - the type being extended

See Also:

IAdapterManager.unregisterAdapters(IAdapterFactory), IAdapterManager.unregisterAdapters(IAdapterFactory, Class)

registerFactory

public void registerFactory(IAdapterFactory factory,
                            java.lang.String adaptableType)

unregisterAdapters

public void unregisterAdapters(IAdapterFactory factory)

Description copied from interface: IAdapterManager

Removes the given adapter factory completely from the list of registered factories. Equivalent to calling unregisterAdapters(IAdapterFactory,Class) on all classes against which it had been explicitly registered. Does nothing if the given factory is not currently registered.

Specified by:

unregisterAdapters in interface IAdapterManager

Parameters:

factory - the adapter factory to remove

See Also:

IAdapterManager.registerAdapters(IAdapterFactory, Class)

unregisterAdapters

public void unregisterAdapters(IAdapterFactory factory,
                               java.lang.Class<?> adaptable)

Description copied from interface: IAdapterManager

Removes the given adapter factory from the list of factories registered as extending the given class. Does nothing if the given factory and type combination is not registered.

Specified by:

unregisterAdapters in interface IAdapterManager

Parameters:

factory - the adapter factory to remove

adaptable - one of the types against which the given factory is registered

See Also:

IAdapterManager.registerAdapters(IAdapterFactory, Class)

unregisterAllAdapters

public void unregisterAllAdapters()

registerLazyFactoryProvider

public void registerLazyFactoryProvider(IAdapterManagerProvider factoryProvider)

unregisterLazyFactoryProvider

public boolean unregisterLazyFactoryProvider(IAdapterManagerProvider factoryProvider)

getFactories

public java.util.Map<java.lang.String,java.util.List<IAdapterFactory>> getFactories()