plugins/org.eclipse.graphiti/src/org/eclipse/graphiti/features/ICustomAbortableUndoRedoFeature.java

/*********************************************************************
* Copyright (c) 2005, 2019 SAP SE
*
* This program and the accompanying materials are made
* available under the terms of the Eclipse Public License 2.0
* which is available at https://www.eclipse.org/legal/epl-2.0/
*
* Contributors:
*    mwenz - Bug 443304 - Improve undo/redo handling in Graphiti features
*
* SPDX-License-Identifier: EPL-2.0
**********************************************************************/
package org.eclipse.graphiti.features;

import org.eclipse.core.runtime.OperationCanceledException;


/**
 * This interface can by used and implemented by customers within any feature to
 * signal the need for additional work that needs to be done before or after
 * undo and redo. In addition to {@link ICustomUndoRedoFeature} this interface
 * supports cancellation of undo/redo operations.
 * 
 * @see ICustomUndoRedoFeature
 * @since 0.12
 */
public interface ICustomAbortableUndoRedoFeature extends ICustomUndoRedoFeature {

	/**
	 * The Graphiti framework will call this method after
	 * {@link #preUndo(org.eclipse.graphiti.features.context.IContext)}/
	 * {@link #preRedo(org.eclipse.graphiti.features.context.IContext)} have
	 * been called and before the actual undo/redo operation is triggered. In
	 * case this method returns <code>true</code>, the operation will be
	 * cancelled by the Graphiti framework by throwing an
	 * {@link OperationCanceledException} that causes am EMF revert of the
	 * operation.
	 * <p>
	 * Implementing classes might e.g. set a flag in
	 * {@link #preUndo(org.eclipse.graphiti.features.context.IContext)}/
	 * {@link #preRedo(org.eclipse.graphiti.features.context.IContext)} as
	 * cancellation indication and check that that flag here.
	 * 
	 * @return <code>true</code> in case you want to cancel the current
	 *         operation, <code>false</code> otherwise.
	 */
	boolean isAbort();
}