Compilation Participants

Identifier:
org.eclipse.jdt.core.compilationParticipant

Since:
3.2

Description:
This extension point allows clients to participate in the compilation process by receiving notifications at various stages of build and reconcile, via a org.eclipse.jdt.core.compiler.CompilationParticipant.

Configuration Markup:

<!ELEMENT extension (compilationParticipant*)>

<!ATTLIST extension

point CDATA #REQUIRED

id    CDATA #IMPLIED

name  CDATA #IMPLIED

>


<!ELEMENT compilationParticipant (requires* , managedMarker*)>

<!ATTLIST compilationParticipant

class               CDATA #REQUIRED

id                  CDATA #REQUIRED

modifiesEnvironment (true | false)

createsProblems     (true | false)

requiredSourceLevel CDATA #IMPLIED

>

definition of a compilation participant. This definition allows to order participants. Participants are run by group. The group of participants that modify the environment is run first, then the group of participants that create problems is run, finally the group of other participants is run. Inside each group, participants are ordered using their 'requires' attributes. If a 'requires' attribute point to a participant that doesn't belong to the group, it is ignored.



<!ELEMENT requires EMPTY>

<!ATTLIST requires

id CDATA #REQUIRED

>

a participant that is required to run this compilation participant



<!ELEMENT managedMarker EMPTY>

<!ATTLIST managedMarker

markerType CDATA #REQUIRED

>

a managed marker is created from the recorded problems (see BuildContext#recordNewProblems(CategorizedProblem[])) and is removed when the corresponding source file is re-built or when the project is cleaned



Examples:
Example of a declaration of a compilationParticipant:
                                                                       
<extension
      id="apt"
      name="%annotationProcessingName"
      point="org.eclipse.jdt.core.compilationParticipant">
   <compilationParticipant
         class="org.eclipse.jdt.apt.core.internal.AptCompilationParticipant"
         id="APT"
         requiredSourceLevel="1.5">
      <managedMarker markerType="org.eclipse.jdt.apt.core.compile.problem"/>
   </compilationParticipant>
</extension>


Copyright (c) 2006 BEA Systems, Inc 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