RenameResourceChange.java

/*******************************************************************************
 * Copyright (c) 2007 Business Objects Software Limited and others.
 * All rights reserved. 
 * This file is 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:
 *     Business Objects Software Limited - initial API and implementation based on Eclipse 3.1.2 code for
 *                             org.eclipse.jdt.internal.corext.refactoring.changes.RenameResourceChange
 *                           Eclipse source is available at: http://www.eclipse.org/downloads/
 *******************************************************************************/
/*
 * RenameResourceChange.java
 * Created: Sept 7, 2007
 * By: Greg McClement
 */
package org.openquark.cal.eclipse.ui.util;

import org.eclipse.core.runtime.CoreException;
import org.eclipse.core.runtime.IPath;
import org.eclipse.core.runtime.IProgressMonitor;

import org.eclipse.core.resources.IResource;
import org.eclipse.core.resources.ResourcesPlugin;

import org.eclipse.ltk.core.refactoring.Change;
import org.eclipse.ltk.core.refactoring.ChangeDescriptor;
import org.eclipse.ltk.core.refactoring.RefactoringChangeDescriptor;
import org.eclipse.ltk.core.refactoring.RefactoringDescriptor;
import org.eclipse.ltk.core.refactoring.RefactoringStatus;
import org.openquark.cal.eclipse.ui.CALUIMessages;

/**
 * A change for renaming a resource. No support for undo.
 * @author Greg McClement
 */
public final class RenameResourceChange extends CALChange {

    public static IPath renamedResourcePath(IPath path, String newName) {
        return path.removeLastSegments(1).append(newName);
    }

    private final String fComment;

    private final RefactoringDescriptor fDescriptor;

    private final String fNewName;

    private final IPath fResourcePath;

    private final long fStampToRestore;

    private RenameResourceChange(RefactoringDescriptor descriptor, IPath resourcePath, String newName, String comment, long stampToRestore) {
        fDescriptor= descriptor;
        fResourcePath= resourcePath;
        fNewName= newName;
        fComment= comment;
        fStampToRestore= stampToRestore;
    }

    public RenameResourceChange(RefactoringDescriptor descriptor, IResource resource, String newName, String comment) {
        this(descriptor, resource.getFullPath(), newName, comment, IResource.NULL_STAMP);
    }

    public ChangeDescriptor getDescriptor() {
        if (fDescriptor != null)
            return new RefactoringChangeDescriptor(fDescriptor);
        return null;
    }

    public Object getModifiedElement() {
        return getResource();
    }

    public String getName() {
        return Messages.format(CALUIMessages.RenameResourceChange_name, new String[] { fResourcePath.toString(), fNewName});
    }

    public String getNewName() {
        return fNewName;
    }

    private IResource getResource() {
        return ResourcesPlugin.getWorkspace().getRoot().findMember(fResourcePath);
    }

    public RefactoringStatus isValid(IProgressMonitor pm) throws CoreException {
        IResource resource= getResource();
        if (resource == null || !resource.exists()) {
            return RefactoringStatus.createFatalErrorStatus(Messages.format(CALUIMessages.RenameResourceChange_does_not_exist, fResourcePath.toString()));
        } else {
            return super.isValid(pm, DIRTY);
        }
    }

    public Change perform(IProgressMonitor pm) throws CoreException {
        try {
            pm.beginTask(CALUIMessages.RenameResourceChange_rename_resource, 1);

            IResource resource= getResource();
            long currentStamp= resource.getModificationStamp();
            IPath newPath= renamedResourcePath(fResourcePath, fNewName);
            resource.move(newPath, IResource.SHALLOW, pm);
            if (fStampToRestore != IResource.NULL_STAMP) {
                IResource newResource= ResourcesPlugin.getWorkspace().getRoot().findMember(newPath);
                newResource.revertModificationStamp(fStampToRestore);
            }
            String oldName= fResourcePath.lastSegment();
            return new RenameResourceChange(null, newPath, oldName, fComment, currentStamp);
        } finally {
            pm.done();
        }
    }
}