KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > eclipse > jdt > internal > corext > fix > CleanUpConstants


1 /*******************************************************************************
2  * Copyright (c) 2000, 2007 IBM Corporation and others.
3  * All rights reserved. This program and the accompanying materials
4  * are made available under the terms of the Eclipse Public License v1.0
5  * which accompanies this distribution, and is available at
6  * http://www.eclipse.org/legal/epl-v10.html
7  *
8  * Contributors:
9  * IBM Corporation - initial API and implementation
10  * Alex Blewitt - https://bugs.eclipse.org/bugs/show_bug.cgi?id=168954
11  *******************************************************************************/
12 package org.eclipse.jdt.internal.corext.fix;
13
14 import java.util.HashMap JavaDoc;
15 import java.util.Iterator JavaDoc;
16 import java.util.Map JavaDoc;
17
18 import org.eclipse.jface.preference.IPreferenceStore;
19
20 import org.eclipse.jdt.core.formatter.DefaultCodeFormatterConstants;
21
22 import org.eclipse.jdt.internal.ui.preferences.cleanup.CleanUpProfileVersioner;
23
24 public class CleanUpConstants {
25     
26     /**
27      * False value
28      *
29      * @since 3.3
30      */
31     public static final String JavaDoc FALSE= "false"; //$NON-NLS-1$
32
33     /**
34      * True value
35      *
36      * @since 3.3
37      */
38     public static final String JavaDoc TRUE= "true"; //$NON-NLS-1$
39
40     /**
41      * Format Java Source Code <br>
42      * <br>
43      * Possible values: {TRUE, FALSE}<br>
44      * Default value: Value returned by {@link #getEclipseDefaultSettings()}<br>
45      * <br>
46      *
47      * @see #TRUE
48      * @see #FALSE
49      * @since 3.3
50      */
51     public static final String JavaDoc FORMAT_SOURCE_CODE= "cleanup.format_source_code"; //$NON-NLS-1$
52
53     /**
54      * Format comments. Specify which comment with:<br>
55      * {@link #FORMAT_JAVADOC}<br>
56      * {@link #FORMAT_MULTI_LINE_COMMENT}<br>
57      * {@link #FORMAT_SINGLE_LINE_COMMENT} <br>
58      * <br>
59      * Possible values: {TRUE, FALSE}<br>
60      * Default value: Value returned by {@link #getEclipseDefaultSettings()}<br>
61      * <br>
62      *
63      * @see #TRUE
64      * @see #FALSE
65      * @since 3.3
66      * @deprecated replaced by {@link #FORMAT_SOURCE_CODE}
67      */
68     public static final String JavaDoc FORMAT_COMMENT= "cleanup.format_comment"; //$NON-NLS-1$
69
70     /**
71      * Format single line comments. Only has an effect if
72      * {@link #FORMAT_COMMENT} is TRUE <br>
73      * <br>
74      * Possible values: {TRUE, FALSE}<br>
75      * Default value: Value returned by {@link #getEclipseDefaultSettings()}<br>
76      * <br>
77      *
78      * @see #TRUE
79      * @see #FALSE
80      * @since 3.3
81      * @deprecated replaced by {@link DefaultCodeFormatterConstants#FORMATTER_COMMENT_FORMAT_LINE_COMMENT}
82      */
83     public static final String JavaDoc FORMAT_SINGLE_LINE_COMMENT= "cleanup.format_single_line_comment"; //$NON-NLS-1$
84
85     /**
86      * Format multi line comments. Only has an effect if {@link #FORMAT_COMMENT}
87      * is TRUE <br>
88      * <br>
89      * Possible values: {TRUE, FALSE}<br>
90      * Default value: Value returned by {@link #getEclipseDefaultSettings()}<br>
91      * <br>
92      *
93      * @see #TRUE
94      * @see #FALSE
95      * @since 3.3
96      * @deprecated replaced by {@link DefaultCodeFormatterConstants#FORMATTER_COMMENT_FORMAT_BLOCK_COMMENT}
97      */
98     public static final String JavaDoc FORMAT_MULTI_LINE_COMMENT= "cleanup.format_multi_line_comment"; //$NON-NLS-1$
99
100     /**
101      * Format javadoc comments. Only has an effect if {@link #FORMAT_COMMENT} is
102      * TRUE <br>
103      * <br>
104      * Possible values: {TRUE, FALSE}<br>
105      * Default value: Value returned by {@link #getEclipseDefaultSettings()}<br>
106      * <br>
107      *
108      * @see #TRUE
109      * @see #FALSE
110      * @since 3.3
111      * @deprecated replaced by {@link DefaultCodeFormatterConstants#FORMATTER_COMMENT_FORMAT_JAVADOC_COMMENT}
112      */
113     public static final String JavaDoc FORMAT_JAVADOC= "cleanup.format_javadoc"; //$NON-NLS-1$
114
115     /**
116      * Removes trailing whitespace in compilation units<br>
117      * <br>
118      * Possible values: {TRUE, FALSE}<br>
119      * Default value: Value returned by {@link #getEclipseDefaultSettings()}<br>
120      * <br>
121      *
122      * @see #TRUE
123      * @see #FALSE
124      * @since 3.3
125      */
126     public static final String JavaDoc FORMAT_REMOVE_TRAILING_WHITESPACES= "cleanup.remove_trailing_whitespaces"; //$NON-NLS-1$
127
128     /**
129      * Removes trailing whitespace in compilation units on all lines<br>
130      * Only has an effect if {@link #FORMAT_REMOVE_TRAILING_WHITESPACES} is TRUE
131      * <br>
132      * <br>
133      * Possible values: {TRUE, FALSE}<br>
134      * Default value: Value returned by {@link #getEclipseDefaultSettings()}<br>
135      * <br>
136      *
137      * @see #TRUE
138      * @see #FALSE
139      * @since 3.3
140      */
141     public static final String JavaDoc FORMAT_REMOVE_TRAILING_WHITESPACES_ALL= "cleanup.remove_trailing_whitespaces_all"; //$NON-NLS-1$
142
143     /**
144      * Removes trailing whitespace in compilation units on all lines which
145      * contain an other characters then whitespace<br>
146      * Only has an effect if {@link #FORMAT_REMOVE_TRAILING_WHITESPACES} is TRUE
147      * <br>
148      * <br>
149      * Possible values: {TRUE, FALSE}<br>
150      * Default value: Value returned by {@link #getEclipseDefaultSettings()}<br>
151      * <br>
152      *
153      * @see #TRUE
154      * @see #FALSE
155      * @since 3.3
156      */
157     public static final String JavaDoc FORMAT_REMOVE_TRAILING_WHITESPACES_IGNORE_EMPTY= "cleanup.remove_trailing_whitespaces_ignore_empty"; //$NON-NLS-1$
158
159     /**
160      * Controls access qualifiers for instance fields. For detailed settings use<br>
161      * {@link #MEMBER_ACCESSES_NON_STATIC_FIELD_USE_THIS_ALWAYS}<br>
162      * {@link #MEMBER_ACCESSES_NON_STATIC_FIELD_USE_THIS_IF_NECESSARY} <br>
163      * <br>
164      * Possible values: {TRUE, FALSE}<br>
165      * Default value: Value returned by {@link #getEclipseDefaultSettings()}<br>
166      * <br>
167      *
168      * @see #TRUE
169      * @see #FALSE
170      * @since 3.3
171      */
172     public static final String JavaDoc MEMBER_ACCESSES_NON_STATIC_FIELD_USE_THIS= "cleanup.use_this_for_non_static_field_access"; //$NON-NLS-1$
173
174     /**
175      * Adds a 'this' qualifier to field accesses.
176      * <p>
177      * i.e.:
178      *
179      * <pre><code>
180      * int fField;
181      * void foo() {fField= 10;} -&gt; void foo() {this.fField= 10;}
182      * </pre></code> <br>
183      * Only has an effect if {@link #MEMBER_ACCESSES_NON_STATIC_FIELD_USE_THIS}
184      * is TRUE <br>
185      * <br>
186      * Possible values: {TRUE, FALSE}<br>
187      * Default value: Value returned by {@link #getEclipseDefaultSettings()}<br>
188      * <br>
189      *
190      * @see #TRUE
191      * @see #FALSE
192      * @since 3.3
193      */
194     public static final String JavaDoc MEMBER_ACCESSES_NON_STATIC_FIELD_USE_THIS_ALWAYS= "cleanup.always_use_this_for_non_static_field_access"; //$NON-NLS-1$
195
196     /**
197      * Removes 'this' qualifier to field accesses.
198      * <p>
199      * i.e.:
200      *
201      * <pre><code>
202      * int fField;
203      * void foo() {this.fField= 10;} -&gt; void foo() {fField= 10;}
204      * </pre></code> <br>
205      * Only has an effect if {@link #MEMBER_ACCESSES_NON_STATIC_FIELD_USE_THIS}
206      * is TRUE <br>
207      * <br>
208      * Possible values: {TRUE, FALSE}<br>
209      * Default value: Value returned by {@link #getEclipseDefaultSettings()}<br>
210      * <br>
211      *
212      * @see #TRUE
213      * @see #FALSE
214      * @since 3.3
215      */
216     public static final String JavaDoc MEMBER_ACCESSES_NON_STATIC_FIELD_USE_THIS_IF_NECESSARY= "cleanup.use_this_for_non_static_field_access_only_if_necessary"; //$NON-NLS-1$
217
218     /**
219      * Controls access qualifiers for instance methods. For detailed settings
220      * use<br>
221      * {@link #MEMBER_ACCESSES_NON_STATIC_METHOD_USE_THIS_ALWAYS}<br>
222      * {@link #MEMBER_ACCESSES_NON_STATIC_METHOD_USE_THIS_IF_NECESSARY} <br>
223      * <br>
224      * Possible values: {TRUE, FALSE}<br>
225      * Default value: Value returned by {@link #getEclipseDefaultSettings()}<br>
226      * <br>
227      *
228      * @see #TRUE
229      * @see #FALSE
230      * @since 3.3
231      */
232     public static final String JavaDoc MEMBER_ACCESSES_NON_STATIC_METHOD_USE_THIS= "cleanup.use_this_for_non_static_method_access"; //$NON-NLS-1$
233
234     /**
235      * Adds a 'this' qualifier to method accesses.
236      * <p>
237      * i.e.:
238      *
239      * <pre><code>
240      * int method(){};
241      * void foo() {method()} -&gt; void foo() {this.method();}
242      * </pre></code> <br>
243      * Only has an effect if {@link #MEMBER_ACCESSES_NON_STATIC_METHOD_USE_THIS}
244      * is TRUE <br>
245      * <br>
246      * Possible values: {TRUE, FALSE}<br>
247      * Default value: Value returned by {@link #getEclipseDefaultSettings()}<br>
248      * <br>
249      *
250      * @see #TRUE
251      * @see #FALSE
252      * @since 3.3
253      */
254     public static final String JavaDoc MEMBER_ACCESSES_NON_STATIC_METHOD_USE_THIS_ALWAYS= "cleanup.always_use_this_for_non_static_method_access"; //$NON-NLS-1$
255
256     /**
257      * Removes 'this' qualifier to field accesses.
258      * <p>
259      * i.e.:
260      *
261      * <pre><code>
262      * int fField;
263      * void foo() {this.fField= 10;} -&gt; void foo() {fField= 10;}
264      * </pre></code> <br>
265      * Only has an effect if {@link #MEMBER_ACCESSES_NON_STATIC_METHOD_USE_THIS}
266      * is TRUE <br>
267      * <br>
268      * Possible values: {TRUE, FALSE}<br>
269      * Default value: Value returned by {@link #getEclipseDefaultSettings()}<br>
270      * <br>
271      *
272      * @see #TRUE
273      * @see #FALSE
274      * @since 3.3
275      */
276     public static final String JavaDoc MEMBER_ACCESSES_NON_STATIC_METHOD_USE_THIS_IF_NECESSARY= "cleanup.use_this_for_non_static_method_access_only_if_necessary"; //$NON-NLS-1$
277
278     /**
279      * Controls access qualifiers for static members. For detailed settings use<br>
280      * {@link #MEMBER_ACCESSES_STATIC_QUALIFY_WITH_DECLARING_CLASS_FIELD}<br>
281      * {@link #MEMBER_ACCESSES_STATIC_QUALIFY_WITH_DECLARING_CLASS_INSTANCE_ACCESS}<br>
282      * {@link #MEMBER_ACCESSES_STATIC_QUALIFY_WITH_DECLARING_CLASS_METHOD}<br>
283      * {@link #MEMBER_ACCESSES_STATIC_QUALIFY_WITH_DECLARING_CLASS_SUBTYPE_ACCESS}
284      * <br>
285      * <br>
286      * Possible values: {TRUE, FALSE}<br>
287      * Default value: Value returned by {@link #getEclipseDefaultSettings()}<br>
288      * <br>
289      *
290      * @see #TRUE
291      * @see #FALSE
292      * @since 3.3
293      */
294     public static final String JavaDoc MEMBER_ACCESSES_STATIC_QUALIFY_WITH_DECLARING_CLASS= "cleanup.qualify_static_member_accesses_with_declaring_class"; //$NON-NLS-1$
295
296     /**
297      * Qualify static field accesses with declaring type.
298      * <p>
299      * i.e.:
300      *
301      * <pre><code>
302      * class E {
303      * public static int i;
304      * void foo() {i= 10;} -&gt; void foo() {E.i= 10;}
305      * }
306      * </code></pre>
307      *
308      * <br>
309      * Only has an effect if
310      * {@link #MEMBER_ACCESSES_STATIC_QUALIFY_WITH_DECLARING_CLASS} is TRUE <br>
311      * <br>
312      * Possible values: {TRUE, FALSE}<br>
313      * Default value: Value returned by {@link #getEclipseDefaultSettings()}<br>
314      * <br>
315      *
316      * @see #TRUE
317      * @see #FALSE
318      * @since 3.3
319      */
320     public static final String JavaDoc MEMBER_ACCESSES_STATIC_QUALIFY_WITH_DECLARING_CLASS_FIELD= "cleanup.qualify_static_field_accesses_with_declaring_class"; //$NON-NLS-1$
321
322     /**
323      * Qualifies static method accesses with declaring type.
324      * <p>
325      * i.e.:
326      *
327      * <pre><code>
328      * class E {
329      * public static int m();
330      * void foo() {m();} -&gt; void foo() {E.m();}
331      * }
332      * </code></pre>
333      *
334      * <br>
335      * Only has an effect if
336      * {@link #MEMBER_ACCESSES_STATIC_QUALIFY_WITH_DECLARING_CLASS} is TRUE <br>
337      * <br>
338      * Possible values: {TRUE, FALSE}<br>
339      * Default value: Value returned by {@link #getEclipseDefaultSettings()}<br>
340      * <br>
341      *
342      * @see #TRUE
343      * @see #FALSE
344      * @since 3.3
345      */
346     public static final String JavaDoc MEMBER_ACCESSES_STATIC_QUALIFY_WITH_DECLARING_CLASS_METHOD= "cleanup.qualify_static_method_accesses_with_declaring_class"; //$NON-NLS-1$
347
348     /**
349      * Changes indirect accesses to static members to direct ones.
350      * <p>
351      * i.e.:
352      *
353      * <pre><code>
354      * class E {public static int i;}
355      * class ESub extends E {
356      * void foo() {ESub.i= 10;} -&gt; void foo() {E.i= 10;}
357      * }
358      * </code></pre>
359      *
360      * <br>
361      * Only has an effect if
362      * {@link #MEMBER_ACCESSES_STATIC_QUALIFY_WITH_DECLARING_CLASS} is TRUE <br>
363      * <br>
364      * Possible values: {TRUE, FALSE}<br>
365      * Default value: Value returned by {@link #getEclipseDefaultSettings()}<br>
366      * <br>
367      *
368      * @see #TRUE
369      * @see #FALSE
370      * @since 3.3
371      */
372     public static final String JavaDoc MEMBER_ACCESSES_STATIC_QUALIFY_WITH_DECLARING_CLASS_SUBTYPE_ACCESS= "cleanup.qualify_static_member_accesses_through_subtypes_with_declaring_class"; //$NON-NLS-1$
373
374     /**
375      * Changes non static accesses to static members to static accesses.
376      * <p>
377      * i.e.:
378      *
379      * <pre><code>
380      * class E {
381      * public static int i;
382      * void foo() {(new E()).i= 10;} -&gt; void foo() {E.i= 10;}
383      * }
384      * </code></pre>
385      *
386      * <br>
387      * Only has an effect if
388      * {@link #MEMBER_ACCESSES_STATIC_QUALIFY_WITH_DECLARING_CLASS} is TRUE <br>
389      * <br>
390      * Possible values: {TRUE, FALSE}<br>
391      * Default value: Value returned by {@link #getEclipseDefaultSettings()}<br>
392      * <br>
393      *
394      * @see #TRUE
395      * @see #FALSE
396      * @since 3.3
397      */
398     public static final String JavaDoc MEMBER_ACCESSES_STATIC_QUALIFY_WITH_DECLARING_CLASS_INSTANCE_ACCESS= "cleanup.qualify_static_member_accesses_through_instances_with_declaring_class"; //$NON-NLS-1$
399
400     /**
401      * Controls the usage of blocks around single control statement bodies. For
402      * detailed settings use<br>
403      * {@link #CONTROL_STATMENTS_USE_BLOCKS_ALWAYS}<br>
404      * {@link #CONTROL_STATMENTS_USE_BLOCKS_NEVER}<br>
405      * {@link #CONTROL_STATMENTS_USE_BLOCKS_NO_FOR_RETURN_AND_THROW} <br>
406      * <br>
407      * Possible values: {TRUE, FALSE}<br>
408      * Default value: Value returned by {@link #getEclipseDefaultSettings()}<br>
409      * <br>
410      *
411      * @see #TRUE
412      * @see #FALSE
413      * @since 3.3
414      */
415     public static final String JavaDoc CONTROL_STATEMENTS_USE_BLOCKS= "cleanup.use_blocks"; //$NON-NLS-1$
416
417     /**
418      * Adds block to control statement body if the body is not a block.
419      * <p>
420      * i.e.:
421      *
422      * <pre><code>
423      * if (b) foo(); -&gt; if (b) {foo();}
424      * </code></pre>
425      *
426      * <br>
427      * Only has an effect if {@link #CONTROL_STATEMENTS_USE_BLOCKS} is TRUE <br>
428      * <br>
429      * Possible values: {TRUE, FALSE}<br>
430      * Default value: Value returned by {@link #getEclipseDefaultSettings()}<br>
431      * <br>
432      *
433      * @see #TRUE
434      * @see #FALSE
435      * @since 3.3
436      */
437     public static final String JavaDoc CONTROL_STATMENTS_USE_BLOCKS_ALWAYS= "cleanup.always_use_blocks"; //$NON-NLS-1$
438
439     /**
440      * Remove unnecessary blocks in control statement bodies if they contain a
441      * single return or throw statement.
442      * <p>
443      * i.e.:
444      *
445      * <pre><code>
446      * if (b) {return;} -&gt; if (b) return;
447      * </code></pre>
448      *
449      * <br>
450      * Only has an effect if {@link #CONTROL_STATEMENTS_USE_BLOCKS} is TRUE <br>
451      * <br>
452      * Possible values: {TRUE, FALSE}<br>
453      * Default value: Value returned by {@link #getEclipseDefaultSettings()}<br>
454      * <br>
455      *
456      * @see #TRUE
457      * @see #FALSE
458      * @since 3.3
459      */
460     public static final String JavaDoc CONTROL_STATMENTS_USE_BLOCKS_NO_FOR_RETURN_AND_THROW= "cleanup.use_blocks_only_for_return_and_throw"; //$NON-NLS-1$
461
462     /**
463      * Remove unnecessary blocks in control statement bodies.
464      * <p>
465      * i.e.:
466      *
467      * <pre><code>
468      * if (b) {foo();} -&gt; if (b) foo();
469      * </code></pre>
470      *
471      * <br>
472      * Only has an effect if {@link #CONTROL_STATEMENTS_USE_BLOCKS} is TRUE <br>
473      * <br>
474      * Possible values: {TRUE, FALSE}<br>
475      * Default value: Value returned by {@link #getEclipseDefaultSettings()}<br>
476      * <br>
477      *
478      * @see #TRUE
479      * @see #FALSE
480      * @since 3.3
481      */
482     public static final String JavaDoc CONTROL_STATMENTS_USE_BLOCKS_NEVER= "cleanup.never_use_blocks"; //$NON-NLS-1$
483
484     /**
485      * Convert for loops to enhanced for loops.
486      * <p>
487      * i.e.:
488      *
489      * <pre><code>
490      * for (int i = 0; i &lt; array.length; i++) {} -&gt; for (int element : array) {}
491      * </code></pre>
492      *
493      * <br>
494      * <br>
495      * Possible values: {TRUE, FALSE}<br>
496      * Default value: Value returned by {@link #getEclipseDefaultSettings()}<br>
497      * <br>
498      *
499      * @see #TRUE
500      * @see #FALSE
501      * @since 3.3
502      */
503     public static final String JavaDoc CONTROL_STATMENTS_CONVERT_FOR_LOOP_TO_ENHANCED= "cleanup.convert_to_enhanced_for_loop"; //$NON-NLS-1$
504
505     /**
506      * Controls the usage of parenthesis in expressions. For detailed settings
507      * use<br>
508      * {@link #EXPRESSIONS_USE_PARENTHESES_ALWAYS}<br>
509      * {@link #EXPRESSIONS_USE_PARENTHESES_NEVER}<br>
510      * <br>
511      * <br>
512      * Possible values: {TRUE, FALSE}<br>
513      * Default value: Value returned by {@link #getEclipseDefaultSettings()}<br>
514      * <br>
515      *
516      * @see #TRUE
517      * @see #FALSE
518      * @since 3.3
519      */
520     public static final String JavaDoc EXPRESSIONS_USE_PARENTHESES= "cleanup.use_parentheses_in_expressions"; //$NON-NLS-1$
521
522     /**
523      * Add paranoic parenthesis around conditional expressions.
524      * <p>
525      * i.e.:
526      *
527      * <pre><code>
528      * boolean b= i &gt; 10 &amp;&amp; i &lt; 100 || i &gt; 20;
529      * -&gt;
530      * boolean b= ((i &gt; 10) &amp;&amp; (i &lt; 100)) || (i &gt; 20);
531      * </pre></code> <br>
532      * Only has an effect if {@link #EXPRESSIONS_USE_PARENTHESES} is TRUE <br>
533      * <br>
534      * Possible values: {TRUE, FALSE}<br>
535      * Default value: Value returned by {@link #getEclipseDefaultSettings()}<br>
536      * <br>
537      *
538      * @see #TRUE
539      * @see #FALSE
540      * @since 3.3
541      */
542     public static final String JavaDoc EXPRESSIONS_USE_PARENTHESES_ALWAYS= "cleanup.always_use_parentheses_in_expressions"; //$NON-NLS-1$
543
544     /**
545      * Remove unnecessary parenthesis around conditional expressions.
546      * <p>
547      * i.e.:
548      *
549      * <pre><code>
550      * boolean b= ((i &gt; 10) &amp;&amp; (i &lt; 100)) || (i &gt; 20);
551      * -&gt;
552      * boolean b= i &gt; 10 &amp;&amp; i &lt; 100 || i &gt; 20;
553      * </pre></code> <br>
554      * Only has an effect if {@link #EXPRESSIONS_USE_PARENTHESES} is TRUE <br>
555      * <br>
556      * Possible values: {TRUE, FALSE}<br>
557      * Default value: Value returned by {@link #getEclipseDefaultSettings()}<br>
558      * <br>
559      *
560      * @see #TRUE
561      * @see #FALSE
562      * @since 3.3
563      */
564     public static final String JavaDoc EXPRESSIONS_USE_PARENTHESES_NEVER= "cleanup.never_use_parentheses_in_expressions"; //$NON-NLS-1$
565
566     /**
567      * Controls the usage of 'final' modifier for variable declarations. For
568      * detailed settings use:<br>
569      * {@link #VARIABLE_DECLARATIONS_USE_FINAL_LOCAL_VARIABLES}<br>
570      * {@link #VARIABLE_DECLARATIONS_USE_FINAL_PARAMETERS}<br>
571      * {@link #VARIABLE_DECLARATIONS_USE_FINAL_PRIVATE_FIELDS} <br>
572      * <br>
573      * Possible values: {TRUE, FALSE}<br>
574      * Default value: Value returned by {@link #getEclipseDefaultSettings()}<br>
575      * <br>
576      *
577      * @see #TRUE
578      * @see #FALSE
579      * @since 3.3
580      */
581     public static final String JavaDoc VARIABLE_DECLARATIONS_USE_FINAL= "cleanup.make_variable_declarations_final"; //$NON-NLS-1$
582
583     /**
584      * Add a final modifier to private fields where possible i.e.:
585      *
586      * <pre><code>
587      * private int field= 0; -&gt; private final int field= 0;
588      * </code></pre>
589      *
590      * <br>
591      * Only has an effect if {@link #VARIABLE_DECLARATIONS_USE_FINAL} is TRUE
592      * <br>
593      * <br>
594      * Possible values: {TRUE, FALSE}<br>
595      * Default value: Value returned by {@link #getEclipseDefaultSettings()}<br>
596      * <br>
597      *
598      * @see #TRUE
599      * @see #FALSE
600      * @since 3.3
601      */
602     public static final String JavaDoc VARIABLE_DECLARATIONS_USE_FINAL_PRIVATE_FIELDS= "cleanup.make_private_fields_final"; //$NON-NLS-1$
603
604     /**
605      * Add a final modifier to method parameters where possible i.e.:
606      *
607      * <pre><code>
608      * void foo(int i) {} -&gt; void foo(final int i) {}
609      * </code></pre>
610      *
611      * <br>
612      * Only has an effect if {@link #VARIABLE_DECLARATIONS_USE_FINAL} is TRUE
613      * <br>
614      * <br>
615      * Possible values: {TRUE, FALSE}<br>
616      * Default value: Value returned by {@link #getEclipseDefaultSettings()}<br>
617      * <br>
618      *
619      * @see #TRUE
620      * @see #FALSE
621      * @since 3.3
622      */
623     public static final String JavaDoc VARIABLE_DECLARATIONS_USE_FINAL_PARAMETERS= "cleanup.make_parameters_final"; //$NON-NLS-1$
624
625     /**
626      * Add a final modifier to local variables where possible i.e.:
627      *
628      * <pre><code>
629      * int i= 0; -&gt; final int i= 0;
630      * </code></pre>
631      *
632      * <br>
633      * Only has an effect if {@link #VARIABLE_DECLARATIONS_USE_FINAL} is TRUE
634      * <br>
635      * <br>
636      * Possible values: {TRUE, FALSE}<br>
637      * Default value: Value returned by {@link #getEclipseDefaultSettings()}<br>
638      * <br>
639      *
640      * @see #TRUE
641      * @see #FALSE
642      * @since 3.3
643      */
644     public static final String JavaDoc VARIABLE_DECLARATIONS_USE_FINAL_LOCAL_VARIABLES= "cleanup.make_local_variable_final"; //$NON-NLS-1$
645
646     /**
647      * Adds type parameters to raw type references.
648      * <p>
649      * i.e.:
650      *
651      * <pre><code>
652      * List l; -&gt; List&lt;Object&gt; l;
653      * </code></pre>
654      *
655      * <br>
656      * Possible values: {TRUE, FALSE}<br>
657      * Default value: Not set<br>
658      * <br>
659      *
660      * @see #TRUE
661      * @see #FALSE
662      * @since 3.3
663      */
664     public static final String JavaDoc VARIABLE_DECLARATION_USE_TYPE_ARGUMENTS_FOR_RAW_TYPE_REFERENCES= "cleanup.use_arguments_for_raw_type_references"; //$NON-NLS-1$
665
666     /**
667      * Removes unused imports. <br>
668      * <br>
669      * Possible values: {TRUE, FALSE}<br>
670      * Default value: Value returned by {@link #getEclipseDefaultSettings()}<br>
671      * <br>
672      *
673      * @see #TRUE
674      * @see #FALSE
675      * @since 3.3
676      */
677     public static final String JavaDoc REMOVE_UNUSED_CODE_IMPORTS= "cleanup.remove_unused_imports"; //$NON-NLS-1$
678
679     /**
680      * Controls the removal of unused private members. For detailed settings
681      * use:<br>
682      * {@link #REMOVE_UNUSED_CODE_PRIVATE_CONSTRUCTORS}<br>
683      * {@link #REMOVE_UNUSED_CODE_PRIVATE_FELDS}<br>
684      * {@link #REMOVE_UNUSED_CODE_PRIVATE_METHODS}<br>
685      * {@link #REMOVE_UNUSED_CODE_PRIVATE_TYPES} <br>
686      * <br>
687      * Possible values: {TRUE, FALSE}<br>
688      * Default value: Value returned by {@link #getEclipseDefaultSettings()}<br>
689      * <br>
690      *
691      * @see #TRUE
692      * @see #FALSE
693      * @since 3.3
694      */
695     public static final String JavaDoc REMOVE_UNUSED_CODE_PRIVATE_MEMBERS= "cleanup.remove_unused_private_members"; //$NON-NLS-1$
696
697     /**
698      * Removes unused private types. <br>
699      * Only has an effect if {@link #REMOVE_UNUSED_CODE_PRIVATE_MEMBERS} is TRUE
700      * <br>
701      * <br>
702      * Possible values: {TRUE, FALSE}<br>
703      * Default value: Value returned by {@link #getEclipseDefaultSettings()}<br>
704      * <br>
705      *
706      * @see #TRUE
707      * @see #FALSE
708      * @since 3.3
709      */
710     public static final String JavaDoc REMOVE_UNUSED_CODE_PRIVATE_TYPES= "cleanup.remove_unused_private_types"; //$NON-NLS-1$
711
712     /**
713      * Removes unused private constructors. <br>
714      * Only has an effect if {@link #REMOVE_UNUSED_CODE_PRIVATE_MEMBERS} is TRUE
715      * <br>
716      * <br>
717      * Possible values: {TRUE, FALSE}<br>
718      * Default value: Value returned by {@link #getEclipseDefaultSettings()}<br>
719      * <br>
720      *
721      * @see #TRUE
722      * @see #FALSE
723      * @since 3.3
724      */
725     public static final String JavaDoc REMOVE_UNUSED_CODE_PRIVATE_CONSTRUCTORS= "cleanup.remove_private_constructors"; //$NON-NLS-1$
726
727     /**
728      * Removes unused private fields. <br>
729      * Only has an effect if {@link #REMOVE_UNUSED_CODE_PRIVATE_MEMBERS} is TRUE
730      * <br>
731      * <br>
732      * Possible values: {TRUE, FALSE}<br>
733      * Default value: Value returned by {@link #getEclipseDefaultSettings()}<br>
734      * <br>
735      *
736      * @see #TRUE
737      * @see #FALSE
738      * @since 3.3
739      */
740     public static final String JavaDoc REMOVE_UNUSED_CODE_PRIVATE_FELDS= "cleanup.remove_unused_private_fields"; //$NON-NLS-1$
741
742     /**
743      * Removes unused private methods. <br>
744      * Only has an effect if {@link #REMOVE_UNUSED_CODE_PRIVATE_MEMBERS} is TRUE
745      * <br>
746      * <br>
747      * Possible values: {TRUE, FALSE}<br>
748      * Default value: Value returned by {@link #getEclipseDefaultSettings()}<br>
749      * <br>
750      *
751      * @see #TRUE
752      * @see #FALSE
753      * @since 3.3
754      */
755     public static final String JavaDoc REMOVE_UNUSED_CODE_PRIVATE_METHODS= "cleanup.remove_unused_private_methods"; //$NON-NLS-1$
756
757     /**
758      * Removes unused local variables. <br>
759      * <br>
760      * Possible values: {TRUE, FALSE}<br>
761      * Default value: Value returned by {@link #getEclipseDefaultSettings()}<br>
762      * <br>
763      *
764      * @see #TRUE
765      * @see #FALSE
766      * @since 3.3
767      */
768     public static final String JavaDoc REMOVE_UNUSED_CODE_LOCAL_VARIABLES= "cleanup.remove_unused_local_variables"; //$NON-NLS-1$
769
770     /**
771      * Removes unused casts. <br>
772      * <br>
773      * Possible values: {TRUE, FALSE}<br>
774      * Default value: Value returned by {@link #getEclipseDefaultSettings()}<br>
775      * <br>
776      *
777      * @see #TRUE
778      * @see #FALSE
779      * @since 3.3
780      */
781     public static final String JavaDoc REMOVE_UNNECESSARY_CASTS= "cleanup.remove_unnecessary_casts"; //$NON-NLS-1$
782
783     /**
784      * Remove unnecessary '$NON-NLS$' tags.
785      * <p>
786      * i.e.:
787      *
788      * <pre><code>
789      * String s; //$NON-NLS-1$ -&gt; String s;
790      * </code></pre>
791      *
792      * <br>
793      * <br>
794      * Possible values: {TRUE, FALSE}<br>
795      * Default value: Value returned by {@link #getEclipseDefaultSettings()}<br>
796      * <br>
797      *
798      * @see #TRUE
799      * @see #FALSE
800      * @since 3.3
801      */
802     public static final String JavaDoc REMOVE_UNNECESSARY_NLS_TAGS= "cleanup.remove_unnecessary_nls_tags"; //$NON-NLS-1$
803
804     /**
805      * Controls whether missing annotations should be added to the code. For
806      * detailed settings use:<br>
807      * {@link #ADD_MISSING_ANNOTATIONS_DEPRECATED}<br>
808      * {@value #ADD_MISSING_ANNOTATIONS_OVERRIDE} <br>
809      * <br>
810      * Possible values: {TRUE, FALSE}<br>
811      * Default value: Value returned by {@link #getEclipseDefaultSettings()}<br>
812      * <br>
813      *
814      * @see #TRUE
815      * @see #FALSE
816      * @since 3.3
817      */
818     public static final String JavaDoc ADD_MISSING_ANNOTATIONS= "cleanup.add_missing_annotations"; //$NON-NLS-1$
819
820     /**
821      * Add '@Override' annotation in front of overriding methods.
822      * <p>
823      * i.e.:
824      *
825      * <pre><code>
826      * class E1 {void foo();}
827      * class E2 extends E1 {
828      * void foo(); -&gt; @Override void foo();
829      * }
830      * </pre></code> <br>
831      * Only has an effect if {@link #ADD_MISSING_ANNOTATIONS} is TRUE
832      * <br>
833      * <br>
834      * Possible values: {TRUE, FALSE}<br>
835      * Default value: Value returned by
836      * {@link #getEclipseDefaultSettings()}<br>
837      * <br>
838      *
839      * @see #TRUE
840      * @see #FALSE
841      * @since 3.3
842      */
843     public static final String JavaDoc ADD_MISSING_ANNOTATIONS_OVERRIDE= "cleanup.add_missing_override_annotations"; //$NON-NLS-1$
844
845     /**
846      * Add '@Deprecated' annotation in front of deprecated members.
847      * <p>
848      * i.e.:
849      *
850      * <pre><code>
851      * /**@deprecated* /
852      * int i;
853      * -&gt;
854      * /**@deprecated* /
855      * @Deprecated
856      * int i;
857      * </pre></code> <br>
858      * Only has an effect if {@link #ADD_MISSING_ANNOTATIONS} is TRUE <br>
859      * <br>
860      * Possible values: {TRUE, FALSE}<br>
861      * Default value: Value returned by {@link #getEclipseDefaultSettings()}<br>
862      * <br>
863      *
864      * @see #TRUE
865      * @see #FALSE
866      * @since 3.3
867      */
868     public static final String JavaDoc ADD_MISSING_ANNOTATIONS_DEPRECATED= "cleanup.add_missing_deprecated_annotations"; //$NON-NLS-1$
869
870     /**
871      * Controls whether missing serial version ids should be added to the code.
872      * For detailed settings use:<br>
873      * {@link #ADD_MISSING_SERIAL_VERSION_ID_DEFAULT}<br>
874      * {@link #ADD_MISSING_SERIAL_VERSION_ID_GENERATED} <br>
875      * <br>
876      * Possible values: {TRUE, FALSE}<br>
877      * Default value: Value returned by {@link #getEclipseDefaultSettings()}<br>
878      * <br>
879      *
880      * @see #TRUE
881      * @see #FALSE
882      * @since 3.3
883      */
884     public static final String JavaDoc ADD_MISSING_SERIAL_VERSION_ID= "cleanup.add_serial_version_id"; //$NON-NLS-1$
885
886     /**
887      * Adds a generated serial version id to subtypes of java.io.Serializable
888      * and java.io.Externalizable
889      *
890      * public class E implements Serializable {} -> public class E implements
891      * Serializable { private static final long serialVersionUID = 4381024239L; }
892      * <br>
893      * Only has an effect if {@link #ADD_MISSING_SERIAL_VERSION_ID} is TRUE <br>
894      * <br>
895      * Possible values: {TRUE, FALSE}<br>
896      * Default value: Value returned by {@link #getEclipseDefaultSettings()}<br>
897      * <br>
898      *
899      * @see #TRUE
900      * @see #FALSE
901      * @since 3.3
902      */
903     public static final String JavaDoc ADD_MISSING_SERIAL_VERSION_ID_GENERATED= "cleanup.add_generated_serial_version_id"; //$NON-NLS-1$
904
905     /**
906      * Adds a default serial version it to subtypes of java.io.Serializable and
907      * java.io.Externalizable
908      *
909      * public class E implements Serializable {} -> public class E implements
910      * Serializable { private static final long serialVersionUID = 1L; } <br>
911      * Only has an effect if {@link #ADD_MISSING_SERIAL_VERSION_ID} is TRUE <br>
912      * <br>
913      * Possible values: {TRUE, FALSE}<br>
914      * Default value: Value returned by {@link #getEclipseDefaultSettings()}<br>
915      * <br>
916      *
917      * @see #TRUE
918      * @see #FALSE
919      * @since 3.3
920      */
921     public static final String JavaDoc ADD_MISSING_SERIAL_VERSION_ID_DEFAULT= "cleanup.add_default_serial_version_id"; //$NON-NLS-1$
922
923     /**
924      * Add '$NON-NLS$' tags to non externalized strings.
925      * <p>
926      * i.e.:
927      *
928      * <pre><code>
929      * String s= &quot;&quot;; -&gt; String s= &quot;&quot;; //$NON-NLS-1$
930      * </code></pre>
931      *
932      * <br>
933      * <br>
934      * Possible values: {TRUE, FALSE}<br>
935      * Default value: Value returned by {@link #getEclipseDefaultSettings()}<br>
936      * <br>
937      *
938      * @see #TRUE
939      * @see #FALSE
940      * @since 3.3
941      */
942     public static final String JavaDoc ADD_MISSING_NLS_TAGS= "cleanup.add_missing_nls_tags"; //$NON-NLS-1$
943
944     /**
945      * If true the imports are organized while cleaning up code.
946      *
947      * Possible values: {TRUE, FALSE}<br>
948      * Default value: Value returned by {@link #getEclipseDefaultSettings()}<br>
949      * <br>
950      *
951      * @see #TRUE
952      * @see #FALSE
953      * @since 3.3
954      */
955     public static final String JavaDoc ORGANIZE_IMPORTS= "cleanup.organize_imports"; //$NON-NLS-1$
956
957     /**
958      * Should members be sorted?
959      * <br><br>
960      * Possible values: {TRUE, FALSE}<br>
961      * Default value: Value returned by {@link #getEclipseDefaultSettings()}<br>
962      * <br>
963      *
964      * @see #SORT_MEMBERS_ALL
965      * @see #TRUE
966      * @see #FALSE
967      * @since 3.3
968      */
969     public static final String JavaDoc SORT_MEMBERS = "cleanup.sort_members"; //$NON-NLS-1$
970
971     /**
972      * If sorting members, should fields, enum constants and initializers also be sorted?
973      * <br>
974      * This has only an effect if {@link #SORT_MEMBERS} is also enabled.
975      * <br>
976      * <br>
977      * Possible values: {TRUE, FALSE}<br>
978      * Default value: Value returned by {@link #getEclipseDefaultSettings()}<br>
979      * <br>
980      *
981      * @see #SORT_MEMBERS
982      * @see #TRUE
983      * @see #FALSE
984      * @since 3.3
985      */
986     public static final String JavaDoc SORT_MEMBERS_ALL = "cleanup.sort_members_all"; //$NON-NLS-1$
987
988     /**
989      * Should the Clean Up Wizard be shown when executing the Clean Up Action?
990      * <br>
991      * <br>
992      * Possible values: {<code><b>true</b></code>,
993      * <code><b>false</b></code>}<br>
994      * Default value: <code><b>true</b></code><br>
995      * <br>
996      *
997      * @since 3.3
998      */
999     public static final String JavaDoc SHOW_CLEAN_UP_WIZARD= "cleanup.showwizard"; //$NON-NLS-1$
1000
1001    /**
1002     * A key to a serialized string in the <code>InstanceScope</code>
1003     * containing all the profiles.<br>
1004     * Following code snippet can load the profiles:
1005     *
1006     * <pre><code>
1007     * List profiles= new ProfileStore(CLEANUP_PROFILES, new CleanUpVersioner()).readProfiles(new InstanceScope());
1008     * </code></pre>
1009     *
1010     * @since 3.3
1011     */
1012    public static final String JavaDoc CLEANUP_PROFILES= "org.eclipse.jdt.ui.cleanupprofiles"; //$NON-NLS-1$
1013
1014    /**
1015     * Stores the id of the clean up profile used when executing clean up.<br>
1016     * <br>
1017     * Possible values: String value<br>
1018     * Default value: {@link #DEFAULT_PROFILE} <br>
1019     *
1020     * @since 3.3
1021     */
1022    public final static String