schema.changeMethodSignatureParticipants.exsd Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of org.eclipse.jdt.core.manipulation Show documentation
Java Code Manipulation Functionality
There is a newer version: 1.21.200
Show newest version




      
         
      
      
         This extension point is used to define change method signature refactoring participants.

<p>
This extension point supports the <code>&lt;enablement&gt;</code> element.
<!-- see org.eclipse.ltk.core.refactoring.participants.ParticipantExtensionPoint#createEvaluationContext(..): -->
The default variable is the <code>org.eclipse.jdt.core.IMethod</code> to be changed.
<br>Defined variables for <code>&lt;with&gt;</code> expressions are:
</p>
<ul>
<li>"element": type <code>org.eclipse.jdt.core.IMethod</code>; the method to be changed (same as the default variable)</li>
<li>"affectedNatures": type <code>java.util.List&lt;String&gt;</code>; the natures of all projects affected by the refactoring</li>
<li>"processorIdentifier": type <code>java.lang.String</code>; the id of the refactoring processor that will own the participant</li>
</ul>
      
   

   

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

   
      
         
            
         
         
            
               
                  unique identifier for the change method signature participant.
               
            
         
         
            
               
                  a human reabable name of the change method signature participant
               
               
                  
               
            
         
         
            
               
                  the name of the class that provides the participant implementation. Must extend <code>org.eclipse.jdt.core.refactoring.participants.ChangeMethodSignatureParticipant</code>
               
               
                  
               
            
         
      
   

   
      
         
      
      
         3.4
      
   

   
      
         
      
      
         The example below defines a change method signature participant.
The participant is enabled if one of the project affected by the refactoring has a
Java nature and when the method to be changed is in a JUnit test.

<pre>
<changeMethodSignatureParticipant
    id="org.eclipse.example.myChangeMethodSignatureParticipant"
    name="My Change Method Signature Participant" 
    class="org.eclipse.example.MyChangeMethodSignatureParticipant">
    <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>
</changeMethodSignatureParticipant>
</pre>
      
   

   
      
         
      
      
         The contributed class must extend <code>org.eclipse.jdt.core.refactoring.participants.ChangeMethodSignatureParticipant</code>
      
   


   
      
         
      
      
         Copyright (c) 2007, 2013 IBM Corporation and others.<br>

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 <a href="https://www.eclipse.org/legal/epl-2.0">https://www.eclipse.org/legal/epl-v20.html</a>/

SPDX-License-Identifier: EPL-2.0