schema.copyParticipants.exsd Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of org.eclipse.ltk.core.refactoring Show documentation
Refactoring Core
The newest version!




      
         
      
      
         This extension point is used to define refactoring copy 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 element to be copied.
<br>Defined variables for <code>&lt;with&gt;</code> expressions are:
</p>
<ul>
<li>"element": type <code>java.lang.Object</code>; the element to be copied (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 copy participant.
               
            
         
         
            
               
                  a human reabable name of the copy participant
               
               
                  
               
            
         
         
            
               
                  the name of the class that provides the participant implementation.
               
               
                  
               
            
         
         
            
               
                  if true the change created by the participant will be executed even if
                  the overall change got canceled.
               
               
                  
               
            
         
      
   

   
      
         
      
      
         The example below defines a participant for copying files. The participant is enabled if one of the project affected by the refactoring has a Java nature.

<pre>
<copyParticipant
    id="org.eclipse.samples.copyParticipant"
    name="%CopyFileParticipant.name" 
    class="org.eclipse.samples.CopyFileParticipant">
    <enablement>
      <with variable="affectedNatures">
        <iterate operator="or">
          <equals value="org.eclipse.jdt.core.javanature"/>
        </iterate>
      </with>
      <with variable="element">
        <instanceof value="org.eclipse.core.resources.IFile"/>
      </with>
    </enablement>
</copyParticipant>
</pre>
      
   

   
      
         
      
      
         3.1
      
   

   
      
         
      
      
         The contributed class must extend <code>org.eclipse.ltk.core.refactoring.participants.CopyParticipant</code>
      
   

   
      
         
      
      
         
      
   

   
      
         
      
      
         Copyright (c) 2001, 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