blob: 09f7cc0ff0dcf614843ad64b985e2c516383153b (
plain) (
blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
|
/*******************************************************************************
* Copyright (c) 2000, 2015 IBM Corporation and others.
*
* This program and the accompanying materials
* are made available under the terms of the Eclipse Public License 2.0
* which accompanies this distribution, and is available at
* https://www.eclipse.org/legal/epl-2.0/
*
* SPDX-License-Identifier: EPL-2.0
*
* 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.
* <p>
* Clients should implement this interface and include the name of their class
* in an extension to the platform extension point named
* <code>"org.eclipse.ui.elementFactories"</code>. For example, the plug-in's
* XML markup might contain:
* </p>
*
* <pre>
* <extension point="org.eclipse.ui.elementFactories">
* <factory id="com.example.myplugin.MyFactory" class="com.example.myplugin.MyFactory" />
* </extension>
* </pre>
*
* @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.
* <p>
* If the result is not null, it should be persistable; that is,
* </p>
*
* <pre>
* result.getAdapter(org.eclipse.ui.IPersistableElement.class)
* </pre>
* <p>
* should not return <code>null</code>.
* </p>
*
* @param memento a memento containing the state for the object
* @return an object, or <code>null</code> if the element could not be created
*/
IAdaptable createElement(IMemento memento);
}
|