Rename Participants

Identifier:

org.eclipse.ltk.core.refactoring.renameParticipants

Since:

3.0

Description:

This extension point is used to define refactoring rename participants.

This extension point supports the <enablement> element. The default variable is the element to be renamed.
Defined variables for <with> expressions are:

"element": type java.lang.Object; the element to be renamed (same as the default variable)
"affectedNatures": type java.util.List<String>; the natures of all projects affected by the refactoring
"processorIdentifier": type java.lang.String; the id of the refactoring processor that will own the participant

Configuration Markup:

<!ELEMENT extension (renameParticipant*)>

<!ATTLIST extension

point CDATA #REQUIRED

id CDATA #IMPLIED

name CDATA #IMPLIED>

point - a fully qualified identifier of the target extension point
id - an optional identifier of the extension instance
name - an optional name of the extension instance

<!ELEMENT renameParticipant (param* , enablement?)>

<!ATTLIST renameParticipant

id CDATA #REQUIRED

name CDATA #REQUIRED

class CDATA #REQUIRED>

id - unique identifier for the rename participant.
name - a human reabable name of the rename participant
class - the name of the class that provides the participant implementation.

<!ELEMENT param EMPTY>

<!ATTLIST param

name CDATA #REQUIRED

value CDATA #REQUIRED>

name - the name of the additional parameter
value - the value of the additional parameter

Examples:

The example below defines a rename participant that participates in a type rename. The participant is enabled if one of the project affected by the refactoring has a Java nature and when the type to be renamed is a JUnit test.


<renameParticipant
    id="org.eclipse.jdt.junit.renameTypeParticipant"
    name="%RenameTypeParticipant.name" 
    class="org.eclipse.jdt.internal.junit.ui.TypeRenameParticipant">
    <enablement>
      <with variable="affectedNatures">
        <iterate operator="or">
          <equals value="org.eclipse.jdt.core.javanature"/>
        </iterate>
      </with>
      <with variable="element">
        <instanceof value="org.eclipse.jdt.core.IType"/>
        <test property="org.eclipse.jdt.junit.isTest"/>
      </with>
    </enablement>
</renameParticipant>

API Information:

The contributed class must extend org.eclipse.ltk.core.refactoring.participants.RenameParticipant

Copyright (c) 2001, 2013 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-v20.html/ SPDX-License-Identifier: EPL-2.0