spoon.refactoring.CtRenameRefactoring Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of spoon-core Show documentation

Spoon is a tool for meta-programming, analysis and transformation of Java programs.

There is a newer version: 11.1.1-beta-14

/*
 * SPDX-License-Identifier: (MIT OR CECILL-C)
 *
 * Copyright (C) 2006-2023 INRIA and contributors
 *
 * Spoon is available either under the terms of the MIT License (see LICENSE-MIT.txt) or the Cecill-C License (see LICENSE-CECILL-C.txt). You as the user are entitled to choose the terms under which to adopt Spoon.
 */
package spoon.refactoring;

import spoon.reflect.declaration.CtNamedElement;

/**
 * The kind of refactoring, which renames a `target` element
 * to the `newName`

 * Usage:

 *  * CtVariable someVariable = ...
 * new SomeRenameRefactoring().setTarget(someVariable).setNewName("mutchBetterName").refactor();
 * 
 */
public interface CtRenameRefactoring extends CtRefactoring {
	/**
	 * @return target model element, which has to be refactored.
	 */
	T getTarget();
	/**
	 * @param target the model element, which has to be refactored.
	 * @return this to support fluent API
	 */
	CtRenameRefactoring setTarget(T target);

	/**
	 * @return the required name of the `target` model element
	 */
	String getNewName();
	/**
	 * @param newName the required name of the `target` model element
	 * @return this to support fluent API
	 */
	CtRenameRefactoring setNewName(String newName);
}