Copyright (c) 2000, 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) 2000, 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;
import org.eclipse.core.resources.IResource;
import org.eclipse.ltk.core.refactoring.participants.RefactoringProcessor;
An IResourceMapper
provides methods to map an original
resource to its refactored counterparts.
An IResourceMapper
can be obtained via PlatformObject.getAdapter(Class<Object>)
.
This interface is intended to be implemented by clients.
Since: 3.2
/**
* An <code>IResourceMapper</code> provides methods to map an original
* resource to its refactored counterparts.
* <p>
* An <code>IResourceMapper</code> can be obtained via
* {@link RefactoringProcessor#getAdapter(Class)}.
* </p>
* <p>
* This interface is intended to be implemented by clients.
* </p>
*
* @since 3.2
*/
public interface IResourceMapper {
Returns the refactored resource for the given element.
Note that the returned resource might not yet exist
when the method is called.
Params: - element – the resource to be refactored
Returns: the refactored element for the given element
/**
* Returns the refactored resource for the given element.
* <p>
* Note that the returned resource might not yet exist
* when the method is called.
* </p>
*
* @param element the resource to be refactored
*
* @return the refactored element for the given element
*/
IResource getRefactoredResource(IResource element);
}