|
Nuxeo Enterprise Platform 5.4 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface AdapterManager
An adapter manager maintains a registry of adapter factories. Clients
directly invoke methods on an adapter manager to register and unregister
adapters. All adaptable objects (that is, objects that implement the IAdaptable
interface) funnel IAdaptable.getAdapter
invocations to their
adapter manager's IAdapterManger.getAdapter
method. The
adapter manager then forwards this request unmodified to the IAdapterFactory.getAdapter
method on one of the registered adapter factories.
Adapter factories can be registered programmatically using the registerAdapters
method. Alternatively, they can be registered declaratively using the
org.eclipse.core.runtime.adapters
extension point. Factories registered
with this extension point will not be able to provide adapters until their
corresponding plugin has been activated.
The following code snippet shows how one might register an adapter of type
com.example.acme.Sticky
on resources in the workspace.
IAdapterFactory pr = new IAdapterFactory() { public Class[] getAdapterList() { return new Class[] { com.example.acme.Sticky.class }; } public Object getAdapter(Object adaptableObject, Class adapterType) { IResource res = (IResource) adaptableObject; QualifiedName key = new QualifiedName("com.example.acme", "sticky-note"); try { com.example.acme.Sticky v = (com.example.acme.Sticky) res.getSessionProperty(key); if (v == null) { v = new com.example.acme.Sticky(); res.setSessionProperty(key, v); } } catch (CoreException e) { // unable to access session property - ignore } return v; } } Platform.getAdapterManager().registerAdapters(pr, IResource.class);
This interface can be used without OSGi running.
This interface is not intended to be implemented by clients.
Adaptable
,
AdapterFactory
Method Summary | ||
---|---|---|
java.lang.String[] |
computeAdapterTypes(java.lang.Class adaptableClass)
Returns the types that can be obtained by converting adaptableClass
via this manager. |
|
java.lang.Class[] |
computeClassOrder(java.lang.Class clazz)
Returns the class search order for a given class. |
|
|
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 adapterTypeName)
Returns an object which is an instance of the given class name associated with the given object. |
|
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. |
|
void |
registerAdapters(AdapterFactory factory,
java.lang.Class adaptable)
Registers the given adapter factory as extending objects of the given type. |
|
void |
unregisterAdapters(AdapterFactory factory)
Removes the given adapter factory completely from the list of registered factories. |
|
void |
unregisterAdapters(AdapterFactory factory,
java.lang.Class adaptable)
Removes the given adapter factory from the list of factories registered as extending the given class. |
Method Detail |
---|
java.lang.String[] computeAdapterTypes(java.lang.Class adaptableClass)
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
.
adaptableClass
- the adaptable class being queried
adaptableClass
via this manager. An empty array
is returned if there are none.java.lang.Class[] computeClassOrder(java.lang.Class clazz)
class X extends Y implements A, B
Object
getInterfaces
(in the example, A and its
superinterfaces then B and its superinterfaces)
clazz
- the class for which to return the class order.
<T> T getAdapter(java.lang.Object adaptable, java.lang.Class<T> adapterType)
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
.
adaptable
- the adaptable object being queried (usually an instance
of IAdaptable
)adapterType
- the type of adapter to look up
null
if the given adaptable object does not have an available adapter of the
given typejava.lang.Object getAdapter(java.lang.Object adaptable, java.lang.String adapterTypeName)
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.
adaptable
- the adaptable object being queried (usually an instance
of IAdaptable
)adapterTypeName
- the fully qualified name of the type of adapter to look up
null
if the given adaptable object does not have an available adapter of the
given typeboolean hasAdapter(java.lang.Object adaptable, java.lang.String adapterTypeName)
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
.
adaptable
- the adaptable object being queried (usually an instance
of IAdaptable
)adapterTypeName
- the fully qualified class name of an adapter to
look up
true
if there is an adapter factory that claims
it can convert adaptable
to an object of type adapterType
,
and false
otherwise.java.lang.Object loadAdapter(java.lang.Object adaptable, java.lang.String adapterTypeName)
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.
adaptable
- the adaptable object being queried (usually an instance
of IAdaptable
)adapterTypeName
- the fully qualified name of the type of adapter to look up
null
if the given adaptable object does not have an available adapter of the
given typevoid registerAdapters(AdapterFactory factory, java.lang.Class adaptable)
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.
factory
- the adapter factoryadaptable
- the type being extendedunregisterAdapters(AdapterFactory)
,
unregisterAdapters(AdapterFactory, Class)
void unregisterAdapters(AdapterFactory factory)
unregisterAdapters(IAdapterFactory,Class)
on all classes against which it had been explicitly registered. Does
nothing if the given factory is not currently registered.
factory
- the adapter factory to removeregisterAdapters(AdapterFactory, Class)
void unregisterAdapters(AdapterFactory factory, java.lang.Class adaptable)
factory
- the adapter factory to removeadaptable
- one of the types against which the given factory is
registeredregisterAdapters(AdapterFactory, Class)
|
Nuxeo Enterprise Platform 5.4 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |