File: cleanUps.exsd

package info (click to toggle)
eclipse-jdt-ui 4.29-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 93,280 kB
  • sloc: java: 831,977; xml: 14,578; jsp: 33; makefile: 5
file content (228 lines) | stat: -rw-r--r-- 8,588 bytes parent folder | download | duplicates (4) 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
 
<?xml version='1.0' encoding='UTF-8'?>
<!-- Schema file written by PDE -->
<schema targetNamespace="org.eclipse.jdt.ui" xmlns="http://www.w3.org/2001/XMLSchema">
<annotation>
      <appinfo>
         <meta.schema plugin="org.eclipse.jdt.ui" id="cleanUps" name="Clean Ups"/>
      </appinfo>
      <documentation>
         This extension point allows to add clean ups that can solve problems in a compilation unit.
      </documentation>
   </annotation>

   <element name="extension">
      <annotation>
         <appinfo>
            <meta.element />
         </appinfo>
      </annotation>
      <complexType>
         <sequence>
            <element ref="cleanUp" minOccurs="0" maxOccurs="unbounded"/>
            <element ref="cleanUpConfigurationUI" minOccurs="0" maxOccurs="unbounded"/>
            <element ref="cleanUpOptionsInitializer" minOccurs="0" maxOccurs="unbounded"/>
         </sequence>
         <attribute name="point" type="string" use="required">
            <annotation>
               <documentation>
                  a fully qualified identifier of the target extension point
               </documentation>
            </annotation>
         </attribute>
         <attribute name="id" type="string">
            <annotation>
               <documentation>
                  an optional identifier of the extension instance
               </documentation>
            </annotation>
         </attribute>
         <attribute name="name" type="string">
            <annotation>
               <documentation>
                  an optional name of the extension instance
               </documentation>
               <appinfo>
                  <meta.attribute translatable="true"/>
               </appinfo>
            </annotation>
         </attribute>
      </complexType>
   </element>

   <element name="cleanUp">
      <complexType>
         <attribute name="class" type="string" use="required">
            <annotation>
               <documentation>
                  the fully qualified class name implementing the interface &lt;code&gt;org.eclipse.jdt.ui.cleanup.ICleanUp&lt;/code&gt;
               </documentation>
               <appinfo>
                  <meta.attribute kind="java" basedOn=":org.eclipse.jdt.ui.cleanup.ICleanUp"/>
               </appinfo>
            </annotation>
         </attribute>
         <attribute name="id" type="string" use="required">
            <annotation>
               <documentation>
                  a unique id that will be used to identify this clean up
               </documentation>
            </annotation>
         </attribute>
         <attribute name="runAfter" type="string">
            <annotation>
               <documentation>
                  optional clean up id specifying that this clean up should run after it
               </documentation>
               <appinfo>
                  <meta.attribute kind="identifier" basedOn="org.eclipse.jdt.ui.cleanUps/cleanUp/@id"/>
               </appinfo>
            </annotation>
         </attribute>
      </complexType>
   </element>

   <element name="cleanUpConfigurationUI">
      <annotation>
         <documentation>
            A clean up configuration UI for the given clean up kind. Each contributed clean up &lt;strong&gt;must at least provide UI that allows to disable it&lt;/strong&gt;.
         </documentation>
      </annotation>
      <complexType>
         <attribute name="name" type="string" use="required">
            <annotation>
               <documentation>
                  a name that allows to identify this configuration in the UI
               </documentation>
               <appinfo>
                  <meta.attribute translatable="true"/>
               </appinfo>
            </annotation>
         </attribute>
         <attribute name="class" type="string" use="required">
            <annotation>
               <documentation>
                  the fully qualified class name implementing the interface &lt;code&gt;org.eclipse.jdt.ui.cleanup.ICleanUpConfigurationUI&lt;/code&gt;
               </documentation>
               <appinfo>
                  <meta.attribute kind="java" basedOn=":org.eclipse.jdt.ui.cleanup.ICleanUpConfigurationUI"/>
               </appinfo>
            </annotation>
         </attribute>
         <attribute name="cleanUpKind" use="required">
            <annotation>
               <documentation>
                  The kind of clean up this configuration UI configures. Currently only the following are supported:
