Copyright (c) 2000, 2011 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
/*******************************************************************************
 * Copyright (c) 2000, 2011 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.ltk.core.refactoring;

import org.eclipse.core.runtime.Assert;
import org.eclipse.core.runtime.CoreException;
import org.eclipse.core.runtime.IProgressMonitor;
import org.eclipse.core.runtime.NullProgressMonitor;
import org.eclipse.core.runtime.SubProgressMonitor;

import org.eclipse.core.resources.IWorkspaceRunnable;

Operation that, when run, executes a refactoring. This includes
condition checking, change creation, change execution and remembering
of the undo change on the refactoring's undo stack.

The operation should be executed via the run method offered by
IWorkspace to achieve proper delta batching.


Note: this class is not intended to be extended by clients.

See Also:
IWorkspace
Since:
3.0
@noextend
This class is not intended to be subclassed by clients./**
 * Operation that, when run, executes a refactoring. This includes
 * condition checking, change creation, change execution and remembering
 * of the undo change on the refactoring's undo stack.
 * <p>
 * The operation should be executed via the run method offered by
 * <code>IWorkspace</code> to achieve proper delta batching.
 * </p>
 * <p>
 * Note: this class is not intended to be extended by clients.
 * </p>
 *
 * @see org.eclipse.core.resources.IWorkspace
 *
 * @since 3.0
 *
 * @noextend This class is not intended to be subclassed by clients.
 */
public class PerformRefactoringOperation implements IWorkspaceRunnable {

	private int fStyle;
	private RefactoringContext fRefactoringContext;
	private Refactoring fRefactoring;

	private RefactoringStatus fPreconditionStatus;
	private RefactoringStatus fValidationStatus;
	private Change fUndo;

	
Create a new perform refactoring operation. The operation will not perform the refactoring if the refactoring's condition checking returns an error of severity RefactoringStatus.FATAL. 
Params:
refactoring – the refactoring to perform
style – the condition checking style as defined by CheckConditionsOperation
See Also:
PerformRefactoringOperation(RefactoringContext, int)/**
	 * Create a new perform refactoring operation. The operation will not
	 * perform the refactoring if the refactoring's condition checking returns
	 * an error	of severity {@link RefactoringStatus#FATAL}.
	 *
	 * @param refactoring the refactoring to perform
	 * @param style the condition checking style as defined by
	 *  {@link CheckConditionsOperation}
	 * @see #PerformRefactoringOperation(RefactoringContext, int) 
	 */
	public PerformRefactoringOperation(Refactoring refactoring, int style) {
		Assert.isNotNull(refactoring);
		fRefactoring= refactoring;
		fStyle= style;
	}

	
Create a new perform refactoring operation. The operation will not perform the refactoring if the refactoring's condition checking returns an error of severity RefactoringStatus.FATAL. 
 The caller must ensure that the operation is run exactly once. The implementation of run(IProgressMonitor) will call RefactoringContext.dispose(). 
Params:
refactoringContext – the refactoring context to perform
style – the condition checking style as defined by CheckConditionsOperation
Since:
3.6/**
	 * Create a new perform refactoring operation. The operation will not
	 * perform the refactoring if the refactoring's condition checking returns
	 * an error	of severity {@link RefactoringStatus#FATAL}.
	 * <p>
	 * The caller must ensure that the operation is run exactly once. The implementation
	 * of {@link #run(IProgressMonitor)} will call {@link RefactoringContext#dispose()}.
	 * </p>
	 *
	 * @param refactoringContext the refactoring context to perform
	 * @param style the condition checking style as defined by
	 *  {@link CheckConditionsOperation}
	 * @since 3.6
	 */
	public PerformRefactoringOperation(RefactoringContext refactoringContext, int style) {
		Assert.isNotNull(refactoringContext);
		fRefactoringContext= refactoringContext;
		fRefactoring= fRefactoringContext.getRefactoring();
		fStyle= style;
	}
	
	
Return the refactoring status of the condition checking.
Returns:
the refactoring status of the condition checking or null
 if the operation hasn't been performed yet/**
	 * Return the refactoring status of the condition checking.
	 *
	 * @return the refactoring status of the condition checking or <code>null</code>
	 *  if the operation hasn't been performed yet
	 */
	public RefactoringStatus getConditionStatus() {
		return fPreconditionStatus;
	}

	
Returns the refactoring status of the change's validation checking
or null if a change couldn't be created or the operation
hasn't been performed yet.
Returns:
the refactoring status of the change's validation checking/**
	 * Returns the refactoring status of the change's validation checking
	 * or <code>null</code> if a change couldn't be created or the operation
	 * hasn't been performed yet.
	 *
	 * @return the refactoring status of the change's validation checking
	 */
	public RefactoringStatus getValidationStatus() {
		return fValidationStatus;
	}

	
The undo object or null if no undo exists. The undo object is initialize via the call Change.initializeValidationData(IProgressMonitor) 
Returns:
the undo object or null/**
	 * The undo object or <code>null</code> if no undo exists. The undo
	 * object is initialize via the call {@link Change#initializeValidationData(IProgressMonitor)}
	 *
	 * @return the undo object or <code>null</code>
	 */
	public Change getUndoChange() {
		return fUndo;
	}

	@Override
	public void run(IProgressMonitor monitor) throws CoreException {
		try {
			if (monitor == null)
				monitor= new NullProgressMonitor();
			monitor.beginTask("", 10); //$NON-NLS-1$
			final CreateChangeOperation create= new CreateChangeOperation(new CheckConditionsOperation(fRefactoring, fStyle), RefactoringStatus.FATAL);
			create.run(new SubProgressMonitor(monitor, 6));
			fPreconditionStatus= create.getConditionCheckingStatus();
			if (fPreconditionStatus.hasFatalError()) {
				monitor.done();
				return;
			}
			final Change change= create.getChange();
			if (change != null) {
				final PerformChangeOperation perform= new PerformChangeOperation(change);
				perform.setUndoManager(RefactoringCore.getUndoManager(), fRefactoring.getName());
				perform.run(new SubProgressMonitor(monitor, 2));
				fValidationStatus= perform.getValidationStatus();
				fUndo= perform.getUndoChange();
			}
		} finally {
			if (fRefactoringContext != null)
				fRefactoringContext.dispose();
		}
	}
}