org.eclipse.ui.IElementFactory Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of org.eclipse.ui.workbench Show documentation

This is org.eclipse.ui.workbench jar used by Scout SDK

There is a newer version: 3.108.0.v20160602-1232

Show newest version

/*******************************************************************************
 * Copyright (c) 2000, 2008 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
 *******************************************************************************/
package org.eclipse.ui;

import org.eclipse.core.runtime.IAdaptable;

/**
 * A factory for re-creating objects from a previously saved memento.
 * 
 * Clients should implement this interface and include the name of their class
 * in an extension to the platform extension point named
 * "org.eclipse.ui.elementFactories".
 * For example, the plug-in's XML markup might contain:
 * 
 * <extension point="org.eclipse.ui.elementFactories">
 *    <factory id="com.example.myplugin.MyFactory" class="com.example.myplugin.MyFactory" />
 * </extension>
 * 
 * 
 *
 * @see IPersistableElement
 * @see IMemento
 * @see org.eclipse.ui.IWorkbench#getElementFactory
 */
public interface IElementFactory {
    /**
	 * Re-creates and returns an object from the state captured within the given
	 * memento.
	 * 
	 * If the result is not null, it should be persistable; that is,
	 * 
	 * result.getAdapter(org.eclipse.ui.IPersistableElement.class)
	 * 
	 * should not return null.
	 * 
	 *
	 * @param memento
	 *            a memento containing the state for the object
	 * @return an object, or null if the element could not be
	 *         created
	 */
    public IAdaptable createElement(IMemento memento);
}