&lt;ul&gt;
 &lt;li&gt;cleanUp: a normal clean up&lt;/li&gt;
 &lt;li&gt;saveAction: a clean up executed on save in the Java editor&lt;/li&gt;
&lt;/ul&gt;
               </documentation>
            </annotation>
            <simpleType>
               <restriction base="string">
                  <enumeration value="cleanUp">
                  </enumeration>
                  <enumeration value="saveAction">
                  </enumeration>
               </restriction>
            </simpleType>
         </attribute>
      </complexType>
   </element>

   <element name="cleanUpOptionsInitializer">
      <annotation>
         <documentation>
            An options initializer that returns default options for a clean up kind. Each clean up will consult all contributed initializers to check whether it is enabled.
         </documentation>
      </annotation>
      <complexType>
         <attribute name="cleanUpKind" use="required">
            <annotation>
               <documentation>
                  The kind of clean up this initializer initializes. Currently only the following are supported:&lt;br&gt;
&lt;ul&gt;
 &lt;li&gt;cleanUp: a normal clean up&lt;/li&gt;
 &lt;li&gt;saveAction: a clean up executed on save in the Java editor&lt;/li&gt;
&lt;/ul&gt;
               </documentation>
            </annotation>
            <simpleType>
               <restriction base="string">
                  <enumeration value="cleanUp">
                  </enumeration>
                  <enumeration value="saveAction">
                  </enumeration>
               </restriction>
            </simpleType>
         </attribute>
         <attribute name="class" type="string" use="required">
            <annotation>
               <documentation>
                  the fully qualified class name implementing the interface &lt;code&gt;org.eclipse.jdt.ui.cleanup.ICleanUpOptionsInitializer&lt;/code&gt;
               </documentation>
               <appinfo>
                  <meta.attribute kind="java" basedOn=":org.eclipse.jdt.ui.cleanup.ICleanUpOptionsInitializer"/>
               </appinfo>
            </annotation>
         </attribute>
      </complexType>
   </element>

   <annotation>
      <appinfo>
         <meta.section type="since"/>
      </appinfo>
      <documentation>
         3.5
      </documentation>
   </annotation>

   <annotation>
      <appinfo>
         <meta.section type="examples"/>
      </appinfo>
      <documentation>
         The following is an example of a clean up that updates a copyright on save:

&lt;p&gt;
&lt;pre&gt;
   &lt;extension
         point=&quot;org.eclipse.jdt.ui.cleanUps&quot;&gt;
      &lt;cleanUp
            id=&quot;org.eclipse.jdt.copyrightsaveaction.copyright_clean_up&quot;
            class=&quot;org.eclipse.jdt.ui.internal.copyrightupdater.CopyrightUpdaterCleanUp&quot;&gt;
      &lt;/cleanUp&gt;
      
      &lt;cleanUpOptionsInitializer
            class=&quot;org.eclipse.jdt.ui.internal.copyrightupdater.CopyrightOnSaveOptionsInitializer&quot;
            cleanUpKind=&quot;saveAction&quot;&gt;
      &lt;/cleanUpOptionsInitializer&gt;
      
      &lt;cleanUpConfigurationUI
            class=&quot;org.eclipse.jdt.ui.internal.copyrightupdater.CopyrightTabPage&quot;
            name=&quot;%cleanUpConfigurationUI.name&quot;
            cleanUpKind=&quot;saveAction&quot;&gt;
      &lt;/cleanUpConfigurationUI&gt;
   &lt;/extension&gt;
&lt;/pre&gt;
&lt;/p&gt;
      </documentation>
   </annotation>



   <annotation>
      <appinfo>
         <meta.section type="copyright"/>
      </appinfo>
      <documentation>
         Copyright (c) 2008, 2009 IBM Corporation and others.&lt;br&gt;

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 &lt;a href=&quot;https://www.eclipse.org/legal/epl-2.0&quot;&gt;https://www.eclipse.org/legal/epl-v20.html&lt;/a&gt;/

SPDX-License-Identifier: EPL-2.0
      </documentation>
   </annotation>

</schema>