/******************************************************************************* * Copyright (c) 2000, 2011 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.jdt.ui.refactoring; import java.lang.reflect.InvocationTargetException; import org.eclipse.swt.widgets.Shell; import org.eclipse.core.runtime.CoreException; import org.eclipse.core.runtime.IStatus; import org.eclipse.core.runtime.Status; import org.eclipse.jface.dialogs.MessageDialog; import org.eclipse.jface.operation.IRunnableContext; import org.eclipse.ltk.core.refactoring.RefactoringCore; import org.eclipse.ltk.core.refactoring.RefactoringStatus; import org.eclipse.ltk.core.refactoring.participants.RenameProcessor; import org.eclipse.ltk.core.refactoring.participants.RenameRefactoring; import org.eclipse.jdt.core.ICompilationUnit; import org.eclipse.jdt.core.IField; import org.eclipse.jdt.core.IJavaProject; import org.eclipse.jdt.core.ILocalVariable; import org.eclipse.jdt.core.IMethod; import org.eclipse.jdt.core.IPackageFragment; import org.eclipse.jdt.core.IPackageFragmentRoot; import org.eclipse.jdt.core.IType; import org.eclipse.jdt.core.ITypeParameter; import org.eclipse.jdt.core.refactoring.descriptors.RenameJavaElementDescriptor; import org.eclipse.jdt.internal.corext.refactoring.rename.JavaRenameProcessor; import org.eclipse.jdt.internal.corext.refactoring.rename.MethodChecks; import org.eclipse.jdt.internal.corext.refactoring.rename.RenameCompilationUnitProcessor; import org.eclipse.jdt.internal.corext.refactoring.rename.RenameEnumConstProcessor; import org.eclipse.jdt.internal.corext.refactoring.rename.RenameFieldProcessor; import org.eclipse.jdt.internal.corext.refactoring.rename.RenameJavaProjectProcessor; import org.eclipse.jdt.internal.corext.refactoring.rename.RenameLocalVariableProcessor; import org.eclipse.jdt.internal.corext.refactoring.rename.RenameNonVirtualMethodProcessor; import org.eclipse.jdt.internal.corext.refactoring.rename.RenamePackageProcessor; import org.eclipse.jdt.internal.corext.refactoring.rename.RenameSourceFolderProcessor; import org.eclipse.jdt.internal.corext.refactoring.rename.RenameTypeParameterProcessor; import org.eclipse.jdt.internal.corext.refactoring.rename.RenameTypeProcessor; import org.eclipse.jdt.internal.corext.refactoring.rename.RenameVirtualMethodProcessor; import org.eclipse.jdt.internal.corext.refactoring.tagging.INameUpdating; import org.eclipse.jdt.internal.corext.refactoring.tagging.IReferenceUpdating; import org.eclipse.jdt.internal.corext.refactoring.tagging.ITextUpdating; import org.eclipse.jdt.internal.corext.util.JdtFlags; import org.eclipse.jdt.internal.ui.JavaUIMessages; import org.eclipse.jdt.internal.ui.refactoring.RefactoringExecutionHelper; import org.eclipse.jdt.internal.ui.refactoring.UserInterfaceStarter; import org.eclipse.jdt.internal.ui.refactoring.reorg.RenameRefactoringWizard; import org.eclipse.jdt.internal.ui.refactoring.reorg.RenameSelectionState; import org.eclipse.jdt.internal.ui.refactoring.reorg.RenameUserInterfaceManager; import org.eclipse.jdt.internal.ui.refactoring.reorg.RenameUserInterfaceStarter; /** * Central access point to execute rename refactorings. *
* Note: this class is not intended to be subclassed or instantiated. *
* @since 2.1 * * @noinstantiate This class is not intended to be instantiated by clients. * @noextend This class is not intended to be subclassed by clients. */ public class RenameSupport { private RenameRefactoring fRefactoring; private RefactoringStatus fPreCheckStatus; /** * Executes some light weight precondition checking. If the returned status * is an error then the refactoring can't be executed at all. However, * returning an OK status doesn't guarantee that the refactoring can be * executed. It may still fail while performing the exhaustive precondition * checking done inside the methodsopenDialog
or
* perform
.
*
* The method is mainly used to determine enable/disablement of actions.
*
* @return the result of the light weight precondition checking.
*
* @throws CoreException if an unexpected exception occurs while performing the checking.
*
* @see #openDialog(Shell)
* @see #perform(Shell, IRunnableContext)
*/
public IStatus preCheck() throws CoreException {
ensureChecked();
if (fPreCheckStatus.hasFatalError())
return fPreCheckStatus.getEntryMatchingSeverity(RefactoringStatus.FATAL).toStatus();
else
return Status.OK_STATUS;
}
/**
* Opens the refactoring dialog for this rename support.
*
* @param parent a shell used as a parent for the refactoring dialog.
* @throws CoreException if an unexpected exception occurs while opening the
* dialog.
*
* @see #openDialog(Shell, boolean)
*/
public void openDialog(Shell parent) throws CoreException {
openDialog(parent, false);
}
/**
* Opens the refactoring dialog for this rename support.
*
* * This method has to be called from within the UI thread. *
* * @param parent a shell used as a parent for the refactoring, preview, or error dialog * @param showPreviewOnly iftrue
, the dialog skips all user input pages and
* directly shows the preview or error page. Otherwise, shows all pages.
* @return true
if the refactoring has been executed successfully,
* false
if it has been canceled or if an error has happened during
* initial conditions checking.
*
* @throws CoreException if an error occurred while executing the
* operation.
*
* @see #openDialog(Shell)
* @since 3.3
*/
public boolean openDialog(Shell parent, boolean showPreviewOnly) throws CoreException {
ensureChecked();
if (fPreCheckStatus.hasFatalError()) {
showInformation(parent, fPreCheckStatus);
return false;
}
UserInterfaceStarter starter;
if (! showPreviewOnly) {
starter= RenameUserInterfaceManager.getDefault().getStarter(fRefactoring);
} else {
starter= new RenameUserInterfaceStarter();
RenameRefactoringWizard wizard= new RenameRefactoringWizard(fRefactoring, fRefactoring.getName(), null, null, null) {
@Override
protected void addUserInputPages() {
// nothing to add
}
};
wizard.setForcePreviewReview(showPreviewOnly);
starter.initialize(wizard);
}
return starter.activate(fRefactoring, parent, getJavaRenameProcessor().getSaveMode());
}
/**
* Executes the rename refactoring without showing a dialog to gather
* additional user input (for example the new name of the IJavaElement).
* Only an error dialog is shown (if necessary) to present the result
* of the refactoring's full precondition checking.
* * The method has to be called from within the UI thread. *
* * @param parent a shell used as a parent for the error dialog. * @param context a {@link IRunnableContext} to execute the operation. * * @throws InterruptedException if the operation has been canceled by the * user. * @throws InvocationTargetException if an error occurred while executing the * operation. * * @see #openDialog(Shell) * @see IRunnableContext#run(boolean, boolean, org.eclipse.jface.operation.IRunnableWithProgress) */ public void perform(Shell parent, IRunnableContext context) throws InterruptedException, InvocationTargetException { try { ensureChecked(); if (fPreCheckStatus.hasFatalError()) { showInformation(parent, fPreCheckStatus); return; } RenameSelectionState state= createSelectionState(); RefactoringExecutionHelper helper= new RefactoringExecutionHelper(fRefactoring, RefactoringCore.getConditionCheckingFailedSeverity(), getJavaRenameProcessor().getSaveMode(), parent, context); helper.perform(true, true); restoreSelectionState(state); } catch (CoreException e) { throw new InvocationTargetException(e); } } /** Flag indication that no additional update is to be performed. */ public static final int NONE= 0; /** Flag indicating that references are to be updated as well. */ public static final int UPDATE_REFERENCES= 1 << 0; /** * Flag indicating that Javadoc comments are to be updated as well. * @deprecated use UPDATE_REFERENCES or UPDATE_TEXTUAL_MATCHES or both. */ public static final int UPDATE_JAVADOC_COMMENTS= 1 << 1; /** * Flag indicating that regular comments are to be updated as well. * @deprecated use UPDATE_TEXTUAL_MATCHES */ public static final int UPDATE_REGULAR_COMMENTS= 1 << 2; /** * Flag indicating that string literals are to be updated as well. * @deprecated use UPDATE_TEXTUAL_MATCHES */ public static final int UPDATE_STRING_LITERALS= 1 << 3; /** * Flag indicating that textual matches in comments and in string literals * are to be updated as well. * @since 3.0 */ public static final int UPDATE_TEXTUAL_MATCHES= 1 << 6; /** Flag indicating that the getter method is to be updated as well. */ public static final int UPDATE_GETTER_METHOD= 1 << 4; /** Flag indicating that the setter method is to be updated as well. */ public static final int UPDATE_SETTER_METHOD= 1 << 5; private RenameSupport(RenameJavaElementDescriptor descriptor) throws CoreException { RefactoringStatus refactoringStatus= new RefactoringStatus(); fRefactoring= (RenameRefactoring) descriptor.createRefactoring(refactoringStatus); if (refactoringStatus.hasFatalError()) { fPreCheckStatus= refactoringStatus; } else { preCheck(); refactoringStatus.merge(fPreCheckStatus); fPreCheckStatus= refactoringStatus; } } /** * Creates a new rename support for the given * {@link RenameJavaElementDescriptor}. * * @param descriptor the {@link RenameJavaElementDescriptor} to create a * {@link RenameSupport} for. The caller is responsible for * configuring the descriptor before it is passed. * @return the {@link RenameSupport}. * @throws CoreException if an unexpected error occurred while creating the * {@link RenameSupport}. * @since 3.3 */ public static RenameSupport create(RenameJavaElementDescriptor descriptor) throws CoreException { return new RenameSupport(descriptor); } private RenameSupport(JavaRenameProcessor processor, String newName, int flags) { fRefactoring= new RenameRefactoring(processor); initialize(processor, newName, flags); } private JavaRenameProcessor getJavaRenameProcessor() { return (JavaRenameProcessor) fRefactoring.getProcessor(); } /** * Creates a new rename support for the given {@link IJavaProject}. * * @param project the {@link IJavaProject} to be renamed. * @param newName the project's new name.null
is a valid
* value indicating that no new name is provided.
* @param flags flags controlling additional parameters. Valid flags are
* UPDATE_REFERENCES
or NONE
.
* @return the {@link RenameSupport}.
* @throws CoreException if an unexpected error occurred while creating
* the {@link RenameSupport}.
*/
public static RenameSupport create(IJavaProject project, String newName, int flags) throws CoreException {
JavaRenameProcessor processor= new RenameJavaProjectProcessor(project);
return new RenameSupport(processor, newName, flags);
}
/**
* Creates a new rename support for the given {@link IPackageFragmentRoot}.
*
* @param root the {@link IPackageFragmentRoot} to be renamed.
* @param newName the package fragment root's new name. null
is
* a valid value indicating that no new name is provided.
* @return the {@link RenameSupport}.
* @throws CoreException if an unexpected error occurred while creating
* the {@link RenameSupport}.
*/
public static RenameSupport create(IPackageFragmentRoot root, String newName) throws CoreException {
JavaRenameProcessor processor= new RenameSourceFolderProcessor(root);
return new RenameSupport(processor, newName, 0);
}
/**
* Creates a new rename support for the given {@link IPackageFragment}.
*
* @param fragment the {@link IPackageFragment} to be renamed.
* @param newName the package fragment's new name. null
is a
* valid value indicating that no new name is provided.
* @param flags flags controlling additional parameters. Valid flags are
* UPDATE_REFERENCES
, and UPDATE_TEXTUAL_MATCHES
,
* or their bitwise OR, or NONE
.
* @return the {@link RenameSupport}.
* @throws CoreException if an unexpected error occurred while creating
* the {@link RenameSupport}.
*/
public static RenameSupport create(IPackageFragment fragment, String newName, int flags) throws CoreException {
JavaRenameProcessor processor= new RenamePackageProcessor(fragment);
return new RenameSupport(processor, newName, flags);
}
/**
* Creates a new rename support for the given {@link ICompilationUnit}.
*
* @param unit the {@link ICompilationUnit} to be renamed.
* @param newName the compilation unit's new name. null
is a
* valid value indicating that no new name is provided.
* @param flags flags controlling additional parameters. Valid flags are
* UPDATE_REFERENCES
, and UPDATE_TEXTUAL_MATCHES
,
* or their bitwise OR, or NONE
.
* @return the {@link RenameSupport}.
* @throws CoreException if an unexpected error occurred while creating
* the {@link RenameSupport}.
*/
public static RenameSupport create(ICompilationUnit unit, String newName, int flags) throws CoreException {
JavaRenameProcessor processor= new RenameCompilationUnitProcessor(unit);
return new RenameSupport(processor, newName, flags);
}
/**
* Creates a new rename support for the given {@link IType}.
*
* @param type the {@link IType} to be renamed.
* @param newName the type's new name. null
is a valid value
* indicating that no new name is provided.
* @param flags flags controlling additional parameters. Valid flags are
* UPDATE_REFERENCES
, and UPDATE_TEXTUAL_MATCHES
,
* or their bitwise OR, or NONE
.
* @return the {@link RenameSupport}.
* @throws CoreException if an unexpected error occurred while creating
* the {@link RenameSupport}.
*/
public static RenameSupport create(IType type, String newName, int flags) throws CoreException {
JavaRenameProcessor processor= new RenameTypeProcessor(type);
return new RenameSupport(processor, newName, flags);
}
/**
* Creates a new rename support for the given {@link IMethod}.
*
* @param method the {@link IMethod} to be renamed.
* @param newName the method's new name. null
is a valid value
* indicating that no new name is provided.
* @param flags flags controlling additional parameters. Valid flags are
* UPDATE_REFERENCES
or NONE
.
* @return the {@link RenameSupport}.
* @throws CoreException if an unexpected error occurred while creating
* the {@link RenameSupport}.
*/
public static RenameSupport create(IMethod method, String newName, int flags) throws CoreException {
JavaRenameProcessor processor;
if (MethodChecks.isVirtual(method)) {
processor= new RenameVirtualMethodProcessor(method);
} else {
processor= new RenameNonVirtualMethodProcessor(method);
}
return new RenameSupport(processor, newName, flags);
}
/**
* Creates a new rename support for the given {@link IField}.
*
* @param field the {@link IField} to be renamed.
* @param newName the field's new name. null
is a valid value
* indicating that no new name is provided.
* @param flags flags controlling additional parameters. Valid flags are
* UPDATE_REFERENCES
, UPDATE_TEXTUAL_MATCHES
,
* UPDATE_GETTER_METHOD
, and UPDATE_SETTER_METHOD
,
* or their bitwise OR, or NONE
.
* @return the {@link RenameSupport}.
* @throws CoreException if an unexpected error occurred while creating
* the {@link RenameSupport}.
*/
public static RenameSupport create(IField field, String newName, int flags) throws CoreException {
if (JdtFlags.isEnum(field))
return new RenameSupport(new RenameEnumConstProcessor(field), newName, flags);
else {
final RenameFieldProcessor processor= new RenameFieldProcessor(field);
processor.setRenameGetter(updateGetterMethod(flags));
processor.setRenameSetter(updateSetterMethod(flags));
return new RenameSupport(processor, newName, flags);
}
}
/**
* Creates a new rename support for the given {@link ITypeParameter}.
*
* @param parameter the {@link ITypeParameter} to be renamed.
* @param newName the parameter's new name. null
is a valid value
* indicating that no new name is provided.
* @param flags flags controlling additional parameters. Valid flags are
* UPDATE_REFERENCES
, or NONE
.
* @return the {@link RenameSupport}.
* @throws CoreException if an unexpected error occurred while creating
* the {@link RenameSupport}.
* @since 3.1
*/
public static RenameSupport create(ITypeParameter parameter, String newName, int flags) throws CoreException {
RenameTypeParameterProcessor processor= new RenameTypeParameterProcessor(parameter);
processor.setUpdateReferences(updateReferences(flags));
return new RenameSupport(processor, newName, flags);
}
/**
* Creates a new rename support for the given {@link ILocalVariable}.
*
* @param variable the {@link ILocalVariable} to be renamed.
* @param newName the variable's new name. null
is a valid value
* indicating that no new name is provided.
* @param flags flags controlling additional parameters. Valid flags are
* UPDATE_REFERENCES
, or NONE
.
* @return the {@link RenameSupport}.
* @throws CoreException if an unexpected error occurred while creating
* the {@link RenameSupport}.
* @since 3.1
*/
public static RenameSupport create(ILocalVariable variable, String newName, int flags) throws CoreException {
RenameLocalVariableProcessor processor= new RenameLocalVariableProcessor(variable);
processor.setUpdateReferences(updateReferences(flags));
return new RenameSupport(processor, newName, flags);
}
private static void initialize(JavaRenameProcessor processor, String newName, int flags) {
setNewName(processor, newName);
if (processor instanceof IReferenceUpdating) {
IReferenceUpdating reference= (IReferenceUpdating) processor;
reference.setUpdateReferences(updateReferences(flags));
}
if (processor instanceof ITextUpdating) {
ITextUpdating text= (ITextUpdating) processor;
text.setUpdateTextualMatches(updateTextualMatches(flags));
}
}
private static void setNewName(INameUpdating refactoring, String newName) {
if (newName != null)
refactoring.setNewElementName(newName);
}
private static boolean updateReferences(int flags) {
return (flags & UPDATE_REFERENCES) != 0;
}
private static boolean updateTextualMatches(int flags) {
int TEXT_UPDATES= UPDATE_TEXTUAL_MATCHES | UPDATE_REGULAR_COMMENTS | UPDATE_STRING_LITERALS;
return (flags & TEXT_UPDATES) != 0;
}
private static boolean updateGetterMethod(int flags) {
return (flags & UPDATE_GETTER_METHOD) != 0;
}
private static boolean updateSetterMethod(int flags) {
return (flags & UPDATE_SETTER_METHOD) != 0;
}
private void ensureChecked() throws CoreException {
if (fPreCheckStatus == null) {
if (!fRefactoring.isApplicable()) {
fPreCheckStatus= RefactoringStatus.createFatalErrorStatus(JavaUIMessages.RenameSupport_not_available);
} else {
fPreCheckStatus= new RefactoringStatus();
}
}
}
private void showInformation(Shell parent, RefactoringStatus status) {
String message= status.getMessageMatchingSeverity(RefactoringStatus.FATAL);
MessageDialog.openInformation(parent, JavaUIMessages.RenameSupport_dialog_title, message);
}
private RenameSelectionState createSelectionState() {
RenameProcessor processor= (RenameProcessor) fRefactoring.getProcessor();
Object[] elements= processor.getElements();
RenameSelectionState state= elements.length == 1 ? new RenameSelectionState(elements[0]) : null;
return state;
}
private void restoreSelectionState(RenameSelectionState state) throws CoreException {
INameUpdating nameUpdating= (INameUpdating) fRefactoring.getAdapter(INameUpdating.class);
if (nameUpdating != null && state != null) {
Object newElement= nameUpdating.getNewElement();
if (newElement != null) {
state.restore(newElement);
}
}
}
}