KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > eclipse > jdt > core > formatter > DefaultCodeFormatterConstants


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  *******************************************************************************/
11 package org.eclipse.jdt.core.formatter;
12
13 import java.util.Map JavaDoc;
14
15 import org.eclipse.jdt.core.JavaCore;
16 import org.eclipse.jdt.core.ToolFactory;
17 import org.eclipse.jdt.internal.formatter.DefaultCodeFormatterOptions;
18 import org.eclipse.jdt.internal.formatter.align.Alignment;
19
20 /**
21  * Constants used to set up the options of the code formatter.
22  * <p>
23  * This class is not intended to be instantiated or subclassed by clients.
24  * </p>
25  *
26  * @since 3.0
27  */
28 public class DefaultCodeFormatterConstants {
29
30     /**
31      * <pre>
32      * FORMATTER / Value to set a brace location at the end of a line.
33      * </pre>
34      * @see #FORMATTER_BRACE_POSITION_FOR_ANONYMOUS_TYPE_DECLARATION
35      * @see #FORMATTER_BRACE_POSITION_FOR_ARRAY_INITIALIZER
36      * @see #FORMATTER_BRACE_POSITION_FOR_BLOCK
37      * @see #FORMATTER_BRACE_POSITION_FOR_CONSTRUCTOR_DECLARATION
38      * @see #FORMATTER_BRACE_POSITION_FOR_METHOD_DECLARATION
39      * @see #FORMATTER_BRACE_POSITION_FOR_SWITCH
40      * @see #FORMATTER_BRACE_POSITION_FOR_TYPE_DECLARATION
41      * @since 3.0
42      */
43     public static final String JavaDoc END_OF_LINE = "end_of_line"; //$NON-NLS-1$
44
45     /**
46      * <pre>
47      * FORMATTER / Value to set an option to false.
48      * </pre>
49      * @since 3.0
50      */
51     public static final String JavaDoc FALSE = "false"; //$NON-NLS-1$
52
53     /**
54      * <pre>
55      * FORMATTER / Option to align type members of a type declaration on column
56      * - option id: "org.eclipse.jdt.core.formatter.formatter.align_type_members_on_columns"
57      * - possible values: { TRUE, FALSE }
58      * - default: FALSE
59      * </pre>
60      * @see #TRUE
61      * @see #FALSE
62      * @since 3.0
63      */
64     public static final String JavaDoc FORMATTER_ALIGN_TYPE_MEMBERS_ON_COLUMNS = JavaCore.PLUGIN_ID + ".formatter.align_type_members_on_columns"; //$NON-NLS-1$
65
66     /**
67      * <pre>
68      * FORMATTER / Option for alignment of arguments in allocation expression
69      * - option id: "org.eclipse.jdt.core.formatter.alignment_for_arguments_in_allocation_expression"
70      * - possible values: values returned by <code>createAlignmentValue(boolean, int, int)</code> call
71      * - default: createAlignmentValue(false, WRAP_COMPACT, INDENT_DEFAULT)
72      * </pre>
73      * @see #createAlignmentValue(boolean, int, int)
74      * @since 3.0
75      */
76     public static final String JavaDoc FORMATTER_ALIGNMENT_FOR_ARGUMENTS_IN_ALLOCATION_EXPRESSION = JavaCore.PLUGIN_ID + ".formatter.alignment_for_arguments_in_allocation_expression"; //$NON-NLS-1$
77 /**
78      * <pre>
79      * FORMATTER / Option for alignment of arguments in enum constant
80      * - option id: "org.eclipse.jdt.core.formatter.alignment_for_arguments_in_enum_constant"
81      * - possible values: values returned by <code>createAlignmentValue(boolean, int, int)</code> call
82      * - default: createAlignmentValue(false, WRAP_COMPACT, INDENT_DEFAULT)
83      * </pre>
84      * @see #createAlignmentValue(boolean, int, int)
85      * @since 3.1
86      */
87     public static final String JavaDoc FORMATTER_ALIGNMENT_FOR_ARGUMENTS_IN_ENUM_CONSTANT = JavaCore.PLUGIN_ID + ".formatter.alignment_for_arguments_in_enum_constant"; //$NON-NLS-1$
88 /**
89      * <pre>
90      * FORMATTER / Option for alignment of arguments in explicit constructor call
91      * - option id: "org.eclipse.jdt.core.formatter.alignment_for_arguments_in_explicit_constructor_call"
92      * - possible values: values returned by <code>createAlignmentValue(boolean, int, int)</code> call
93      * - default: createAlignmentValue(false, WRAP_COMPACT, INDENT_DEFAULT)
94      * </pre>
95      * @see #createAlignmentValue(boolean, int, int)
96      * @since 3.0
97      */
98     public static final String JavaDoc FORMATTER_ALIGNMENT_FOR_ARGUMENTS_IN_EXPLICIT_CONSTRUCTOR_CALL = JavaCore.PLUGIN_ID + ".formatter.alignment_for_arguments_in_explicit_constructor_call"; //$NON-NLS-1$
99 /**
100      * <pre>
101      * FORMATTER / Option for alignment of arguments in method invocation
102      * - option id: "org.eclipse.jdt.core.formatter.alignment_for_arguments_in_method_invocation"
103      * - possible values: values returned by <code>createAlignmentValue(boolean, int, int)</code> call
104      * - default: createAlignmentValue(false, WRAP_COMPACT, INDENT_DEFAULT)
105      * </pre>
106      * @see #createAlignmentValue(boolean, int, int)
107      * @since 3.0
108      */
109     public static final String JavaDoc FORMATTER_ALIGNMENT_FOR_ARGUMENTS_IN_METHOD_INVOCATION = JavaCore.PLUGIN_ID + ".formatter.alignment_for_arguments_in_method_invocation"; //$NON-NLS-1$
110 /**
111      * <pre>
112      * FORMATTER / Option for alignment of arguments in qualified allocation expression
113      * - option id: "org.eclipse.jdt.core.formatter.alignment_for_arguments_in_qualified_allocation_expression"
114      * - possible values: values returned by <code>createAlignmentValue(boolean, int, int)</code> call
115      * - default: createAlignmentValue(false, WRAP_COMPACT, INDENT_DEFAULT)
116      * </pre>
117      * @see #createAlignmentValue(boolean, int, int)
118      * @since 3.0
119      */
120     public static final String JavaDoc FORMATTER_ALIGNMENT_FOR_ARGUMENTS_IN_QUALIFIED_ALLOCATION_EXPRESSION = JavaCore.PLUGIN_ID + ".formatter.alignment_for_arguments_in_qualified_allocation_expression"; //$NON-NLS-1$
121 /**
122      * <pre>
123      * FORMATTER / Option for alignment of assignment
124      * - option id: "org.eclipse.jdt.core.formatter.alignment_for_assignment"
125      * - possible values: values returned by <code>createAlignmentValue(boolean, int, int)</code> call
126      * - default: createAlignmentValue(false, M_NO_ALIGNMENT, INDENT_DEFAULT)
127      * </pre>
128      * @see #createAlignmentValue(boolean, int, int)
129      * @since 3.2
130      */
131     public static final String JavaDoc FORMATTER_ALIGNMENT_FOR_ASSIGNMENT = JavaCore.PLUGIN_ID + ".formatter.alignment_for_assignment"; //$NON-NLS-1$
132 /**
133      * <pre>
134      * FORMATTER / Option for alignment of binary expression
135      * - option id: "org.eclipse.jdt.core.formatter.alignment_for_binary_expression"
136      * - possible values: values returned by <code>createAlignmentValue(boolean, int, int)</code> call
137      * - default: createAlignmentValue(false, WRAP_COMPACT, INDENT_DEFAULT)
138      * </pre>
139      * @see #createAlignmentValue(boolean, int, int)
140      * @since 3.0
141      */
142     public static final String JavaDoc FORMATTER_ALIGNMENT_FOR_BINARY_EXPRESSION = JavaCore.PLUGIN_ID + ".formatter.alignment_for_binary_expression"; //$NON-NLS-1$
143 /**
144      * <pre>
145      * FORMATTER / Option for alignment of compact if
146      * - option id: "org.eclipse.jdt.core.formatter.alignment_for_compact_if"
147      * - possible values: values returned by <code>createAlignmentValue(boolean, int, int)</code> call
148      * - default: createAlignmentValue(false, WRAP_ONE_PER_LINE, INDENT_BY_ONE)
149      * </pre>
150      * @see #createAlignmentValue(boolean, int, int)
151      * @since 3.0
152      */
153     public static final String JavaDoc FORMATTER_ALIGNMENT_FOR_COMPACT_IF = JavaCore.PLUGIN_ID + ".formatter.alignment_for_compact_if"; //$NON-NLS-1$
154 /**
155      * <pre>
156      * FORMATTER / Option for alignment of conditional expression
157      * - option id: "org.eclipse.jdt.core.formatter.alignment_for_conditional_expression"
158      * - possible values: values returned by <code>createAlignmentValue(boolean, int, int)</code> call
159      * - default: createAlignmentValue(false, WRAP_ONE_PER_LINE, INDENT_DEFAULT)
160      * </pre>
161      * @see #createAlignmentValue(boolean, int, int)
162      * @since 3.0
163      */
164     public static final String JavaDoc FORMATTER_ALIGNMENT_FOR_CONDITIONAL_EXPRESSION = JavaCore.PLUGIN_ID + ".formatter.alignment_for_conditional_expression"; //$NON-NLS-1$
165 /**
166      * <pre>
167      * FORMATTER / Option for alignment of enum constants
168      * - option id: "org.eclipse.jdt.core.formatter.alignment_for_enum_constants"
169      * - possible values: values returned by <code>createAlignmentValue(boolean, int, int)</code> call
170      * - default: createAlignmentValue(false, WRAP_NO_SPLIT, INDENT_DEFAULT)
171      * </pre>
172      * @see #createAlignmentValue(boolean, int, int)
173      * @since 3.1
174      */
175     public static final String JavaDoc FORMATTER_ALIGNMENT_FOR_ENUM_CONSTANTS = JavaCore.PLUGIN_ID + ".formatter.alignment_for_enum_constants"; //$NON-NLS-1$
176 /**
177      * <pre>
178      * FORMATTER / Option for alignment of expressions in array initializer
179      * - option id: "org.eclipse.jdt.core.formatter.alignment_for_expressions_in_array_initializer"
180      * - possible values: values returned by <code>createAlignmentValue(boolean, int, int)</code> call
181      * - default: createAlignmentValue(false, WRAP_COMPACT, INDENT_DEFAULT)
182      * </pre>
183      * @see #createAlignmentValue(boolean, int, int)
184      * @since 3.0
185      */
186     public static final String JavaDoc FORMATTER_ALIGNMENT_FOR_EXPRESSIONS_IN_ARRAY_INITIALIZER = JavaCore.PLUGIN_ID + ".formatter.alignment_for_expressions_in_array_initializer"; //$NON-NLS-1$
187 /**
188      * <pre>
189      * FORMATTER / Option for alignment of multiple fields
190      * - option id: "org.eclipse.jdt.core.formatter.alignment_for_multiple_fields"
191      * - possible values: values returned by <code>createAlignmentValue(boolean, int, int)</code> call
192      * - default: createAlignmentValue(false, WRAP_COMPACT, INDENT_DEFAULT)
193      * </pre>
194      * @see #createAlignmentValue(boolean, int, int)
195      * @since 3.0
196      */
197     public static final String JavaDoc FORMATTER_ALIGNMENT_FOR_MULTIPLE_FIELDS = JavaCore.PLUGIN_ID + ".formatter.alignment_for_multiple_fields";//$NON-NLS-1$
198 /**
199      * <pre>
200      * FORMATTER / Option for alignment of parameters in constructor declaration
201      * - option id: "org.eclipse.jdt.core.formatter.alignment_for_parameters_in_constructor_declaration"
202      * - possible values: values returned by <code>createAlignmentValue(boolean, int, int)</code> call
203      * - default: createAlignmentValue(false, WRAP_COMPACT, INDENT_DEFAULT)
204      * </pre>
205      * @see #createAlignmentValue(boolean, int, int)
206      * @since 3.0
207      */
208     public static final String JavaDoc FORMATTER_ALIGNMENT_FOR_PARAMETERS_IN_CONSTRUCTOR_DECLARATION = JavaCore.PLUGIN_ID + ".formatter.alignment_for_parameters_in_constructor_declaration"; //$NON-NLS-1$
209 /**
210      * <pre>
211      * FORMATTER / Option for alignment of parameters in method declaration
212      * - option id: "org.eclipse.jdt.core.formatter.alignment_for_parameters_in_method_declaration"
213      * - possible values: values returned by <code>createAlignmentValue(boolean, int, int)</code> call
214      * - default: createAlignmentValue(false, WRAP_COMPACT, INDENT_DEFAULT)
215      * </pre>
216      * @see #createAlignmentValue(boolean, int, int)
217      * @since 3.0
218      */
219     public static final String JavaDoc FORMATTER_ALIGNMENT_FOR_PARAMETERS_IN_METHOD_DECLARATION = JavaCore.PLUGIN_ID + ".formatter.alignment_for_parameters_in_method_declaration"; //$NON-NLS-1$
220 /**
221      * <pre>
222      * FORMATTER / Option for alignment of selector in method invocation
223      * - option id: "org.eclipse.jdt.core.formatter.alignment_for_selector_in_method_invocation"
224      * - possible values: values returned by <code>createAlignmentValue(boolean, int, int)</code> call
225      * - default: createAlignmentValue(false, WRAP_COMPACT, INDENT_DEFAULT)
226      * </pre>
227      * @see #createAlignmentValue(boolean, int, int)
228      * @since 3.0
229      */
230     public static final String JavaDoc FORMATTER_ALIGNMENT_FOR_SELECTOR_IN_METHOD_INVOCATION = JavaCore.PLUGIN_ID + ".formatter.alignment_for_selector_in_method_invocation"; //$NON-NLS-1$
231 /**
232      * <pre>
233      * FORMATTER / Option for alignment of superclass in type declaration
234      * - option id: "org.eclipse.jdt.core.formatter.alignment_for_superclass_in_type_declaration"
235      * - possible values: values returned by <code>createAlignmentValue(boolean, int, int)</code> call
236      * - default: createAlignmentValue(false, WRAP_NEXT_SHIFTED, INDENT_DEFAULT)
237      * </pre>
238      * @see #createAlignmentValue(boolean, int, int)
239      * @since 3.0
240      */
241     public static final String JavaDoc FORMATTER_ALIGNMENT_FOR_SUPERCLASS_IN_TYPE_DECLARATION = JavaCore.PLUGIN_ID + ".formatter.alignment_for_superclass_in_type_declaration"; //$NON-NLS-1$
242 /**
243      * <pre>
244      * FORMATTER / Option for alignment of superinterfaces in enum declaration
245      * - option id: "org.eclipse.jdt.core.formatter.alignment_for_superinterfaces_in_enum_declaration"
246      * - possible values: values returned by <code>createAlignmentValue(boolean, int, int)</code> call
247      * - default: createAlignmentValue(false, WRAP_COMPACT, INDENT_DEFAULT)
248      * </pre>
249      * @see #createAlignmentValue(boolean, int, int)
250      * @since 3.1
251      */
252     public static final String JavaDoc FORMATTER_ALIGNMENT_FOR_SUPERINTERFACES_IN_ENUM_DECLARATION = JavaCore.PLUGIN_ID + ".formatter.alignment_for_superinterfaces_in_enum_declaration"; //$NON-NLS-1$
253 /**
254      * <pre>
255      * FORMATTER / Option for alignment of superinterfaces in type declaration
256      * - option id: "org.eclipse.jdt.core.formatter.alignment_for_superinterfaces_in_type_declaration"
257      * - possible values: values returned by <code>createAlignmentValue(boolean, int, int)</code> call
258      * - default: createAlignmentValue(false, WRAP_COMPACT, INDENT_DEFAULT)
259      * </pre>
260      * @see #createAlignmentValue(boolean, int, int)
261      * @since 3.0
262      */
263     public static final String JavaDoc FORMATTER_ALIGNMENT_FOR_SUPERINTERFACES_IN_TYPE_DECLARATION = JavaCore.PLUGIN_ID + ".formatter.alignment_for_superinterfaces_in_type_declaration"; //$NON-NLS-1$
264 /**
265      * <pre>
266      * FORMATTER / Option for alignment of throws clause in constructor declaration
267      * - option id: "org.eclipse.jdt.core.formatter.alignment_for_throws_clause_in_constructor_declaration"
268      * - possible values: values returned by <code>createAlignmentValue(boolean, int, int)</code> call
269      * - default: createAlignmentValue(false, WRAP_COMPACT, INDENT_DEFAULT)
270      * </pre>
271      * @see #createAlignmentValue(boolean, int, int)
272      * @since 3.0
273      */
274     public static final String JavaDoc FORMATTER_ALIGNMENT_FOR_THROWS_CLAUSE_IN_CONSTRUCTOR_DECLARATION = JavaCore.PLUGIN_ID + ".formatter.alignment_for_throws_clause_in_constructor_declaration"; //$NON-NLS-1$
275 /**
276      * <pre>
277      * FORMATTER / Option for alignment of throws clause in method declaration
278      * - option id: "org.eclipse.jdt.core.formatter.alignment_for_throws_clause_in_method_declaration"
279      * - possible values: values returned by <code>createAlignmentValue(boolean, int, int)</code> call
280      * - default: createAlignmentValue(false, WRAP_COMPACT, INDENT_DEFAULT)
281      * </pre>
282      * @see #createAlignmentValue(boolean, int, int)
283      * @since 3.0
284      */
285     public static final String JavaDoc FORMATTER_ALIGNMENT_FOR_THROWS_CLAUSE_IN_METHOD_DECLARATION = JavaCore.PLUGIN_ID + ".formatter.alignment_for_throws_clause_in_method_declaration"; //$NON-NLS-1$
286
287     /**
288      * <pre>
289      * FORMATTER / Option to add blank lines after the imports declaration
290      * - option id: "org.eclipse.jdt.core.formatter.blank_lines_after_imports"
291      * - possible values: "&lt;n&gt;", where n is zero or a positive integer
292      * - default: "0"
293      * </pre>
294      * @since 3.0
295      */
296     public static final String JavaDoc FORMATTER_BLANK_LINES_AFTER_IMPORTS = JavaCore.PLUGIN_ID + ".formatter.blank_lines_after_imports"; //$NON-NLS-1$
297 /**
298      * <pre>
299      * FORMATTER / Option to add blank lines after the package declaration
300      * - option id: "org.eclipse.jdt.core.formatter.blank_lines_after_package"
301      * - possible values: "&lt;n&gt;", where n is zero or a positive integer
302      * - default: "0"
303      * </pre>
304      * @since 3.0
305      */
306     public static final String JavaDoc FORMATTER_BLANK_LINES_AFTER_PACKAGE = JavaCore.PLUGIN_ID + ".formatter.blank_lines_after_package"; //$NON-NLS-1$
307 /**
308      * <pre>
309      * FORMATTER / Option to add blank lines at the beginning of the method body
310      * - option id: "org.eclipse.jdt.core.formatter.number_of_blank_lines_at_beginning_of_method_body"
311      * - possible values: "&lt;n&gt;", where n is zero or a positive integer
312      * - default: "0"
313      * </pre>
314      * @since 3.0
315      */
316     public static final String JavaDoc FORMATTER_BLANK_LINES_AT_BEGINNING_OF_METHOD_BODY = JavaCore.PLUGIN_ID + ".formatter.number_of_blank_lines_at_beginning_of_method_body"; //$NON-NLS-1$
317 /**
318      * <pre>
319      * FORMATTER / Option to add blank lines before a field declaration
320      * - option id: "org.eclipse.jdt.core.formatter.blank_lines_before_field"
321      * - possible values: "&lt;n&gt;", where n is zero or a positive integer
322      * - default: "0"
323      * </pre>
324      * @since 3.0
325      */
326     public static final String JavaDoc FORMATTER_BLANK_LINES_BEFORE_FIELD = JavaCore.PLUGIN_ID + ".formatter.blank_lines_before_field"; //$NON-NLS-1$
327 /**
328      * <pre>
329      * FORMATTER / Option to add blank lines before the first class body declaration
330      * - option id: "org.eclipse.jdt.core.formatter.blank_lines_before_first_class_body_declaration"
331      * - possible values: "&lt;n&gt;", where n is zero or a positive integer
332      * - default: "0"
333      * </pre>
334      * @since 3.0
335      */
336     public static final String JavaDoc FORMATTER_BLANK_LINES_BEFORE_FIRST_CLASS_BODY_DECLARATION = JavaCore.PLUGIN_ID + ".formatter.blank_lines_before_first_class_body_declaration"; //$NON-NLS-1$
337 /**
338      * <pre>
339      * FORMATTER / Option to add blank lines before the imports declaration
340      * - option id: "org.eclipse.jdt.core.formatter.blank_lines_before_imports"
341      * - possible values: "&lt;n&gt;", where n is zero or a positive integer
342      * - default: "0"
343      * </pre>
344      * @since 3.0
345      */
346     public static final String JavaDoc FORMATTER_BLANK_LINES_BEFORE_IMPORTS = JavaCore.PLUGIN_ID + ".formatter.blank_lines_before_imports"; //$NON-NLS-1$
347 /**
348      * <pre>
349      * FORMATTER / Option to add blank lines before a member type declaration
350      * - option id: "org.eclipse.jdt.core.formatter.blank_lines_before_member_type"
351      * - possible values: "&lt;n&gt;", where n is zero or a positive integer
352      * - default: "0"
353      * </pre>
354      * @since 3.0
355      */
356     public static final String JavaDoc FORMATTER_BLANK_LINES_BEFORE_MEMBER_TYPE = JavaCore.PLUGIN_ID + ".formatter.blank_lines_before_member_type"; //$NON-NLS-1$
357 /**
358      * <pre>
359      * FORMATTER / Option to add blank lines before a method declaration
360      * - option id: "org.eclipse.jdt.core.formatter.blank_lines_before_method"
361      * - possible values: "&lt;n&gt;", where n is zero or a positive integer
362      * - default: "0"
363      * </pre>
364      * @since 3.0
365      */
366     public static final String JavaDoc FORMATTER_BLANK_LINES_BEFORE_METHOD = JavaCore.PLUGIN_ID + ".formatter.blank_lines_before_method"; //$NON-NLS-1$
367 /**
368      * <pre>
369      * FORMATTER / Option to add blank lines before a new chunk
370      * - option id: "org.eclipse.jdt.core.formatter.blank_lines_before_new_chunk"
371      * - possible values: "&lt;n&gt;", where n is zero or a positive integer
372      * - default: "0"
373      * </pre>
374      * @since 3.0
375      */
376     public static final String JavaDoc FORMATTER_BLANK_LINES_BEFORE_NEW_CHUNK = JavaCore.PLUGIN_ID + ".formatter.blank_lines_before_new_chunk"; //$NON-NLS-1$
377 /**
378      * <pre>
379      * FORMATTER / Option to add blank lines before the package declaration
380      * - option id: "org.eclipse.jdt.core.formatter.blank_lines_before_package"
381      * - possible values: "&lt;n&gt;", where n is zero or a positive integer
382      * - default: "0"
383      * </pre>
384      * @since 3.0
385      */
386     public static final String JavaDoc FORMATTER_BLANK_LINES_BEFORE_PACKAGE = JavaCore.PLUGIN_ID + ".formatter.blank_lines_before_package"; //$NON-NLS-1$
387 /**
388      * <pre>
389      * FORMATTER / Option to add blank lines between import groups
390      * - option id: "org.eclipse.jdt.core.formatter.blank_lines_between_import_groups"
391      * - possible values: "&lt;n&gt;", where n is zero or a positive integer
392      * - default: "1"
393      * </pre>
394      * Note: Import groups are defined once "Organize Import" operation has been executed. The code formatter itself
395      * doesn't define the import groups.
396      *
397      * @since 3.3
398      */
399     public static final String JavaDoc FORMATTER_BLANK_LINES_BETWEEN_IMPORT_GROUPS = JavaCore.PLUGIN_ID + ".formatter.blank_lines_between_import_groups"; //$NON-NLS-1$
400 /**
401      * <pre>
402      * FORMATTER / Option to add blank lines between type declarations
403      * - option id: "org.eclipse.jdt.core.formatter.blank_lines_between_type_declarations"
404      * - possible values: "&lt;n&gt;", where n is zero or a positive integer
405      * - default: "0"
406      * </pre>
407      * @since 3.0
408      */
409     public static final String JavaDoc FORMATTER_BLANK_LINES_BETWEEN_TYPE_DECLARATIONS = JavaCore.PLUGIN_ID + ".formatter.blank_lines_between_type_declarations"; //$NON-NLS-1$
410 /**
411      * <pre>
412      * FORMATTER / Option to position the braces of an annotation type declaration
413      * - option id: "org.eclipse.jdt.core.formatter.brace_position_for_annotation_type_declaration"
414      * - possible values: { END_OF_LINE, NEXT_LINE, NEXT_LINE_SHIFTED, NEXT_LINE_ON_WRAP }
415      * - default: END_OF_LINE
416      * </pre>
417      * @see #END_OF_LINE
418      * @see #NEXT_LINE
419      * @see #NEXT_LINE_SHIFTED
420      * @see #NEXT_LINE_ON_WRAP
421      * @since 3.1
422      */
423     public static final String JavaDoc FORMATTER_BRACE_POSITION_FOR_ANNOTATION_TYPE_DECLARATION = JavaCore.PLUGIN_ID + ".formatter.brace_position_for_annotation_type_declaration"; //$NON-NLS-1$
424 /**
425      * <pre>
426      * FORMATTER / Option to position the braces of an anonymous type declaration
427      * - option id: "org.eclipse.jdt.core.formatter.brace_position_for_anonymous_type_declaration"
428      * - possible values: { END_OF_LINE, NEXT_LINE, NEXT_LINE_SHIFTED, NEXT_LINE_ON_WRAP }
429      * - default: END_OF_LINE
430      * </pre>
431      * @see #END_OF_LINE
432      * @see #NEXT_LINE
433      * @see #NEXT_LINE_SHIFTED
434      * @see #NEXT_LINE_ON_WRAP
435      * @since 3.0
436      */
437     public static final String JavaDoc FORMATTER_BRACE_POSITION_FOR_ANONYMOUS_TYPE_DECLARATION = JavaCore.PLUGIN_ID + ".formatter.brace_position_for_anonymous_type_declaration"; //$NON-NLS-1$
438 /**
439      * <pre>
440      * FORMATTER / Option to position the braces of an array initializer
441      * - option id: "org.eclipse.jdt.core.formatter.brace_position_for_array_initializer"
442      * - possible values: { END_OF_LINE, NEXT_LINE, NEXT_LINE_SHIFTED, NEXT_LINE_ON_WRAP }
443      * - default: END_OF_LINE
444      * </pre>
445      * @see #END_OF_LINE
446      * @see #NEXT_LINE
447      * @see #NEXT_LINE_SHIFTED
448      * @see #NEXT_LINE_ON_WRAP
449      * @since 3.0
450      */
451     public static final String JavaDoc FORMATTER_BRACE_POSITION_FOR_ARRAY_INITIALIZER = JavaCore.PLUGIN_ID + ".formatter.brace_position_for_array_initializer"; //$NON-NLS-1$
452 /**
453      * <pre>
454      * FORMATTER / Option to position the braces of a block
455      * - option id: "org.eclipse.jdt.core.formatter.brace_position_for_block"
456      * - possible values: { END_OF_LINE, NEXT_LINE, NEXT_LINE_SHIFTED, NEXT_LINE_ON_WRAP }
457      * - default: END_OF_LINE
458      * </pre>
459      * @see #END_OF_LINE
460      * @see #NEXT_LINE
461      * @see #NEXT_LINE_SHIFTED
462      * @see #NEXT_LINE_ON_WRAP
463      * @since 3.0
464      */
465     public static final String JavaDoc FORMATTER_BRACE_POSITION_FOR_BLOCK = JavaCore.PLUGIN_ID + ".formatter.brace_position_for_block"; //$NON-NLS-1$
466 /**
467      * <pre>
468      * FORMATTER / Option to position the braces of a block in a case statement when the block is the first statement following
469      * the case
470      * - option id: "org.eclipse.jdt.core.formatter.brace_position_for_block_in_case"
471      * - possible values: { END_OF_LINE, NEXT_LINE, NEXT_LINE_SHIFTED, NEXT_LINE_ON_WRAP }
472      * - default: END_OF_LINE
473      * </pre>
474      * @see #END_OF_LINE
475      * @see #NEXT_LINE
476      * @see #NEXT_LINE_SHIFTED
477      * @see #NEXT_LINE_ON_WRAP
478      * @since 3.0
479      */
480     public static final String JavaDoc FORMATTER_BRACE_POSITION_FOR_BLOCK_IN_CASE = JavaCore.PLUGIN_ID + ".formatter.brace_position_for_block_in_case"; //$NON-NLS-1$
481 /**
482      * <pre>
483      * FORMATTER / Option to position the braces of a constructor declaration
484      * - option id: "org.eclipse.jdt.core.formatter.brace_position_for_constructor_declaration"
485      * - possible values: { END_OF_LINE, NEXT_LINE, NEXT_LINE_SHIFTED, NEXT_LINE_ON_WRAP }
486      * - default: END_OF_LINE
487      * </pre>
488      * @see #END_OF_LINE
489      * @see #NEXT_LINE
490      * @see #NEXT_LINE_SHIFTED
491      * @see #NEXT_LINE_ON_WRAP
492      * @since 3.0
493      */
494     public static final String JavaDoc FORMATTER_BRACE_POSITION_FOR_CONSTRUCTOR_DECLARATION = JavaCore.PLUGIN_ID + ".formatter.brace_position_for_constructor_declaration"; //$NON-NLS-1$
495 /**
496      * <pre>
497      * FORMATTER / Option to position the braces of an enum constant
498      * - option id: "org.eclipse.jdt.core.formatter.brace_position_for_enum_constant"
499      * - possible values: { END_OF_LINE, NEXT_LINE, NEXT_LINE_SHIFTED, NEXT_LINE_ON_WRAP }
500      * - default: END_OF_LINE
501      * </pre>
502      * @see #END_OF_LINE
503      * @see #NEXT_LINE
504      * @see #NEXT_LINE_SHIFTED
505      * @see #NEXT_LINE_ON_WRAP
506      * @since 3.1
507      */
508     public static final String JavaDoc FORMATTER_BRACE_POSITION_FOR_ENUM_CONSTANT = JavaCore.PLUGIN_ID + ".formatter.brace_position_for_enum_constant"; //$NON-NLS-1$
509 /**
510      * <pre>
511      * FORMATTER / Option to position the braces of an enum declaration
512      * - option id: "org.eclipse.jdt.core.formatter.brace_position_for_enum_declaration"
513      * - possible values: { END_OF_LINE, NEXT_LINE, NEXT_LINE_SHIFTED, NEXT_LINE_ON_WRAP }
514      * - default: END_OF_LINE
515      * </pre>
516      * @see #END_OF_LINE
517      * @see #NEXT_LINE
518      * @see #NEXT_LINE_SHIFTED
519      * @see #NEXT_LINE_ON_WRAP
520      * @since 3.1
521      */
522     public static final String JavaDoc FORMATTER_BRACE_POSITION_FOR_ENUM_DECLARATION = JavaCore.PLUGIN_ID + ".formatter.brace_position_for_enum_declaration"; //$NON-NLS-1$
523 /**
524      * <pre>
525      * FORMATTER / Option to position the braces of a method declaration
526      * - option id: "org.eclipse.jdt.core.formatter.brace_position_for_method_declaration"
527      * - possible values: { END_OF_LINE, NEXT_LINE, NEXT_LINE_SHIFTED, NEXT_LINE_ON_WRAP }
528      * - default: END_OF_LINE
529      * </pre>
530      * @see #END_OF_LINE
531      * @see #NEXT_LINE
532      * @see #NEXT_LINE_SHIFTED
533      * @see #NEXT_LINE_ON_WRAP
534      * @since 3.0
535      */
536     public static final String JavaDoc FORMATTER_BRACE_POSITION_FOR_METHOD_DECLARATION = JavaCore.PLUGIN_ID + ".formatter.brace_position_for_method_declaration"; //$NON-NLS-1$
537 /**
538      * <pre>
539      * FORMATTER / Option to position the braces of a switch statement
540      * - option id: "org.eclipse.jdt.core.formatter.brace_position_for_switch"
541      * - possible values: { END_OF_LINE, NEXT_LINE, NEXT_LINE_SHIFTED, NEXT_LINE_ON_WRAP }
542      * - default: END_OF_LINE
543      * </pre>
544      * @see #END_OF_LINE
545      * @see #NEXT_LINE
546      * @see #NEXT_LINE_SHIFTED
547      * @see #NEXT_LINE_ON_WRAP
548      * @since 3.0
549      */
550     public static final String JavaDoc FORMATTER_BRACE_POSITION_FOR_SWITCH = JavaCore.PLUGIN_ID + ".formatter.brace_position_for_switch"; //$NON-NLS-1$
551 /**
552      * <pre>
553      * FORMATTER / Option to position the braces of a type declaration
554      * - option id: "org.eclipse.jdt.core.formatter.brace_position_for_type_declaration"
555      * - possible values: { END_OF_LINE, NEXT_LINE, NEXT_LINE_SHIFTED, NEXT_LINE_ON_WRAP }
556      * - default: END_OF_LINE
557      * </pre>
558      * @see #END_OF_LINE
559      * @see #NEXT_LINE
560      * @see #NEXT_LINE_SHIFTED
561      * @see #NEXT_LINE_ON_WRAP
562      * @since 3.0
563      */
564     public static final String JavaDoc FORMATTER_BRACE_POSITION_FOR_TYPE_DECLARATION = JavaCore.PLUGIN_ID + ".formatter.brace_position_for_type_declaration"; //$NON-NLS-1$
565
566     /**
567      * <pre>
568      * FORMATTER / Option to control whether blank lines are cleared inside comments
569      * - option id: "org.eclipse.jdt.core.formatter.comment.clear_blank_lines"
570      * - possible values: { TRUE, FALSE }
571      * - default: FALSE
572      * </pre>
573      * @see #TRUE
574      * @see #FALSE
575      * @since 3.1
576      * @deprecated Use {@link #FORMATTER_COMMENT_CLEAR_BLANK_LINES_IN_BLOCK_COMMENT} and {@link #FORMATTER_COMMENT_CLEAR_BLANK_LINES_IN_JAVADOC_COMMENT}
577      */
578     public final static String JavaDoc FORMATTER_COMMENT_CLEAR_BLANK_LINES = "org.eclipse.jdt.core.formatter.comment.clear_blank_lines"; //$NON-NLS-1$
579
580     /**
581      * <pre>
582      * FORMATTER / Option to control whether blank lines are cleared inside javadoc comments
583      * - option id: "org.eclipse.jdt.core.formatter.comment.clear_blank_lines_in_javadoc_comment"
584      * - possible values: { TRUE, FALSE }
585      * - default: FALSE
586      * </pre>
587      * @see #TRUE
588      * @see #FALSE
589      * @since 3.3
590      */
591     public final static String JavaDoc FORMATTER_COMMENT_CLEAR_BLANK_LINES_IN_JAVADOC_COMMENT = "org.eclipse.jdt.core.formatter.comment.clear_blank_lines_in_javadoc_comment"; //$NON-NLS-1$
592
593     /**
594      * <pre>
595      * FORMATTER / Option to control whether blank lines are cleared inside block comments
596      * - option id: "org.eclipse.jdt.core.formatter.comment.clear_blank_lines_in_block_comment"
597      * - possible values: { TRUE, FALSE }
598      * - default: FALSE
599      * </pre>
600      * @see #TRUE
601      * @see #FALSE
602      * @since 3.3
603      */
604     public final static String JavaDoc FORMATTER_COMMENT_CLEAR_BLANK_LINES_IN_BLOCK_COMMENT = "org.eclipse.jdt.core.formatter.comment.clear_blank_lines_in_block_comment"; //$NON-NLS-1$
605
606     /**
607      * <pre>
608      * FORMATTER / Option to control whether comments are formatted
609      * - option id: "org.eclipse.jdt.core.formatter.comment.format_comments"
610      * - possible values: { TRUE, FALSE }
611      * - default: TRUE
612      * </pre>
613      * @see #TRUE
614      * @see #FALSE
615      * @since 3.1
616      * @deprecated Use multiple settings for each kind of comments. See {@link #FORMATTER_COMMENT_FORMAT_BLOCK_COMMENT},
617      * {@link #FORMATTER_COMMENT_FORMAT_JAVADOC_COMMENT} and {@link #FORMATTER_COMMENT_FORMAT_LINE_COMMENT}.
618      */
619     public final static String JavaDoc FORMATTER_COMMENT_FORMAT = "org.eclipse.jdt.core.formatter.comment.format_comments"; //$NON-NLS-1$
620
621     /**
622      * <pre>
623      * FORMATTER / Option to control whether single line comments are formatted
624      * - option id: "org.eclipse.jdt.core.formatter.comment.format_line_comments"
625      * - possible values: { TRUE, FALSE }
626      * - default: TRUE
627      * </pre>
628      * @see #TRUE
629      * @see #FALSE
630      * @since 3.3
631      */
632     public final static String JavaDoc FORMATTER_COMMENT_FORMAT_LINE_COMMENT = "org.eclipse.jdt.core.formatter.comment.format_line_comments"; //$NON-NLS-1$
633
634     /**
635      * <pre>
636      * FORMATTER / Option to control whether multiple lines comments are formatted
637      * - option id: "org.eclipse.jdt.core.formatter.comment.format_block_comments"
638      * - possible values: { TRUE, FALSE }
639      * - default: TRUE
640      * </pre>
641      * @see #TRUE
642      * @see #FALSE
643      * @since 3.3
644      */
645     public final static String JavaDoc FORMATTER_COMMENT_FORMAT_BLOCK_COMMENT = "org.eclipse.jdt.core.formatter.comment.format_block_comments"; //$NON-NLS-1$
646
647     /**
648      * <pre>
649      * FORMATTER / Option to control whether javadoc comments are formatted
650      * - option id: "org.eclipse.jdt.core.formatter.comment.format_javadoc_comments"
651      * - possible values: { TRUE, FALSE }
652      * - default: TRUE
653      * </pre>
654      * @see #TRUE
655      * @see #FALSE
656      * @since 3.3
657      */
658     public final static String JavaDoc FORMATTER_COMMENT_FORMAT_JAVADOC_COMMENT = "org.eclipse.jdt.core.formatter.comment.format_javadoc_comments"; //$NON-NLS-1$
659
660     /**
661      * <pre>
662      * FORMATTER / Option to control whether the header comment of a Java source file is formatted
663      * - option id: "org.eclipse.jdt.core.formatter.comment.format_header"
664      * - possible values: { TRUE, FALSE }
665      * - default: FALSE
666      * </pre>
667      * @see #TRUE
668      * @see #FALSE
669      * @since 3.1
670      */
671     public final static String JavaDoc FORMATTER_COMMENT_FORMAT_HEADER = "org.eclipse.jdt.core.formatter.comment.format_header"; //$NON-NLS-1$
672
673     /**
674      * <pre>
675      * FORMATTER / Option to control whether HTML tags are formatted.
676      * - option id: "org.eclipse.jdt.core.formatter.comment.format_html"
677      * - possible values: { TRUE, FALSE }
678      * - default: TRUE
679      * </pre>
680      * @see #TRUE
681      * @see #FALSE
682      * @since 3.1
683      */
684     public final static String JavaDoc FORMATTER_COMMENT_FORMAT_HTML = "org.eclipse.jdt.core.formatter.comment.format_html"; //$NON-NLS-1$
685
686     /**
687      * <pre>
688      * FORMATTER / Option to control whether code snippets are formatted in comments
689      * - option id: "org.eclipse.jdt.core.formatter.comment.format_source_code"
690      * - possible values: { TRUE, FALSE }
691      * - default: TRUE
692      * </pre>
693      * @see #TRUE
694      * @see #FALSE
695      * @since 3.1
696      */
697     public final static String JavaDoc FORMATTER_COMMENT_FORMAT_SOURCE = "org.eclipse.jdt.core.formatter.comment.format_source_code"; //$NON-NLS-1$
698
699     /**
700      * <pre>
701      * FORMATTER / Option to control whether description of Javadoc parameters are indented
702      * - option id: "org.eclipse.jdt.core.formatter.comment.indent_parameter_description"
703      * - possible values: { TRUE, FALSE }
704      * - default: TRUE
705      * </pre>
706      * @see #TRUE
707      * @see #FALSE
708      * @since 3.1
709      */
710     public final static String JavaDoc FORMATTER_COMMENT_INDENT_PARAMETER_DESCRIPTION = "org.eclipse.jdt.core.formatter.comment.indent_parameter_description"; //$NON-NLS-1$
711
712     /**
713      * <pre>
714      * FORMATTER / Option to control whether Javadoc root tags are indented.
715      * - option id: "org.eclipse.jdt.core.formatter.comment.indent_root_tags"
716      * - possible values: { TRUE, FALSE }
717      * - default: TRUE
718      * </pre>
719      * @see #TRUE
720      * @see #FALSE
721      * @since 3.1
722      */
723     public final static String JavaDoc FORMATTER_COMMENT_INDENT_ROOT_TAGS = "org.eclipse.jdt.core.formatter.comment.indent_root_tags"; //$NON-NLS-1$
724
725     /**
726      * <pre>
727      * FORMATTER / Option to insert an empty line before the Javadoc root tag block
728      * - option id: "org.eclipse.jdt.core.formatter.comment.insert_new_line_before_root_tags"
729      * - possible values: { INSERT, DO_NOT_INSERT }
730      * - default: INSERT
731      * </pre>
732      * @see JavaCore#INSERT
733      * @see JavaCore#DO_NOT_INSERT
734      * @since 3.1
735      */
736     public final static String JavaDoc FORMATTER_COMMENT_INSERT_EMPTY_LINE_BEFORE_ROOT_TAGS = "org.eclipse.jdt.core.formatter.comment.insert_new_line_before_root_tags"; //$NON-NLS-1$
737
738     /**
739      * <pre>
740      * FORMATTER / Option to insert a new line after Javadoc root tag parameters
741      * - option id: "org.eclipse.jdt.core.formatter.comment.insert_new_line_for_parameter"
742      * - possible values: { INSERT, DO_NOT_INSERT }
743      * - default: INSERT
744      * </pre>
745      * @see JavaCore#INSERT
746      * @see JavaCore#DO_NOT_INSERT
747      * @since 3.1
748      */
749     public final static String JavaDoc FORMATTER_COMMENT_INSERT_NEW_LINE_FOR_PARAMETER = "org.eclipse.jdt.core.formatter.comment.insert_new_line_for_parameter"; //$NON-NLS-1$
750
751     /**
752      * <pre>
753      * FORMATTER / Option to specify the line length for comments.
754      * - option id: "org.eclipse.jdt.core.formatter.comment.line_length"
755      * - possible values: "&lt;n&gt;", where n is zero or a positive integer
756      * - default: "80"
757      * </pre>
758      * @since 3.1
759      */
760     public final static String JavaDoc FORMATTER_COMMENT_LINE_LENGTH = "org.eclipse.jdt.core.formatter.comment.line_length"; //$NON-NLS-1$
761
762     /**
763      * <pre>
764      * FORMATTER / Option to compact else/if
765      * - option id: "org.eclipse.jdt.core.formatter.compact_else_if"
766      * - possible values: { TRUE, FALSE }
767      * - default: TRUE
768      * </pre>
769      * @see #TRUE
770      * @see #FALSE
771      * @since 3.0
772      */
773     public static final String JavaDoc FORMATTER_COMPACT_ELSE_IF = JavaCore.PLUGIN_ID + ".formatter.compact_else_if"; //$NON-NLS-1$
774
775     /**
776      * <pre>
777      * FORMATTER / Option to set the continuation indentation
778      * - option id: "org.eclipse.jdt.core.formatter.continuation_indentation"
779      * - possible values: "&lt;n&gt;", where n is zero or a positive integer
780      * - default: "2"
781      * </pre>
782      * @since 3.0
783      */
784     public static final String JavaDoc FORMATTER_CONTINUATION_INDENTATION = JavaCore.PLUGIN_ID + ".formatter.continuation_indentation"; //$NON-NLS-1$
785 /**
786      * <pre>
787      * FORMATTER / Option to set the continuation indentation inside array initializer
788      * - option id: "org.eclipse.jdt.core.formatter.continuation_indentation_for_array_initializer"
789      * - possible values: "&lt;n&gt;", where n is zero or a positive integer
790      * - default: "2"
791      * </pre>
792      * @since 3.0
793      */
794     public static final String JavaDoc FORMATTER_CONTINUATION_INDENTATION_FOR_ARRAY_INITIALIZER = JavaCore.PLUGIN_ID + ".formatter.continuation_indentation_for_array_initializer"; //$NON-NLS-1$
795 /**
796      * <pre>
797      * FORMATTER / Option to indent body declarations compare to its enclosing annotation declaration header
798      * - option id: "org.eclipse.jdt.core.formatter.indent_body_declarations_compare_to_annotation_declaration_header"
799      * - possible values: { TRUE, FALSE }
800      * - default: TRUE
801      * </pre>
802      * @see #TRUE
803      * @see #FALSE
804      * @since 3.2
805      */
806     public static final String JavaDoc FORMATTER_INDENT_BODY_DECLARATIONS_COMPARE_TO_ANNOTATION_DECLARATION_HEADER = JavaCore.PLUGIN_ID + ".formatter.indent_body_declarations_compare_to_annotation_declaration_header"; //$NON-NLS-1$
807 /**
808      * <pre>
809      * FORMATTER / Option to indent body declarations compare to its enclosing enum constant header
810      * - option id: "org.eclipse.jdt.core.formatter.indent_body_declarations_compare_to_enum_constant_header"
811      * - possible values: { TRUE, FALSE }
812      * - default: TRUE
813      * </pre>
814      * @see #TRUE
815      * @see #FALSE
816      * @since 3.1
817      */
818     public static final String JavaDoc FORMATTER_INDENT_BODY_DECLARATIONS_COMPARE_TO_ENUM_CONSTANT_HEADER = JavaCore.PLUGIN_ID + ".formatter.indent_body_declarations_compare_to_enum_constant_header"; //$NON-NLS-1$
819 /**
820      * <pre>
821      * FORMATTER / Option to indent body declarations compare to its enclosing enum declaration header
822      * - option id: "org.eclipse.jdt.core.formatter.indent_body_declarations_compare_to_enum_declaration_header"
823      * - possible values: { TRUE, FALSE }
824      * - default: TRUE
825      * </pre>
826      * @see #TRUE
827      * @see #FALSE
828      * @since 3.1
829      */
830     public static final String JavaDoc FORMATTER_INDENT_BODY_DECLARATIONS_COMPARE_TO_ENUM_DECLARATION_HEADER = JavaCore.PLUGIN_ID + ".formatter.indent_body_declarations_compare_to_enum_declaration_header"; //$NON-NLS-1$
831 /**
832      * <pre>
833      * FORMATTER / Option to indent body declarations compare to its enclosing type header
834      * - option id: "org.eclipse.jdt.core.formatter.indent_body_declarations_compare_to_type_header"
835      * - possible values: { TRUE, FALSE }
836      * - default: TRUE
837      * </pre>
838      * @see #TRUE
839      * @see #FALSE
840      * @since 3.0
841      */
842     public static final String JavaDoc FORMATTER_INDENT_BODY_DECLARATIONS_COMPARE_TO_TYPE_HEADER = JavaCore.PLUGIN_ID + ".formatter.indent_body_declarations_compare_to_type_header"; //$NON-NLS-1$
843 /**
844      * <pre>
845      * FORMATTER / Option to indent breaks compare to cases
846      * - option id: "org.eclipse.jdt.core.formatter.indent_breaks_compare_to_cases"
847      * - possible values: { TRUE, FALSE }
848      * - default: TRUE
849      * </pre>
850      * @see #TRUE
851      * @see #FALSE
852      * @since 3.0
853      */
854     public static final String JavaDoc FORMATTER_INDENT_BREAKS_COMPARE_TO_CASES = JavaCore.PLUGIN_ID + ".formatter.indent_breaks_compare_to_cases"; //$NON-NLS-1$
855 /**
856      * <pre>
857      * FORMATTER / Option to indent empty lines
858      * - option id: "org.eclipse.jdt.core.formatter.indent_empty_lines"
859      * - possible values: { TRUE, FALSE }
860      * - default: FALSE
861      * </pre>
862      * @see #TRUE
863      * @see #FALSE
864      * @since 3.2
865      */
866     public static final String JavaDoc FORMATTER_INDENT_EMPTY_LINES = JavaCore.PLUGIN_ID + ".formatter.indent_empty_lines"; //$NON-NLS-1$
867 /**
868      * <pre>
869      * FORMATTER / Option to indent statements inside a block
870      * - option id: "org.eclipse.jdt.core.formatter.indent_statements_compare_to_block"
871