MemberRenameModification.java

/*
 * $Id$
 *
 * SARL is an general-purpose agent programming language.
 * More details on http://www.sarl.io
 *
 * Copyright (C) 2014-2017 the original authors or authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package io.sarl.lang.ui.quickfix.acceptors;

import java.text.MessageFormat;

import org.eclipse.emf.ecore.EObject;
import org.eclipse.jdt.internal.ui.JavaPluginImages;
import org.eclipse.jdt.internal.ui.text.correction.IProposalRelevance;
import org.eclipse.xtext.ui.editor.model.edit.IModificationContext;
import org.eclipse.xtext.ui.editor.quickfix.IssueResolutionAcceptor;
import org.eclipse.xtext.validation.Issue;

import io.sarl.lang.ui.quickfix.SARLQuickfixProvider;

/**
 * Rename a member.
 *
 * @author $Author: sgalland$
 * @version $FullVersion$
 * @mavengroupid $GroupId$
 * @mavenartifactid $ArtifactId$
 */
public final class MemberRenameModification extends SARLSemanticModification {

	private final String validName;

	private MemberRenameModification(String validName) {
		this.validName = validName;
	}

	/** Create the quick fix if needed.
	 *
	 * <p>The user data ccontains the new names.
	 *
	 * @param provider - the quick fix provider.
	 * @param issue - the issue to fix.
	 * @param acceptor - the quick fix acceptor.
	 */
	public static void accept(SARLQuickfixProvider provider, Issue issue, IssueResolutionAcceptor acceptor) {
		for (final String newName : issue.getData()) {
			final String msg = MessageFormat.format(
					Messages.SARLQuickfixProvider_11,
					newName);
			final MemberRenameModification modification = new MemberRenameModification(newName);
			modification.setIssue(issue);
			modification.setTools(provider);
			acceptor.accept(issue,
					msg,
					MessageFormat.format(Messages.SARLQuickfixProvider_12, newName),
					JavaPluginImages.IMG_CORRECTION_RENAME,
					modification,
					IProposalRelevance.RENAME_REFACTORING);
		}
	}

	@Override
	public void apply(EObject element, IModificationContext context) throws Exception {
		final Issue issue = getIssue();
		context.getXtextDocument().replace(issue.getOffset(), issue.getLength(), this.validName);
	}

}