blob: fddc7ea6dd7e224e7cb5018d2b80bd7281ef451c [file] [log] [blame]
/*******************************************************************************
* Copyright (c) 2000, 2003 IBM Corporation and others.
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Common Public License v1.0
* which accompanies this distribution, and is available at
* http://www.eclipse.org/legal/cpl-v10.html
*
* Contributors:
* IBM Corporation - initial API and implementation
*******************************************************************************/
package org.eclipse.core.runtime;
/**
* An interface for an adaptable object.
* <p>
* Adaptable objects can be dynamically extended to provide different
* interfaces (or "adapters"). Adapters are created by adapter
* factories, which are in turn managed by type by adapter managers.
* </p>
* For example,
* <pre>
* IAdaptable a = [some adaptable];
* IFoo x = (IFoo)a.getAdapter(IFoo.class);
* if (x != null)
* [do IFoo things with x]
* </pre>
* <p>
* Clients may implement this interface.
* </p>
* @see IAdapterFactory
* @see IAdapterManager
*/
public interface IAdaptable {
/**
* Returns an object which is an instance of the given class
* associated with this object. Returns <code>null</code> if
* no such object can be found.
*
* @param adapter the adapter class to look up
* @return a object castable to the given class,
* or <code>null</code> if this object does not
* have an adapter for the given class
*/
public Object getAdapter(Class adapter);
}