Create Participants
Identifier:
org.eclipse.ltk.core.refactoring.createParticipants
Since:
3.0
Description:
This extension point is used to define refactoring create participants. The reader of the expression provides the following predefined variables which can be referenced via the <with variable="..."> expression element:
- Object element: the element to be create or a corresponding descriptor
- List<String> affectedNatures: a list containing the natures of the projects affected
by the refactoring
- String processorId: the id of the refactoring processor that will own the participant.
The default variable used during expression evaluation is bound to the element variable.
Configuration Markup:
<!ELEMENT extension (createParticipant*)>
<!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 createParticipant (enablement)>
<!ATTLIST createParticipant
id CDATA #REQUIRED
name CDATA #REQUIRED
class CDATA #REQUIRED>
- id - unique identifier for the create participant.
- name - a human reabable name of the create participant
- class - the name of the class that provides the participant implementation.
Examples:
The example below defines a create participant. The participant is enabled if one of the project affected by the refactoring has a Java nature and when the element to be created is a folder.
<createParticipant
id=
"org.myCompany.createParticipant"
name=
"%CreateParticipant.name"
class=
"org.myCompany.CreateParticipant"
>
<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.IFolder"
/>
</with>
</enablement>
</createParticipant>
API Information:
The contributed class must extend org.eclipse.ltk.core.refactoring.participants.CreateParticipant
Copyright (c) 2001, 2004 IBM Corporation and others.
All rights reserved. This program and the accompanying materials are made available under the terms of the Eclipse Public License v1.0 which accompanies this distribution, and is available at http://www.eclipse.org/legal/epl-v10.html