Copyright (c) 2005, 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) 2005, 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.jdt.core.refactoring;
import org.eclipse.core.runtime.Assert;
import org.eclipse.ltk.core.refactoring.participants.RenameArguments;
import org.eclipse.jdt.core.IJavaElement;
Rename type arguments describe the data that a rename type processor
provides to its rename type participants.
This class is not intended to be subclassed by clients.
Since: 1.0 @noextend This class is not intended to be subclassed by clients.
/**
* Rename type arguments describe the data that a rename type processor
* provides to its rename type participants.
* <p>
* This class is not intended to be subclassed by clients.
* </p>
*
* @since 1.0
* @noextend This class is not intended to be subclassed by clients.
*/
public class RenameTypeArguments extends RenameArguments {
private boolean updateSimilarDeclarations;
private IJavaElement[] similarDeclarations;
Creates new rename type arguments.
Params: - newName – the new name of the element to be renamed
- updateReferences –
true
if reference
updating is requested; false
otherwise - updateSimilarDeclarations –
true
if similar
declaration updating is requested; false
otherwise - similarDeclarations – the similar declarations that will be
updated or
null
if similar declaration updating is
not requested
/**
* Creates new rename type arguments.
*
* @param newName the new name of the element to be renamed
* @param updateReferences <code>true</code> if reference
* updating is requested; <code>false</code> otherwise
* @param updateSimilarDeclarations <code>true</code> if similar
* declaration updating is requested; <code>false</code> otherwise
* @param similarDeclarations the similar declarations that will be
* updated or <code>null</code> if similar declaration updating is
* not requested
*/
public RenameTypeArguments(String newName, boolean updateReferences, boolean updateSimilarDeclarations,
IJavaElement[] similarDeclarations) {
super(newName, updateReferences);
if (updateSimilarDeclarations) {
Assert.isNotNull(similarDeclarations);
}
this.updateSimilarDeclarations= updateSimilarDeclarations;
this.similarDeclarations= similarDeclarations;
}
Returns whether similar declaration updating is requested or not.
Returns: returns true
if similar declaration
updating is requested; false
otherwise
/**
* Returns whether similar declaration updating is requested or not.
*
* @return returns <code>true</code> if similar declaration
* updating is requested; <code>false</code> otherwise
*/
public boolean getUpdateSimilarDeclarations() {
return updateSimilarDeclarations;
}
Returns the similar declarations that get updated. Returns
null
if similar declaration updating is not
requested.
Returns: the similar elements that get updated
/**
* Returns the similar declarations that get updated. Returns
* <code>null</code> if similar declaration updating is not
* requested.
*
* @return the similar elements that get updated
*/
public IJavaElement[] getSimilarDeclarations() {
return similarDeclarations;
}
@Override
public String toString() {
return super.toString()
+ (updateSimilarDeclarations ? " (update derived elements)" : " (don't update derived elements)"); //$NON-NLS-1$//$NON-NLS-2$
}
}