CtRefactoring.java

/**
 * Copyright (C) 2006-2017 INRIA and contributors
 * Spoon - http://spoon.gforge.inria.fr/
 *
 * This software is governed by the CeCILL-C License under French law and
 * abiding by the rules of distribution of free software. You can use, modify
 * and/or redistribute the software under the terms of the CeCILL-C license as
 * circulated by CEA, CNRS and INRIA at http://www.cecill.info.
 *
 * This program is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE. See the CeCILL-C License for more details.
 *
 * The fact that you are presently reading this means that you have had
 * knowledge of the CeCILL-C license and that you accept its terms.
 */
package spoon.refactoring;

/**
 * Defines basic contract of all refactoring implementations.<br>
 * Contract: to process a required refactoring.<br>
 * Usage:<br>
 * <pre>
 * SomeRefactoring r = new SomeRefactoring();
 * //configure refactoring by calling setters on `r`
 * r.refactor();
 * </pre>
 * See child interfaces, which implements other supported refactoring methods
 */
public interface CtRefactoring {
	/**
	 * Process refactoring operation
	 */
	void refactor();
}