org.eclipse.platform/org.eclipse.ltk.core.refactoring/3.10.300 : org/eclipse/ltk/core/refactoring/resource/RenameResourceDescriptor.java

RenameResourceDescriptor
http://www.eclipse.org/platform: Refactoring Core (Eclipse Foundation)
Eclipse Public License - v 2.0
Copyright (c) 2006, 2008 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) 2006, 2008 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.resource;

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

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

import org.eclipse.ltk.core.refactoring.Refactoring;
import org.eclipse.ltk.core.refactoring.RefactoringContribution;
import org.eclipse.ltk.core.refactoring.RefactoringCore;
import org.eclipse.ltk.core.refactoring.RefactoringDescriptor;
import org.eclipse.ltk.core.refactoring.RefactoringStatus;
import org.eclipse.ltk.core.refactoring.participants.RenameRefactoring;
import org.eclipse.ltk.internal.core.refactoring.BasicElementLabels;
import org.eclipse.ltk.internal.core.refactoring.Messages;
import org.eclipse.ltk.internal.core.refactoring.RefactoringCoreMessages;
import org.eclipse.ltk.internal.core.refactoring.resource.RenameResourceProcessor;

Refactoring descriptor for the rename resource refactoring.
 An instance of this refactoring descriptor may be obtained by calling RefactoringContribution.createDescriptor() on a refactoring contribution requested by invoking RefactoringCore.getRefactoringContribution(String) with the refactoring id (ID). 

Note: this class is not intended to be subclassed or instantiated by clients.

Since: 3.4
@noinstantiate This class is not intended to be instantiated by clients./**
 * Refactoring descriptor for the rename resource refactoring.
 * <p>
 * An instance of this refactoring descriptor may be obtained by calling
 * {@link RefactoringContribution#createDescriptor()} on a refactoring
 * contribution requested by invoking
 * {@link RefactoringCore#getRefactoringContribution(String)} with the
 * refactoring id ({@link #ID}).
 * </p>
 * <p>
 * Note: this class is not intended to be subclassed or instantiated by clients.
 * </p>
 *
 * @since 3.4
 *
 * @noinstantiate This class is not intended to be instantiated by clients.
 */
public final class RenameResourceDescriptor extends RefactoringDescriptor {

	Refactoring id of the 'Rename Resource' refactoring (value:
org.eclipse.ltk.core.refactoring.rename.resource).
 Clients may safely cast the obtained refactoring descriptor to RenameResourceDescriptor. 
/**
	 * Refactoring id of the 'Rename Resource' refactoring (value:
	 * <code>org.eclipse.ltk.core.refactoring.rename.resource</code>).
	 * <p>
	 * Clients may safely cast the obtained refactoring descriptor to
	 * {@link RenameResourceDescriptor}.
	 * </p>
	 */
	public static final String ID= "org.eclipse.ltk.core.refactoring.rename.resource"; //$NON-NLS-1$


	The name attribute /** The name attribute */
	private String fNewName;

	The resource path attribute (full path) /** The resource path attribute (full path) */
	private IPath fResourcePath;

	Configures if references will be updated /** Configures if references will be updated */
	private boolean fUpdateReferences;

	Creates a new refactoring descriptor.
 Clients should not instantiated this class but use RefactoringCore.getRefactoringContribution(String) with ID to get the contribution that can create the descriptor. 
/**
	 * Creates a new refactoring descriptor.
	 * <p>
	 * Clients should not instantiated this class but use {@link RefactoringCore#getRefactoringContribution(String)}
	 * with {@link #ID} to get the contribution that can create the descriptor.
	 * </p>
	 */
	public RenameResourceDescriptor() {
		super(ID, null, RefactoringCoreMessages.RenameResourceDescriptor_unnamed_descriptor, null, RefactoringDescriptor.STRUCTURAL_CHANGE | RefactoringDescriptor.MULTI_CHANGE);
		fResourcePath= null;
		fNewName= null;
	}

	Sets the new name to rename the resource to.
Params: name – 
           the non-empty new name to set/**
	 * Sets the new name to rename the resource to.
	 *
	 * @param name
	 *            the non-empty new name to set
	 */
	public void setNewName(final String name) {
		Assert.isNotNull(name);
		Assert.isLegal(!"".equals(name), "Name must not be empty"); //$NON-NLS-1$//$NON-NLS-2$
		fNewName= name;
	}

