Stephan Herrmann | 7b7062f | 2010-04-01 19:56:59 +0000 | [diff] [blame] | 1 | <?xml version='1.0' encoding='UTF-8'?> |
| 2 | <!-- Schema file written by PDE --> |
| 3 | <schema targetNamespace="org.eclipse.jdt.core"> |
| 4 | <annotation> |
| 5 | <appInfo> |
| 6 | <meta.schema plugin="org.eclipse.jdt.core" id="compilationParticipant" name="Compilation Participants"/> |
| 7 | </appInfo> |
| 8 | <documentation> |
| 9 | 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. |
| 10 | </documentation> |
| 11 | </annotation> |
| 12 | |
| 13 | <element name="extension"> |
| 14 | <complexType> |
| 15 | <sequence> |
| 16 | <element ref="compilationParticipant" minOccurs="0" maxOccurs="unbounded"/> |
| 17 | </sequence> |
| 18 | <attribute name="point" type="string" use="required"> |
| 19 | <annotation> |
| 20 | <documentation> |
| 21 | |
| 22 | </documentation> |
| 23 | </annotation> |
| 24 | </attribute> |
| 25 | <attribute name="id" type="string"> |
| 26 | <annotation> |
| 27 | <documentation> |
| 28 | |
| 29 | </documentation> |
| 30 | </annotation> |
| 31 | </attribute> |
| 32 | <attribute name="name" type="string"> |
| 33 | <annotation> |
| 34 | <documentation> |
| 35 | |
| 36 | </documentation> |
| 37 | <appInfo> |
| 38 | <meta.attribute translatable="true"/> |
| 39 | </appInfo> |
| 40 | </annotation> |
| 41 | </attribute> |
| 42 | </complexType> |
| 43 | </element> |
| 44 | |
| 45 | <element name="compilationParticipant"> |
| 46 | <annotation> |
| 47 | <documentation> |
| 48 | 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. |
| 49 | </documentation> |
| 50 | </annotation> |
| 51 | <complexType> |
| 52 | <sequence> |
| 53 | <element ref="requires" minOccurs="0" maxOccurs="unbounded"/> |
| 54 | <element ref="managedMarker" minOccurs="0" maxOccurs="unbounded"/> |
| 55 | </sequence> |
| 56 | <attribute name="class" type="string" use="required"> |
| 57 | <annotation> |
| 58 | <documentation> |
| 59 | the class that implements this compilation participant. This class must implement a public subclass of <code>org.eclipse.jdt.core.compiler.CompilationParticipant</code> with a public 0-argument constructor. |
| 60 | </documentation> |
| 61 | <appInfo> |
| 62 | <meta.attribute kind="java" basedOn="org.eclipse.jdt.core.compiler.CompilationParticipant"/> |
| 63 | </appInfo> |
| 64 | </annotation> |
| 65 | </attribute> |
| 66 | <attribute name="id" type="string" use="required"> |
| 67 | <annotation> |
| 68 | <documentation> |
| 69 | a unique identifier for this participant |
| 70 | </documentation> |
| 71 | </annotation> |
| 72 | </attribute> |
| 73 | <attribute name="modifiesEnvironment" type="boolean"> |
| 74 | <annotation> |
| 75 | <documentation> |
| 76 | optionally specify whether this compilation participant modifies the environment, thus affecting binding resolution. If not specified, false is assumed. |
| 77 | </documentation> |
| 78 | </annotation> |
| 79 | </attribute> |
| 80 | <attribute name="createsProblems" type="boolean"> |
| 81 | <annotation> |
| 82 | <documentation> |
| 83 | optionally specifies whether this compilation participant creates problems. If not specified, false is assumed. |
| 84 | </documentation> |
| 85 | </annotation> |
| 86 | </attribute> |
| 87 | <attribute name="requiredSourceLevel" type="string"> |
| 88 | <annotation> |
| 89 | <documentation> |
| 90 | the required source level this participant needs (one of the JavaCore.VERSION* constants). If a project's source level is below this required source level, the participant will not be invoked. If this attribute is not specified, the participant will be invoked for any source level. |
| 91 | </documentation> |
| 92 | </annotation> |
| 93 | </attribute> |
| 94 | </complexType> |
| 95 | </element> |
| 96 | |
| 97 | <element name="requires"> |
| 98 | <annotation> |
| 99 | <documentation> |
| 100 | a participant that is required to run this compilation participant |
| 101 | </documentation> |
| 102 | </annotation> |
| 103 | <complexType> |
| 104 | <attribute name="id" type="string" use="required"> |
| 105 | <annotation> |
| 106 | <documentation> |
| 107 | the unique identifier of the participant that is required |
| 108 | </documentation> |
| 109 | </annotation> |
| 110 | </attribute> |
| 111 | </complexType> |
| 112 | </element> |
| 113 | |
| 114 | <element name="managedMarker"> |
| 115 | <annotation> |
| 116 | <documentation> |
| 117 | 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 |
| 118 | </documentation> |
| 119 | </annotation> |
| 120 | <complexType> |
| 121 | <attribute name="markerType" type="string" use="required"> |
| 122 | <annotation> |
| 123 | <documentation> |
| 124 | the type of the managed marker |
| 125 | </documentation> |
| 126 | </annotation> |
| 127 | </attribute> |
| 128 | </complexType> |
| 129 | </element> |
| 130 | |
| 131 | <annotation> |
| 132 | <appInfo> |
| 133 | <meta.section type="since"/> |
| 134 | </appInfo> |
| 135 | <documentation> |
| 136 | 3.2 |
| 137 | </documentation> |
| 138 | </annotation> |
| 139 | |
| 140 | <annotation> |
| 141 | <appInfo> |
| 142 | <meta.section type="examples"/> |
| 143 | </appInfo> |
| 144 | <documentation> |
| 145 | Example of a declaration of a <code>compilationParticipant</code>: <pre> |
| 146 | <extension |
| 147 | id="apt" |
| 148 | name="%annotationProcessingName" |
| 149 | point="org.eclipse.jdt.core.compilationParticipant"> |
| 150 | <compilationParticipant |
| 151 | class="org.eclipse.jdt.apt.core.internal.AptCompilationParticipant" |
| 152 | id="APT" |
| 153 | requiredSourceLevel="1.5"> |
| 154 | <managedMarker markerType="org.eclipse.jdt.apt.core.compile.problem"/> |
| 155 | </compilationParticipant> |
| 156 | </extension> |
| 157 | </pre> |
| 158 | </documentation> |
| 159 | </annotation> |
| 160 | |
| 161 | <annotation> |
| 162 | <appInfo> |
| 163 | <meta.section type="apiInfo"/> |
| 164 | </appInfo> |
| 165 | <documentation> |
| 166 | |
| 167 | </documentation> |
| 168 | </annotation> |
| 169 | |
| 170 | <annotation> |
| 171 | <appInfo> |
| 172 | <meta.section type="implementation"/> |
| 173 | </appInfo> |
| 174 | <documentation> |
| 175 | |
| 176 | </documentation> |
| 177 | </annotation> |
| 178 | |
| 179 | <annotation> |
| 180 | <appInfo> |
| 181 | <meta.section type="copyright"/> |
| 182 | </appInfo> |
| 183 | <documentation> |
| 184 | Copyright (c) 2006 BEA Systems, Inc and others.<br> |
| 185 | All rights reserved. This program and the accompanying materials |
| 186 | are made available under the terms of the Eclipse Public License v1.0 |
| 187 | which accompanies this distribution, and is available at |
| 188 | <a href="http://www.eclipse.org/legal/epl-v10.html">http://www.eclipse.org/legal/epl-v10.html</a> |
| 189 | </documentation> |
| 190 | </annotation> |
| 191 | |
| 192 | </schema> |