diff options
Diffstat (limited to 'plugins/infra/core/org.eclipse.papyrus.infra.core/src/org/eclipse/papyrus/infra/core/editor/reload/IReloadContextProvider.java')
-rw-r--r-- | plugins/infra/core/org.eclipse.papyrus.infra.core/src/org/eclipse/papyrus/infra/core/editor/reload/IReloadContextProvider.java | 38 |
1 files changed, 38 insertions, 0 deletions
diff --git a/plugins/infra/core/org.eclipse.papyrus.infra.core/src/org/eclipse/papyrus/infra/core/editor/reload/IReloadContextProvider.java b/plugins/infra/core/org.eclipse.papyrus.infra.core/src/org/eclipse/papyrus/infra/core/editor/reload/IReloadContextProvider.java new file mode 100644 index 00000000000..281c629e023 --- /dev/null +++ b/plugins/infra/core/org.eclipse.papyrus.infra.core/src/org/eclipse/papyrus/infra/core/editor/reload/IReloadContextProvider.java @@ -0,0 +1,38 @@ +/* + * Copyright (c) 2014 CEA 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: + * Christian W. Damus (CEA) - Initial API and implementation + * + */ +package org.eclipse.papyrus.infra.core.editor.reload; + + +/** + * An adapter protocol for objects that can provide {@code context}s to be included in the + * re-load state of dependent parts in an {@link EditorReloadEvent}, for the purpose of + * restoring the state of those objects after re-load has completed. + */ +public interface IReloadContextProvider { + + /** + * Creates an opaque token from which the receiver can be {@linkplain #restore(Object) restored} after the editor has reloaded. + * + * @return an opaque editor re-load context, or {@code null} if none is needed on this occasion (for example because the receiver + * is in its default state) + */ + Object createReloadContext(); + + /** + * Reloads the receiver's state from a token previously {@linkplain #createReloadContext() provided}. + * + * @param reloadContext + * the opaque re-load context token + */ + void restore(Object reloadContext); +} |