/*******************************************************************************
* Copyright (c) 2006, 2015 Zend Technologies and others.
* All rights reserved. This program and the accompanying materials
* are 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:
* Zend Technologies - initial API and implementation
*******************************************************************************/
package org.eclipse.php.refactoring.core.rename;
import org.eclipse.core.runtime.CoreException;
import org.eclipse.ltk.core.refactoring.RefactoringStatus;
/**
* Represents processors in the JDT space that rename elements.
*/
public interface INameUpdating {
/**
* Sets new name for the entity that this refactoring is working on.
*/
public void setNewElementName(String newName);
/**
* Get the name for the entity that this refactoring is working on.
*/
public String getNewElementName();
/**
* Gets the current name of the entity that this refactoring is working on.
*/
public String getCurrentElementName();
/**
* Gets the original elements. Since an <code>INameUpdating</code> only
* renames one element, this method must return an array containing exactly
* one element.
*
* @return an array containing exactly one element
* @see org.eclipse.ltk.core.refactoring.participants.RefactoringProcessor#getElements()
*/
public Object[] getElements();
/**
* Gets the element after renaming.
*/
public Object getNewElement() throws CoreException;
/**
* Checks if the new name is valid for the entity that this refactoring
* renames.
*/
public RefactoringStatus checkNewElementName(String newName)
throws CoreException;
}