1 <?xml version='1.0' encoding='UTF-8'?>
2 <!-- Schema file written by PDE -->
3 <schema targetNamespace="org.eclipse.jdt.ui" xmlns="http://www.w3.org/2001/XMLSchema">
6 <meta.schema plugin="org.eclipse.jdt.ui" id="cleanUps" name="Clean Ups"/>
9 This extension point allows to add clean ups that can solve problems in a compilation unit.
13 <element name="extension">
21 <element ref="cleanUp" minOccurs="0" maxOccurs="unbounded"/>
22 <element ref="cleanUpConfigurationUI" minOccurs="0" maxOccurs="unbounded"/>
23 <element ref="cleanUpOptionsInitializer" minOccurs="0" maxOccurs="unbounded"/>
25 <attribute name="point" type="string" use="required">
28 a fully qualified identifier of the target extension point
32 <attribute name="id" type="string">
35 an optional identifier of the extension instance
39 <attribute name="name" type="string">
42 an optional name of the extension instance
45 <meta.attribute translatable="true"/>
52 <element name="cleanUp">
54 <attribute name="class" type="string" use="required">
57 the fully qualified class name implementing the interface <code>org.eclipse.jdt.ui.cleanup.ICleanUp</code>
60 <meta.attribute kind="java" basedOn=":org.eclipse.jdt.ui.cleanup.ICleanUp"/>
64 <attribute name="id" type="string" use="required">
67 a unique id that will be used to identify this clean up
71 <attribute name="runAfter" type="string">
74 optional clean up id specifying that this clean up should run after it
77 <meta.attribute kind="identifier" basedOn="org.eclipse.jdt.ui.cleanUps/cleanUp/@id"/>
84 <element name="cleanUpConfigurationUI">
87 A clean up configuration UI for the given clean up kind. Each contributed clean up <strong>must at least provide UI that allows to disable it</strong>.
91 <attribute name="name" type="string" use="required">
94 a name that allows to identify this configuration in the UI
97 <meta.attribute translatable="true"/>
101 <attribute name="class" type="string" use="required">
104 the fully qualified class name implementing the interface <code>org.eclipse.jdt.ui.cleanup.ICleanUpConfigurationUI</code>
107 <meta.attribute kind="java" basedOn=":org.eclipse.jdt.ui.cleanup.ICleanUpConfigurationUI"/>
111 <attribute name="cleanUpKind" use="required">
114 The kind of clean up this configuration UI configures. Currently only the following are supported:
116 <li>cleanUp: a normal clean up</li>
117 <li>saveAction: a clean up executed on save in the Java editor</li>
122 <restriction base="string">
123 <enumeration value="cleanUp">
125 <enumeration value="saveAction">
133 <element name="cleanUpOptionsInitializer">
136 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.
140 <attribute name="cleanUpKind" use="required">
143 The kind of clean up this initializer initializes. Currently only the following are supported:<br>
145 <li>cleanUp: a normal clean up</li>
146 <li>saveAction: a clean up executed on save in the Java editor</li>
151 <restriction base="string">
152 <enumeration value="cleanUp">
154 <enumeration value="saveAction">
159 <attribute name="class" type="string" use="required">
162 the fully qualified class name implementing the interface <code>org.eclipse.jdt.ui.cleanup.ICleanUpOptionsInitializer</code>
165 <meta.attribute kind="java" basedOn=":org.eclipse.jdt.ui.cleanup.ICleanUpOptionsInitializer"/>
174 <meta.section type="since"/>
183 <meta.section type="examples"/>
186 The following is an example of a clean up that updates a copyright on save:
191 point="org.eclipse.jdt.ui.cleanUps">
193 id="org.eclipse.jdt.copyrightsaveaction.copyright_clean_up"
194 class="org.eclipse.jdt.ui.internal.copyrightupdater.CopyrightUpdaterCleanUp">
197 <cleanUpOptionsInitializer
198 class="org.eclipse.jdt.ui.internal.copyrightupdater.CopyrightOnSaveOptionsInitializer"
199 cleanUpKind="saveAction">
200 </cleanUpOptionsInitializer>
202 <cleanUpConfigurationUI
203 class="org.eclipse.jdt.ui.internal.copyrightupdater.CopyrightTabPage"
204 name="%cleanUpConfigurationUI.name"
205 cleanUpKind="saveAction">
206 </cleanUpConfigurationUI>
217 <meta.section type="copyright"/>
220 Copyright (c) 2008, 2009 IBM Corporation and others.<br>
221 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 <a href="http://www.eclipse.org/legal/epl-v10.html">http://www.eclipse.org/legal/epl-v10.html</a>