	Returns the new name to rename the resource to.
Returns: 
           the new name to rename the resource to/**
	 * Returns the new name to rename the resource to.
	 *
	 * @return
	 *            the new name to rename the resource to
	 */
	public String getNewName() {
		return fNewName;
	}

	Sets the project name of this refactoring.
 Note: If the resource to be renamed is of type IResource.PROJECT, clients are required to to set the project name to null.


The default is to associate the refactoring with the workspace.

Params: project – 
           the non-empty project name to set, or null for
           the workspace
See Also: RefactoringDescriptor.getProject()/**
	 * Sets the project name of this refactoring.
	 * <p>
	 * Note: If the resource to be renamed is of type {@link IResource#PROJECT},
	 * clients are required to to set the project name to <code>null</code>.
	 * </p>
	 * <p>
	 * The default is to associate the refactoring with the workspace.
	 * </p>
	 *
	 * @param project
	 *            the non-empty project name to set, or <code>null</code> for
	 *            the workspace
	 *
	 * @see #getProject()
	 */
	@Override
	public void setProject(final String project) {
		super.setProject(project);
	}

	Sets the resource to be renamed.
 Note: If the resource to be renamed is of type IResource.PROJECT, clients are required to to set the project name to null.

Params: resourcePath – 
           the resource to be renamed/**
	 * Sets the resource to be renamed.
	 * <p>
	 * Note: If the resource to be renamed is of type {@link IResource#PROJECT},
	 * clients are required to to set the project name to <code>null</code>.
	 * </p>
	 *
	 * @param resourcePath
	 *            the resource to be renamed
	 */
	public void setResourcePath(IPath resourcePath) {
		Assert.isNotNull(resourcePath);
		fResourcePath= resourcePath;
	}

	Returns the path of the resource to rename.
Returns: 
         the path of the resource to rename/**
	 * Returns the path of the resource to rename.
	 *
	 * @return
	 *          the path of the resource to rename
	 */
	public IPath getResourcePath() {
		return fResourcePath;
	}

		If set to true, this rename will also update references. The default is to update references.
Params: updateReferences –  true if this rename will update references/**
	 * 	If set to <code>true</code>, this rename will also update references. The default is to update references.
	 *
	 * @param updateReferences  <code>true</code> if this rename will update references
	 */
	public void setUpdateReferences(boolean updateReferences) {
		fUpdateReferences= updateReferences;
	}

	Returns if this rename will also update references
Returns: returns true if this rename will update references/**
	 * Returns if this rename will also update references
	 *
	 * @return returns <code>true</code> if this rename will update references
	 */
	public boolean isUpdateReferences() {
		return fUpdateReferences;
	}

	@Override
	public Refactoring createRefactoring(RefactoringStatus status) throws CoreException {
		IPath resourcePath= getResourcePath();
		if (resourcePath == null) {
			status.addFatalError(RefactoringCoreMessages.RenameResourceDescriptor_error_path_not_set);
			return null;
		}

		IResource resource= ResourcesPlugin.getWorkspace().getRoot().findMember(resourcePath);
		if (resource == null || !resource.exists()) {
			status.addFatalError(Messages.format(RefactoringCoreMessages.RenameResourceDescriptor_error_resource_not_existing, BasicElementLabels.getPathLabel(resourcePath, false)));
			return null;
		}

		String newName= getNewName();
		if (newName == null || newName.length() == 0) {
			status.addFatalError(RefactoringCoreMessages.RenameResourceDescriptor_error_name_not_defined);
			return null;
		}
		RenameResourceProcessor processor= new RenameResourceProcessor(resource);
		processor.setNewResourceName(newName);
		processor.setUpdateReferences(isUpdateReferences());

		return new RenameRefactoring(processor);
	}
}
Since:	3.4
@noinstantiate	This class is not intended to be instantiated by clients.
Params:	project – the non-empty project name to set, or `null` for the workspace
See Also:	RefactoringDescriptor.getProject()
/

org.eclipse.platform/ org.eclipse.ltk.core.refactoring/ 3.10.300/ org/eclipse/ltk/core/refactoring/resource/RenameResourceDescriptor.java
