diff org.eclipse.equinox.common/src/org/eclipse/core/runtime/IAdapterFactory.d @ 12:bc29606a740c

Added dwt-addons in original directory structure of eclipse.org
author Frank Benoit <benoit@tionex.de>
date Sat, 14 Mar 2009 18:23:29 +0100
parents
children bbe49769ec18
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/org.eclipse.equinox.common/src/org/eclipse/core/runtime/IAdapterFactory.d	Sat Mar 14 18:23:29 2009 +0100
@@ -0,0 +1,58 @@
+/*******************************************************************************
+ * Copyright (c) 2000, 2006 IBM Corporation and others.
+ * All rights reserved. This program and the accompanying materials
+ * are made available under the terms of the Eclipse Public License v1.0
+ * which accompanies this distribution, and is available at
+ * http://www.eclipse.org/legal/epl-v10.html
+ *
+ * Contributors:
+ *     IBM Corporation - initial API and implementation
+ * Port to the D programming language:
+ *     Frank Benoit <benoit@tionex.de>
+ *******************************************************************************/
+module org.eclipse.core.runtime.IAdapterFactory;
+
+import java.lang.all;
+
+/**
+ * An adapter factory defines behavioral extensions for
+ * one or more classes that implements the <code>IAdaptable</code>
+ * interface. Adapter factories are registered with an
+ * adapter manager.
+ * <p>
+ * This interface can be used without OSGi running.
+ * </p><p>
+ * Clients may implement this interface.
+ * </p>
+ * @see IAdapterManager
+ * @see IAdaptable
+ */
+public interface IAdapterFactory {
+    /**
+     * Returns an object which is an instance of the given class
+     * associated with the given object. Returns <code>null</code> if
+     * no such object can be found.
+     *
+     * @param adaptableObject the adaptable object being queried
+     *   (usually an instance of <code>IAdaptable</code>)
+     * @param adapterType the type of adapter to look up
+     * @return a object castable to the given adapter type,
+     *    or <code>null</code> if this adapter factory
+     *    does not have an adapter of the given type for the
+     *    given object
+     */
+    public Object getAdapter(Object adaptableObject, ClassInfo adapterType);
+
+    /**
+     * Returns the collection of adapter types handled by this
+     * factory.
+     * <p>
+     * This method is generally used by an adapter manager
+     * to discover which adapter types are supported, in advance
+     * of dispatching any actual <code>getAdapter</code> requests.
+     * </p>
+     *
+     * @return the collection of adapter types
+     */
+    public ClassInfo[] getAdapterList();
+}