diff options
| author | Simon Scholz | 2015-03-16 09:04:07 +0000 |
|---|---|---|
| committer | Lars Vogel | 2015-03-16 12:43:05 +0000 |
| commit | fdfde67ac3a70f74410855351725d2e1ebac7177 (patch) | |
| tree | 4b416b0b489397c03f5301c412716ec7e34a41a0 | |
| parent | ea3820e813d8943231e3d2e19a652d7b59380a12 (diff) | |
| download | eclipse.platform.runtime-fdfde67ac3a70f74410855351725d2e1ebac7177.tar.gz eclipse.platform.runtime-fdfde67ac3a70f74410855351725d2e1ebac7177.tar.xz eclipse.platform.runtime-fdfde67ac3a70f74410855351725d2e1ebac7177.zip | |
Bug 462035 - Solve whitespace issues in eclipse.runtime plug-ins
Change-Id: Ib6b64f71363bd4db73c6f74e1b823f568a2e4536
Signed-off-by: Simon Scholz <simon.scholz@vogella.com>
33 files changed, 534 insertions, 429 deletions
diff --git a/bundles/org.eclipse.core.contenttype/.settings/org.eclipse.jdt.core.prefs b/bundles/org.eclipse.core.contenttype/.settings/org.eclipse.jdt.core.prefs index 3c8073ac7..3cf59829e 100644 --- a/bundles/org.eclipse.core.contenttype/.settings/org.eclipse.jdt.core.prefs +++ b/bundles/org.eclipse.core.contenttype/.settings/org.eclipse.jdt.core.prefs @@ -123,6 +123,7 @@ org.eclipse.jdt.core.compiler.problem.varargsArgumentNeedCast=warning org.eclipse.jdt.core.compiler.source=1.7 org.eclipse.jdt.core.formatter.align_type_members_on_columns=false org.eclipse.jdt.core.formatter.alignment_for_arguments_in_allocation_expression=16 +org.eclipse.jdt.core.formatter.alignment_for_arguments_in_annotation=0 org.eclipse.jdt.core.formatter.alignment_for_arguments_in_enum_constant=16 org.eclipse.jdt.core.formatter.alignment_for_arguments_in_explicit_constructor_call=16 org.eclipse.jdt.core.formatter.alignment_for_arguments_in_method_invocation=16 @@ -133,15 +134,18 @@ org.eclipse.jdt.core.formatter.alignment_for_compact_if=16 org.eclipse.jdt.core.formatter.alignment_for_conditional_expression=80 org.eclipse.jdt.core.formatter.alignment_for_enum_constants=0 org.eclipse.jdt.core.formatter.alignment_for_expressions_in_array_initializer=16 +org.eclipse.jdt.core.formatter.alignment_for_method_declaration=0 org.eclipse.jdt.core.formatter.alignment_for_multiple_fields=16 org.eclipse.jdt.core.formatter.alignment_for_parameters_in_constructor_declaration=16 org.eclipse.jdt.core.formatter.alignment_for_parameters_in_method_declaration=16 +org.eclipse.jdt.core.formatter.alignment_for_resources_in_try=80 org.eclipse.jdt.core.formatter.alignment_for_selector_in_method_invocation=16 org.eclipse.jdt.core.formatter.alignment_for_superclass_in_type_declaration=16 org.eclipse.jdt.core.formatter.alignment_for_superinterfaces_in_enum_declaration=16 org.eclipse.jdt.core.formatter.alignment_for_superinterfaces_in_type_declaration=16 org.eclipse.jdt.core.formatter.alignment_for_throws_clause_in_constructor_declaration=16 org.eclipse.jdt.core.formatter.alignment_for_throws_clause_in_method_declaration=16 +org.eclipse.jdt.core.formatter.alignment_for_union_type_in_multicatch=16 org.eclipse.jdt.core.formatter.blank_lines_after_imports=1 org.eclipse.jdt.core.formatter.blank_lines_after_package=1 org.eclipse.jdt.core.formatter.blank_lines_before_field=0 @@ -161,26 +165,33 @@ org.eclipse.jdt.core.formatter.brace_position_for_block_in_case=end_of_line org.eclipse.jdt.core.formatter.brace_position_for_constructor_declaration=end_of_line org.eclipse.jdt.core.formatter.brace_position_for_enum_constant=end_of_line org.eclipse.jdt.core.formatter.brace_position_for_enum_declaration=end_of_line +org.eclipse.jdt.core.formatter.brace_position_for_lambda_body=end_of_line org.eclipse.jdt.core.formatter.brace_position_for_method_declaration=end_of_line org.eclipse.jdt.core.formatter.brace_position_for_switch=end_of_line org.eclipse.jdt.core.formatter.brace_position_for_type_declaration=end_of_line org.eclipse.jdt.core.formatter.comment.clear_blank_lines_in_block_comment=false org.eclipse.jdt.core.formatter.comment.clear_blank_lines_in_javadoc_comment=false -org.eclipse.jdt.core.formatter.comment.format_block_comments=false +org.eclipse.jdt.core.formatter.comment.format_block_comments=true org.eclipse.jdt.core.formatter.comment.format_header=false org.eclipse.jdt.core.formatter.comment.format_html=true -org.eclipse.jdt.core.formatter.comment.format_javadoc_comments=false -org.eclipse.jdt.core.formatter.comment.format_line_comments=false +org.eclipse.jdt.core.formatter.comment.format_javadoc_comments=true +org.eclipse.jdt.core.formatter.comment.format_line_comments=true org.eclipse.jdt.core.formatter.comment.format_source_code=true -org.eclipse.jdt.core.formatter.comment.indent_parameter_description=false -org.eclipse.jdt.core.formatter.comment.indent_root_tags=false +org.eclipse.jdt.core.formatter.comment.indent_parameter_description=true +org.eclipse.jdt.core.formatter.comment.indent_root_tags=true org.eclipse.jdt.core.formatter.comment.insert_new_line_before_root_tags=insert -org.eclipse.jdt.core.formatter.comment.insert_new_line_for_parameter=do not insert +org.eclipse.jdt.core.formatter.comment.insert_new_line_for_parameter=insert org.eclipse.jdt.core.formatter.comment.line_length=80 +org.eclipse.jdt.core.formatter.comment.new_lines_at_block_boundaries=true +org.eclipse.jdt.core.formatter.comment.new_lines_at_javadoc_boundaries=true +org.eclipse.jdt.core.formatter.comment.preserve_white_space_between_code_and_line_comments=false org.eclipse.jdt.core.formatter.compact_else_if=true org.eclipse.jdt.core.formatter.continuation_indentation=2 org.eclipse.jdt.core.formatter.continuation_indentation_for_array_initializer=2 +org.eclipse.jdt.core.formatter.disabling_tag=@formatter\:off +org.eclipse.jdt.core.formatter.enabling_tag=@formatter\:on org.eclipse.jdt.core.formatter.format_guardian_clause_on_one_line=false +org.eclipse.jdt.core.formatter.format_line_comment_starting_on_first_column=true org.eclipse.jdt.core.formatter.indent_body_declarations_compare_to_annotation_declaration_header=true org.eclipse.jdt.core.formatter.indent_body_declarations_compare_to_enum_constant_header=true org.eclipse.jdt.core.formatter.indent_body_declarations_compare_to_enum_declaration_header=true @@ -190,15 +201,17 @@ org.eclipse.jdt.core.formatter.indent_empty_lines=false org.eclipse.jdt.core.formatter.indent_statements_compare_to_block=true org.eclipse.jdt.core.formatter.indent_statements_compare_to_body=true org.eclipse.jdt.core.formatter.indent_switchstatements_compare_to_cases=true -org.eclipse.jdt.core.formatter.indent_switchstatements_compare_to_switch=true +org.eclipse.jdt.core.formatter.indent_switchstatements_compare_to_switch=false org.eclipse.jdt.core.formatter.indentation.size=4 org.eclipse.jdt.core.formatter.insert_new_line_after_annotation_on_field=insert org.eclipse.jdt.core.formatter.insert_new_line_after_annotation_on_local_variable=insert org.eclipse.jdt.core.formatter.insert_new_line_after_annotation_on_method=insert org.eclipse.jdt.core.formatter.insert_new_line_after_annotation_on_package=insert -org.eclipse.jdt.core.formatter.insert_new_line_after_annotation_on_parameter=insert +org.eclipse.jdt.core.formatter.insert_new_line_after_annotation_on_parameter=do not insert org.eclipse.jdt.core.formatter.insert_new_line_after_annotation_on_type=insert +org.eclipse.jdt.core.formatter.insert_new_line_after_label=do not insert org.eclipse.jdt.core.formatter.insert_new_line_after_opening_brace_in_array_initializer=do not insert +org.eclipse.jdt.core.formatter.insert_new_line_after_type_annotation=do not insert org.eclipse.jdt.core.formatter.insert_new_line_at_end_of_file_if_missing=do not insert org.eclipse.jdt.core.formatter.insert_new_line_before_catch_in_try_statement=do not insert org.eclipse.jdt.core.formatter.insert_new_line_before_closing_brace_in_array_initializer=do not insert @@ -206,7 +219,7 @@ org.eclipse.jdt.core.formatter.insert_new_line_before_else_in_if_statement=do no org.eclipse.jdt.core.formatter.insert_new_line_before_finally_in_try_statement=do not insert org.eclipse.jdt.core.formatter.insert_new_line_before_while_in_do_statement=do not insert org.eclipse.jdt.core.formatter.insert_new_line_in_empty_annotation_declaration=insert -org.eclipse.jdt.core.formatter.insert_new_line_in_empty_anonymous_type_declaration=do not insert +org.eclipse.jdt.core.formatter.insert_new_line_in_empty_anonymous_type_declaration=insert org.eclipse.jdt.core.formatter.insert_new_line_in_empty_block=insert org.eclipse.jdt.core.formatter.insert_new_line_in_empty_enum_constant=insert org.eclipse.jdt.core.formatter.insert_new_line_in_empty_enum_declaration=insert @@ -246,10 +259,11 @@ org.eclipse.jdt.core.formatter.insert_space_after_comma_in_superinterfaces=inser org.eclipse.jdt.core.formatter.insert_space_after_comma_in_type_arguments=insert org.eclipse.jdt.core.formatter.insert_space_after_comma_in_type_parameters=insert org.eclipse.jdt.core.formatter.insert_space_after_ellipsis=insert +org.eclipse.jdt.core.formatter.insert_space_after_lambda_arrow=insert org.eclipse.jdt.core.formatter.insert_space_after_opening_angle_bracket_in_parameterized_type_reference=do not insert org.eclipse.jdt.core.formatter.insert_space_after_opening_angle_bracket_in_type_arguments=do not insert org.eclipse.jdt.core.formatter.insert_space_after_opening_angle_bracket_in_type_parameters=do not insert -org.eclipse.jdt.core.formatter.insert_space_after_opening_brace_in_array_initializer=do not insert +org.eclipse.jdt.core.formatter.insert_space_after_opening_brace_in_array_initializer=insert org.eclipse.jdt.core.formatter.insert_space_after_opening_bracket_in_array_allocation_expression=do not insert org.eclipse.jdt.core.formatter.insert_space_after_opening_bracket_in_array_reference=do not insert org.eclipse.jdt.core.formatter.insert_space_after_opening_paren_in_annotation=do not insert @@ -264,12 +278,14 @@ org.eclipse.jdt.core.formatter.insert_space_after_opening_paren_in_method_invoca org.eclipse.jdt.core.formatter.insert_space_after_opening_paren_in_parenthesized_expression=do not insert org.eclipse.jdt.core.formatter.insert_space_after_opening_paren_in_switch=do not insert org.eclipse.jdt.core.formatter.insert_space_after_opening_paren_in_synchronized=do not insert +org.eclipse.jdt.core.formatter.insert_space_after_opening_paren_in_try=do not insert org.eclipse.jdt.core.formatter.insert_space_after_opening_paren_in_while=do not insert org.eclipse.jdt.core.formatter.insert_space_after_postfix_operator=do not insert org.eclipse.jdt.core.formatter.insert_space_after_prefix_operator=do not insert org.eclipse.jdt.core.formatter.insert_space_after_question_in_conditional=insert org.eclipse.jdt.core.formatter.insert_space_after_question_in_wildcard=do not insert org.eclipse.jdt.core.formatter.insert_space_after_semicolon_in_for=insert +org.eclipse.jdt.core.formatter.insert_space_after_semicolon_in_try_resources=insert org.eclipse.jdt.core.formatter.insert_space_after_unary_operator=do not insert org.eclipse.jdt.core.formatter.insert_space_before_and_in_type_parameter=insert org.eclipse.jdt.core.formatter.insert_space_before_assignment_operator=insert @@ -278,7 +294,7 @@ org.eclipse.jdt.core.formatter.insert_space_before_binary_operator=insert org.eclipse.jdt.core.formatter.insert_space_before_closing_angle_bracket_in_parameterized_type_reference=do not insert org.eclipse.jdt.core.formatter.insert_space_before_closing_angle_bracket_in_type_arguments=do not insert org.eclipse.jdt.core.formatter.insert_space_before_closing_angle_bracket_in_type_parameters=do not insert -org.eclipse.jdt.core.formatter.insert_space_before_closing_brace_in_array_initializer=do not insert +org.eclipse.jdt.core.formatter.insert_space_before_closing_brace_in_array_initializer=insert org.eclipse.jdt.core.formatter.insert_space_before_closing_bracket_in_array_allocation_expression=do not insert org.eclipse.jdt.core.formatter.insert_space_before_closing_bracket_in_array_reference=do not insert org.eclipse.jdt.core.formatter.insert_space_before_closing_paren_in_annotation=do not insert @@ -293,11 +309,12 @@ org.eclipse.jdt.core.formatter.insert_space_before_closing_paren_in_method_invoc org.eclipse.jdt.core.formatter.insert_space_before_closing_paren_in_parenthesized_expression=do not insert org.eclipse.jdt.core.formatter.insert_space_before_closing_paren_in_switch=do not insert org.eclipse.jdt.core.formatter.insert_space_before_closing_paren_in_synchronized=do not insert +org.eclipse.jdt.core.formatter.insert_space_before_closing_paren_in_try=do not insert org.eclipse.jdt.core.formatter.insert_space_before_closing_paren_in_while=do not insert org.eclipse.jdt.core.formatter.insert_space_before_colon_in_assert=insert -org.eclipse.jdt.core.formatter.insert_space_before_colon_in_case=insert +org.eclipse.jdt.core.formatter.insert_space_before_colon_in_case=do not insert org.eclipse.jdt.core.formatter.insert_space_before_colon_in_conditional=insert -org.eclipse.jdt.core.formatter.insert_space_before_colon_in_default=insert +org.eclipse.jdt.core.formatter.insert_space_before_colon_in_default=do not insert org.eclipse.jdt.core.formatter.insert_space_before_colon_in_for=insert org.eclipse.jdt.core.formatter.insert_space_before_colon_in_labeled_statement=do not insert org.eclipse.jdt.core.formatter.insert_space_before_comma_in_allocation_expression=do not insert @@ -320,6 +337,7 @@ org.eclipse.jdt.core.formatter.insert_space_before_comma_in_superinterfaces=do n org.eclipse.jdt.core.formatter.insert_space_before_comma_in_type_arguments=do not insert org.eclipse.jdt.core.formatter.insert_space_before_comma_in_type_parameters=do not insert org.eclipse.jdt.core.formatter.insert_space_before_ellipsis=do not insert +org.eclipse.jdt.core.formatter.insert_space_before_lambda_arrow=insert org.eclipse.jdt.core.formatter.insert_space_before_opening_angle_bracket_in_parameterized_type_reference=do not insert org.eclipse.jdt.core.formatter.insert_space_before_opening_angle_bracket_in_type_arguments=do not insert org.eclipse.jdt.core.formatter.insert_space_before_opening_angle_bracket_in_type_parameters=do not insert @@ -348,6 +366,7 @@ org.eclipse.jdt.core.formatter.insert_space_before_opening_paren_in_method_invoc org.eclipse.jdt.core.formatter.insert_space_before_opening_paren_in_parenthesized_expression=do not insert org.eclipse.jdt.core.formatter.insert_space_before_opening_paren_in_switch=insert org.eclipse.jdt.core.formatter.insert_space_before_opening_paren_in_synchronized=insert +org.eclipse.jdt.core.formatter.insert_space_before_opening_paren_in_try=insert org.eclipse.jdt.core.formatter.insert_space_before_opening_paren_in_while=insert org.eclipse.jdt.core.formatter.insert_space_before_parenthesized_expression_in_return=insert org.eclipse.jdt.core.formatter.insert_space_before_parenthesized_expression_in_throw=insert @@ -357,6 +376,7 @@ org.eclipse.jdt.core.formatter.insert_space_before_question_in_conditional=inser org.eclipse.jdt.core.formatter.insert_space_before_question_in_wildcard=do not insert org.eclipse.jdt.core.formatter.insert_space_before_semicolon=do not insert org.eclipse.jdt.core.formatter.insert_space_before_semicolon_in_for=do not insert +org.eclipse.jdt.core.formatter.insert_space_before_semicolon_in_try_resources=do not insert org.eclipse.jdt.core.formatter.insert_space_before_unary_operator=do not insert org.eclipse.jdt.core.formatter.insert_space_between_brackets_in_array_type_reference=do not insert org.eclipse.jdt.core.formatter.insert_space_between_empty_braces_in_array_initializer=do not insert @@ -366,16 +386,25 @@ org.eclipse.jdt.core.formatter.insert_space_between_empty_parens_in_constructor_ org.eclipse.jdt.core.formatter.insert_space_between_empty_parens_in_enum_constant=do not insert org.eclipse.jdt.core.formatter.insert_space_between_empty_parens_in_method_declaration=do not insert org.eclipse.jdt.core.formatter.insert_space_between_empty_parens_in_method_invocation=do not insert +org.eclipse.jdt.core.formatter.join_lines_in_comments=true +org.eclipse.jdt.core.formatter.join_wrapped_lines=true org.eclipse.jdt.core.formatter.keep_else_statement_on_same_line=false org.eclipse.jdt.core.formatter.keep_empty_array_initializer_on_one_line=false org.eclipse.jdt.core.formatter.keep_imple_if_on_one_line=false org.eclipse.jdt.core.formatter.keep_then_statement_on_same_line=false -org.eclipse.jdt.core.formatter.lineSplit=800 +org.eclipse.jdt.core.formatter.lineSplit=120 +org.eclipse.jdt.core.formatter.never_indent_block_comments_on_first_column=false +org.eclipse.jdt.core.formatter.never_indent_line_comments_on_first_column=false org.eclipse.jdt.core.formatter.number_of_blank_lines_at_beginning_of_method_body=0 org.eclipse.jdt.core.formatter.number_of_empty_lines_to_preserve=1 -org.eclipse.jdt.core.formatter.put_empty_statement_on_new_line=false +org.eclipse.jdt.core.formatter.put_empty_statement_on_new_line=true org.eclipse.jdt.core.formatter.tabulation.char=tab org.eclipse.jdt.core.formatter.tabulation.size=4 +org.eclipse.jdt.core.formatter.use_on_off_tags=false org.eclipse.jdt.core.formatter.use_tabs_only_for_leading_indentations=false +org.eclipse.jdt.core.formatter.wrap_before_binary_operator=true +org.eclipse.jdt.core.formatter.wrap_before_or_operator_multicatch=true +org.eclipse.jdt.core.formatter.wrap_outer_expressions_when_nested=true org.eclipse.jdt.core.incompatibleJDKLevel=ignore org.eclipse.jdt.core.incompleteClasspath=error +org.eclipse.jdt.core.javaFormatter=org.eclipse.jdt.core.defaultJavaFormatter diff --git a/bundles/org.eclipse.core.contenttype/.settings/org.eclipse.jdt.ui.prefs b/bundles/org.eclipse.core.contenttype/.settings/org.eclipse.jdt.ui.prefs index 288343d24..d5ddfabff 100644 --- a/bundles/org.eclipse.core.contenttype/.settings/org.eclipse.jdt.ui.prefs +++ b/bundles/org.eclipse.core.contenttype/.settings/org.eclipse.jdt.ui.prefs @@ -1,8 +1,126 @@ -#Mon Feb 26 10:42:03 EST 2007 +cleanup.add_default_serial_version_id=true +cleanup.add_generated_serial_version_id=false +cleanup.add_missing_annotations=false +cleanup.add_missing_deprecated_annotations=true +cleanup.add_missing_methods=false +cleanup.add_missing_nls_tags=false +cleanup.add_missing_override_annotations=true +cleanup.add_missing_override_annotations_interface_methods=true +cleanup.add_serial_version_id=false +cleanup.always_use_blocks=true +cleanup.always_use_parentheses_in_expressions=false +cleanup.always_use_this_for_non_static_field_access=false +cleanup.always_use_this_for_non_static_method_access=false +cleanup.convert_functional_interfaces=false +cleanup.convert_to_enhanced_for_loop=false +cleanup.correct_indentation=false +cleanup.format_source_code=false +cleanup.format_source_code_changes_only=false +cleanup.insert_inferred_type_arguments=false +cleanup.make_local_variable_final=true +cleanup.make_parameters_final=false +cleanup.make_private_fields_final=true +cleanup.make_type_abstract_if_missing_method=false +cleanup.make_variable_declarations_final=false +cleanup.never_use_blocks=false +cleanup.never_use_parentheses_in_expressions=true +cleanup.organize_imports=false +cleanup.qualify_static_field_accesses_with_declaring_class=false +cleanup.qualify_static_member_accesses_through_instances_with_declaring_class=true +cleanup.qualify_static_member_accesses_through_subtypes_with_declaring_class=true +cleanup.qualify_static_member_accesses_with_declaring_class=true +cleanup.qualify_static_method_accesses_with_declaring_class=false +cleanup.remove_private_constructors=true +cleanup.remove_redundant_type_arguments=true +cleanup.remove_trailing_whitespaces=true +cleanup.remove_trailing_whitespaces_all=true +cleanup.remove_trailing_whitespaces_ignore_empty=false +cleanup.remove_unnecessary_casts=true +cleanup.remove_unnecessary_nls_tags=true +cleanup.remove_unused_imports=false +cleanup.remove_unused_local_variables=false +cleanup.remove_unused_private_fields=true +cleanup.remove_unused_private_members=false +cleanup.remove_unused_private_methods=true +cleanup.remove_unused_private_types=true +cleanup.sort_members=false +cleanup.sort_members_all=false +cleanup.use_anonymous_class_creation=false +cleanup.use_blocks=false +cleanup.use_blocks_only_for_return_and_throw=false +cleanup.use_lambda=true +cleanup.use_parentheses_in_expressions=false +cleanup.use_this_for_non_static_field_access=false +cleanup.use_this_for_non_static_field_access_only_if_necessary=true +cleanup.use_this_for_non_static_method_access=false +cleanup.use_this_for_non_static_method_access_only_if_necessary=true +cleanup.use_type_arguments=false +cleanup_profile=_Whitespace_remove +cleanup_settings_version=2 eclipse.preferences.version=1 -formatter_profile=_core -formatter_settings_version=11 +editor_save_participant_org.eclipse.jdt.ui.postsavelistener.cleanup=true +formatter_profile=org.eclipse.jdt.ui.default.eclipse_profile +formatter_settings_version=12 org.eclipse.jdt.ui.ignorelowercasenames=true org.eclipse.jdt.ui.importorder=; +org.eclipse.jdt.ui.javadoc=false org.eclipse.jdt.ui.ondemandthreshold=3 -org.eclipse.jdt.ui.text.custom_code_templates=<?xml version\="1.0" encoding\="UTF-8"?><templates><template autoinsert\="true" context\="gettercomment_context" deleted\="false" description\="Comment for getter method" enabled\="true" id\="org.eclipse.jdt.ui.text.codetemplates.gettercomment" name\="gettercomment">/**\r\n * @return Returns the ${bare_field_name}.\r\n */</template><template autoinsert\="true" context\="settercomment_context" deleted\="false" description\="Comment for setter method" enabled\="true" id\="org.eclipse.jdt.ui.text.codetemplates.settercomment" name\="settercomment">/**\r\n * @param ${param} The ${bare_field_name} to set.\r\n */</template><template autoinsert\="true" context\="constructorcomment_context" deleted\="false" description\="Comment for created constructors" enabled\="true" id\="org.eclipse.jdt.ui.text.codetemplates.constructorcomment" name\="constructorcomment">/**\r\n * ${tags}\r\n */</template><template autoinsert\="true" context\="filecomment_context" deleted\="false" description\="Comment for created Java files" enabled\="true" id\="org.eclipse.jdt.ui.text.codetemplates.filecomment" name\="filecomment">/*******************************************************************************\r\n * Copyright (c) ${year} IBM Corporation and others.\r\n * All rights reserved. This program and the accompanying materials\r\n * are made available under the terms of the Eclipse Public License v1.0\r\n * which accompanies this distribution, and is available at\r\n * http\://www.eclipse.org/legal/epl-v10.html\r\n *\r\n * Contributors\:\r\n * IBM Corporation - initial API and implementation\r\n ******************************************************************************/\r\n</template><template autoinsert\="false" context\="typecomment_context" deleted\="false" description\="Comment for created types" enabled\="true" id\="org.eclipse.jdt.ui.text.codetemplates.typecomment" name\="typecomment">/**\r\n * @since 3.2\r\n *\r\n * ${tags}\r\n */</template><template autoinsert\="true" context\="fieldcomment_context" deleted\="false" description\="Comment for fields" enabled\="true" id\="org.eclipse.jdt.ui.text.codetemplates.fieldcomment" name\="fieldcomment">/**\r\n * \r\n */</template><template autoinsert\="true" context\="methodcomment_context" deleted\="false" description\="Comment for non-overriding methods" enabled\="true" id\="org.eclipse.jdt.ui.text.codetemplates.methodcomment" name\="methodcomment">/**\r\n * ${tags}\r\n */</template><template autoinsert\="true" context\="overridecomment_context" deleted\="false" description\="Comment for overriding methods" enabled\="true" id\="org.eclipse.jdt.ui.text.codetemplates.overridecomment" name\="overridecomment">/* (non-Javadoc)\r\n * ${see_to_overridden}\r\n */</template><template autoinsert\="false" context\="newtype_context" deleted\="false" description\="New classes and interfaces" enabled\="true" id\="org.eclipse.jdt.ui.text.codetemplates.newtype" name\="newtype">/*******************************************************************************\r\n * Copyright (c) 2006 IBM Corporation and others.\r\n * All rights reserved. This program and the accompanying materials\r\n * are made available under the terms of the Eclipse Public License v1.0\r\n * which accompanies this distribution, and is available at\r\n * http\://www.eclipse.org/legal/epl-v10.html\r\n * \r\n * Contributors\:\r\n * IBM Corporation - initial API and implementation\r\n *******************************************************************************/\r\n${package_declaration}\r\n\r\n/**\r\n * \r\n */\r\n${type_declaration}</template><template autoinsert\="true" context\="classbody_context" deleted\="false" description\="Code in new class type bodies" enabled\="true" id\="org.eclipse.jdt.ui.text.codetemplates.classbody" name\="classbody">\r\n</template><template autoinsert\="true" context\="interfacebody_context" deleted\="false" description\="Code in new interface type bodies" enabled\="true" id\="org.eclipse.jdt.ui.text.codetemplates.interfacebody" name\="interfacebody">\r\n</template><template autoinsert\="true" context\="enumbody_context" deleted\="false" description\="Code in new enum type bodies" enabled\="true" id\="org.eclipse.jdt.ui.text.codetemplates.enumbody" name\="enumbody">\r\n</template><template autoinsert\="true" context\="annotationbody_context" deleted\="false" description\="Code in new annotation type bodies" enabled\="true" id\="org.eclipse.jdt.ui.text.codetemplates.annotationbody" name\="annotationbody">\r\n</template><template autoinsert\="true" context\="catchblock_context" deleted\="false" description\="Code in new catch blocks" enabled\="true" id\="org.eclipse.jdt.ui.text.codetemplates.catchblock" name\="catchblock">fail("4.99", ${exception_var});</template><template autoinsert\="true" context\="methodbody_context" deleted\="false" description\="Code in created method stubs" enabled\="true" id\="org.eclipse.jdt.ui.text.codetemplates.methodbody" name\="methodbody">${body_statement}</template><template autoinsert\="true" context\="constructorbody_context" deleted\="false" description\="Code in created constructor stubs" enabled\="true" id\="org.eclipse.jdt.ui.text.codetemplates.constructorbody" name\="constructorbody">${body_statement}</template><template autoinsert\="true" context\="getterbody_context" deleted\="false" description\="Code in created getters" enabled\="true" id\="org.eclipse.jdt.ui.text.codetemplates.getterbody" name\="getterbody">return ${field};</template><template autoinsert\="true" context\="setterbody_context" deleted\="false" description\="Code in created setters" enabled\="true" id\="org.eclipse.jdt.ui.text.codetemplates.setterbody" name\="setterbody">${field} \= ${param};</template></templates> +org.eclipse.jdt.ui.text.custom_code_templates=<?xml version\="1.0" encoding\="UTF-8" standalone\="no"?><templates><template autoinsert\="true" context\="gettercomment_context" deleted\="false" description\="Comment for getter method" enabled\="true" id\="org.eclipse.jdt.ui.text.codetemplates.gettercomment" name\="gettercomment">/**\n * @return Returns the ${bare_field_name}.\n */</template><template autoinsert\="true" context\="settercomment_context" deleted\="false" description\="Comment for setter method" enabled\="true" id\="org.eclipse.jdt.ui.text.codetemplates.settercomment" name\="settercomment">/**\n * @param ${param} The ${bare_field_name} to set.\n */</template><template autoinsert\="true" context\="constructorcomment_context" deleted\="false" description\="Comment for created constructors" enabled\="true" id\="org.eclipse.jdt.ui.text.codetemplates.constructorcomment" name\="constructorcomment">/**\n * ${tags}\n */</template><template autoinsert\="true" context\="filecomment_context" deleted\="false" description\="Comment for created Java files" enabled\="true" id\="org.eclipse.jdt.ui.text.codetemplates.filecomment" name\="filecomment">/*******************************************************************************\n * Copyright (c) ${year} IBM Corporation and others.\n * All rights reserved. This program and the accompanying materials\n * are made available under the terms of the Eclipse Public License v1.0\n * which accompanies this distribution, and is available at\n * http\://www.eclipse.org/legal/epl-v10.html\n *\n * Contributors\:\n * IBM Corporation - initial API and implementation\n ******************************************************************************/\n</template><template autoinsert\="false" context\="typecomment_context" deleted\="false" description\="Comment for created types" enabled\="true" id\="org.eclipse.jdt.ui.text.codetemplates.typecomment" name\="typecomment">/**\n * @since 3.2\n *\n * ${tags}\n */</template><template autoinsert\="true" context\="fieldcomment_context" deleted\="false" description\="Comment for fields" enabled\="true" id\="org.eclipse.jdt.ui.text.codetemplates.fieldcomment" name\="fieldcomment">/**\n * \n */</template><template autoinsert\="true" context\="methodcomment_context" deleted\="false" description\="Comment for non-overriding methods" enabled\="true" id\="org.eclipse.jdt.ui.text.codetemplates.methodcomment" name\="methodcomment">/**\n * ${tags}\n */</template><template autoinsert\="true" context\="overridecomment_context" deleted\="false" description\="Comment for overriding methods" enabled\="true" id\="org.eclipse.jdt.ui.text.codetemplates.overridecomment" name\="overridecomment">/* (non-Javadoc)\n * ${see_to_overridden}\n */</template><template autoinsert\="false" context\="newtype_context" deleted\="false" description\="New classes and interfaces" enabled\="true" id\="org.eclipse.jdt.ui.text.codetemplates.newtype" name\="newtype">/*******************************************************************************\n * Copyright (c) 2006 IBM Corporation and others.\n * All rights reserved. This program and the accompanying materials\n * are made available under the terms of the Eclipse Public License v1.0\n * which accompanies this distribution, and is available at\n * http\://www.eclipse.org/legal/epl-v10.html\n * \n * Contributors\:\n * IBM Corporation - initial API and implementation\n *******************************************************************************/\n${package_declaration}\n\n/**\n * \n */\n${type_declaration}</template><template autoinsert\="true" context\="classbody_context" deleted\="false" description\="Code in new class type bodies" enabled\="true" id\="org.eclipse.jdt.ui.text.codetemplates.classbody" name\="classbody">\n</template><template autoinsert\="true" context\="interfacebody_context" deleted\="false" description\="Code in new interface type bodies" enabled\="true" id\="org.eclipse.jdt.ui.text.codetemplates.interfacebody" name\="interfacebody">\n</template><template autoinsert\="true" context\="enumbody_context" deleted\="false" description\="Code in new enum type bodies" enabled\="true" id\="org.eclipse.jdt.ui.text.codetemplates.enumbody" name\="enumbody">\n</template><template autoinsert\="true" context\="annotationbody_context" deleted\="false" description\="Code in new annotation type bodies" enabled\="true" id\="org.eclipse.jdt.ui.text.codetemplates.annotationbody" name\="annotationbody">\n</template><template autoinsert\="true" context\="catchblock_context" deleted\="false" description\="Code in new catch blocks" enabled\="true" id\="org.eclipse.jdt.ui.text.codetemplates.catchblock" name\="catchblock">fail("4.99", ${exception_var});</template><template autoinsert\="true" context\="methodbody_context" deleted\="false" description\="Code in created method stubs" enabled\="true" id\="org.eclipse.jdt.ui.text.codetemplates.methodbody" name\="methodbody">${body_statement}</template><template autoinsert\="true" context\="constructorbody_context" deleted\="false" description\="Code in created constructor stubs" enabled\="true" id\="org.eclipse.jdt.ui.text.codetemplates.constructorbody" name\="constructorbody">${body_statement}</template><template autoinsert\="true" context\="getterbody_context" deleted\="false" description\="Code in created getters" enabled\="true" id\="org.eclipse.jdt.ui.text.codetemplates.getterbody" name\="getterbody">return ${field};</template><template autoinsert\="true" context\="setterbody_context" deleted\="false" description\="Code in created setters" enabled\="true" id\="org.eclipse.jdt.ui.text.codetemplates.setterbody" name\="setterbody">${field} \= ${param};</template><template autoinsert\="true" context\="delegatecomment_context" deleted\="false" description\="Comment for delegate methods" enabled\="true" id\="org.eclipse.jdt.ui.text.codetemplates.delegatecomment" name\="delegatecomment">/**\n * ${tags}\n * ${see_to_target}\n */</template></templates> +sp_cleanup.add_default_serial_version_id=false +sp_cleanup.add_generated_serial_version_id=false +sp_cleanup.add_missing_annotations=false +sp_cleanup.add_missing_deprecated_annotations=true +sp_cleanup.add_missing_methods=false +sp_cleanup.add_missing_nls_tags=false +sp_cleanup.add_missing_override_annotations=true +sp_cleanup.add_missing_override_annotations_interface_methods=true +sp_cleanup.add_serial_version_id=false +sp_cleanup.always_use_blocks=false +sp_cleanup.always_use_parentheses_in_expressions=false +sp_cleanup.always_use_this_for_non_static_field_access=false +sp_cleanup.always_use_this_for_non_static_method_access=false +sp_cleanup.convert_functional_interfaces=false +sp_cleanup.convert_to_enhanced_for_loop=false +sp_cleanup.correct_indentation=false +sp_cleanup.format_source_code=true +sp_cleanup.format_source_code_changes_only=true +sp_cleanup.insert_inferred_type_arguments=false +sp_cleanup.make_local_variable_final=false +sp_cleanup.make_parameters_final=false +sp_cleanup.make_private_fields_final=false +sp_cleanup.make_type_abstract_if_missing_method=false +sp_cleanup.make_variable_declarations_final=false +sp_cleanup.never_use_blocks=false +sp_cleanup.never_use_parentheses_in_expressions=false +sp_cleanup.on_save_use_additional_actions=true +sp_cleanup.organize_imports=true +sp_cleanup.qualify_static_field_accesses_with_declaring_class=false +sp_cleanup.qualify_static_member_accesses_through_instances_with_declaring_class=false +sp_cleanup.qualify_static_member_accesses_through_subtypes_with_declaring_class=false +sp_cleanup.qualify_static_member_accesses_with_declaring_class=false +sp_cleanup.qualify_static_method_accesses_with_declaring_class=false +sp_cleanup.remove_private_constructors=false +sp_cleanup.remove_redundant_type_arguments=false +sp_cleanup.remove_trailing_whitespaces=true +sp_cleanup.remove_trailing_whitespaces_all=true +sp_cleanup.remove_trailing_whitespaces_ignore_empty=false +sp_cleanup.remove_unnecessary_casts=false +sp_cleanup.remove_unnecessary_nls_tags=false +sp_cleanup.remove_unused_imports=false +sp_cleanup.remove_unused_local_variables=false +sp_cleanup.remove_unused_private_fields=false +sp_cleanup.remove_unused_private_members=false +sp_cleanup.remove_unused_private_methods=false +sp_cleanup.remove_unused_private_types=false +sp_cleanup.sort_members=false +sp_cleanup.sort_members_all=false +sp_cleanup.use_anonymous_class_creation=false +sp_cleanup.use_blocks=false +sp_cleanup.use_blocks_only_for_return_and_throw=false +sp_cleanup.use_lambda=false +sp_cleanup.use_parentheses_in_expressions=false +sp_cleanup.use_this_for_non_static_field_access=false +sp_cleanup.use_this_for_non_static_field_access_only_if_necessary=false +sp_cleanup.use_this_for_non_static_method_access=false +sp_cleanup.use_this_for_non_static_method_access_only_if_necessary=false +sp_cleanup.use_type_arguments=false diff --git a/bundles/org.eclipse.core.contenttype/src/org/eclipse/core/internal/content/BasicDescription.java b/bundles/org.eclipse.core.contenttype/src/org/eclipse/core/internal/content/BasicDescription.java index de3aaf9c7..21b87674a 100644 --- a/bundles/org.eclipse.core.contenttype/src/org/eclipse/core/internal/content/BasicDescription.java +++ b/bundles/org.eclipse.core.contenttype/src/org/eclipse/core/internal/content/BasicDescription.java @@ -4,7 +4,7 @@ * are made available under the terms of the Eclipse Public License v1.0 * which accompanies this distribution, and is available at * http://www.eclipse.org/legal/epl-v10.html - * + * * Contributors: * IBM Corporation - initial API and implementation *******************************************************************************/ @@ -27,7 +27,7 @@ public abstract class BasicDescription implements IContentDescription { @Override public IContentType getContentType() { ContentType contentType = contentTypeInfo.getContentType(); - //TODO performance: potential creation of garbage + //TODO performance: potential creation of garbage return new ContentTypeHandler(contentType, contentType.getCatalog().getGeneration()); } diff --git a/bundles/org.eclipse.core.contenttype/src/org/eclipse/core/internal/content/ContentDescription.java b/bundles/org.eclipse.core.contenttype/src/org/eclipse/core/internal/content/ContentDescription.java index 4fc1264da..4c637c8b5 100644 --- a/bundles/org.eclipse.core.contenttype/src/org/eclipse/core/internal/content/ContentDescription.java +++ b/bundles/org.eclipse.core.contenttype/src/org/eclipse/core/internal/content/ContentDescription.java @@ -4,7 +4,7 @@ * are made available under the terms of the Eclipse Public License v1.0 * which accompanies this distribution, and is available at * http://www.eclipse.org/legal/epl-v10.html - * + * * Contributors: * IBM Corporation - initial API and implementation *******************************************************************************/ @@ -158,7 +158,7 @@ public final class ContentDescription extends BasicDescription { } if ((flags & FLAG_ALL_OPTIONS) == 0) return; - // need to resize arrays + // need to resize arrays int currentSize = tmpKeys.length; tmpKeys = new QualifiedName[currentSize + 1]; System.arraycopy(keys, 0, tmpKeys, 0, currentSize); diff --git a/bundles/org.eclipse.core.contenttype/src/org/eclipse/core/internal/content/ContentMessages.java b/bundles/org.eclipse.core.contenttype/src/org/eclipse/core/internal/content/ContentMessages.java index 19a4775f2..605f2dd1f 100644 --- a/bundles/org.eclipse.core.contenttype/src/org/eclipse/core/internal/content/ContentMessages.java +++ b/bundles/org.eclipse.core.contenttype/src/org/eclipse/core/internal/content/ContentMessages.java @@ -3,8 +3,8 @@ * 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 http://www.eclipse.org/legal/epl-v10.html - * - * Contributors: + * + * Contributors: * IBM - Initial API and implementation **********************************************************************/ package org.eclipse.core.internal.content; @@ -43,7 +43,7 @@ public class ContentMessages extends NLS { } /** - * Print a debug message to the console. + * Print a debug message to the console. * Pre-pend the message with the current date and the name of the current thread. */ public static void message(String message) { diff --git a/bundles/org.eclipse.core.contenttype/src/org/eclipse/core/internal/content/ContentType.java b/bundles/org.eclipse.core.contenttype/src/org/eclipse/core/internal/content/ContentType.java index 02dd3a88c..b48f2fd76 100644 --- a/bundles/org.eclipse.core.contenttype/src/org/eclipse/core/internal/content/ContentType.java +++ b/bundles/org.eclipse.core.contenttype/src/org/eclipse/core/internal/content/ContentType.java @@ -52,7 +52,7 @@ public final class ContentType implements IContentType, IContentTypeInfo { private static final Object NO_DESCRIBER = "NO DESCRIBER"; //$NON-NLS-1$ final static byte NOT_ASSOCIATED = 0; - public final static String PREF_DEFAULT_CHARSET = "charset"; //$NON-NLS-1$ + public final static String PREF_DEFAULT_CHARSET = "charset"; //$NON-NLS-1$ public final static String PREF_FILE_EXTENSIONS = "file-extensions"; //$NON-NLS-1$ public final static String PREF_FILE_NAMES = "file-names"; //$NON-NLS-1$ final static byte PRIORITY_HIGH = 1; @@ -137,14 +137,14 @@ public final class ContentType implements IContentType, IContentTypeInfo { */ @Override public void addFileSpec(String fileSpec, int type) throws CoreException { - Assert.isLegal(type == FILE_EXTENSION_SPEC || type == FILE_NAME_SPEC, "Unknown type: " + type); //$NON-NLS-1$ + Assert.isLegal(type == FILE_EXTENSION_SPEC || type == FILE_NAME_SPEC, "Unknown type: " + type); //$NON-NLS-1$ String[] userSet; synchronized (this) { if (!internalAddFileSpec(fileSpec, type | SPEC_USER_DEFINED)) return; userSet = getFileSpecs(type | IGNORE_PRE_DEFINED); } - // persist using preferences + // persist using preferences Preferences contentTypeNode = manager.getPreferences().node(id); String newValue = Util.toListString(userSet); // we are adding stuff, newValue must be non-null @@ -168,7 +168,7 @@ public final class ContentType implements IContentType, IContentTypeInfo { // describer seems to be buggy. just disable it (logging the reason) invalidateDescriber(re); } catch (Error e) { - // describer got some serious problem. disable it (logging the reason) and throw the error again + // describer got some serious problem. disable it (logging the reason) and throw the error again invalidateDescriber(e); throw e; } catch (LowLevelIOException llioe) { @@ -240,7 +240,7 @@ public final class ContentType implements IContentType, IContentTypeInfo { } /** - * Returns the default value for the given property in this content type, or <code>null</code>. + * Returns the default value for the given property in this content type, or <code>null</code>. */ @Override public String getDefaultProperty(QualifiedName key) { @@ -290,7 +290,7 @@ public final class ContentType implements IContentType, IContentTypeInfo { } catch (InvalidRegistryObjectException e) { /* * This should only happen if an API call is made after the registry has changed and before - * the corresponding registry change event has been broadcast. + * the corresponding registry change event has been broadcast. */ // the configuration element is stale - need to rebuild the catalog manager.invalidate(); @@ -395,7 +395,7 @@ public final class ContentType implements IContentType, IContentTypeInfo { /** * Returns whether this content type has the given file spec. - * + * * @param text the file spec string * @param typeMask FILE_NAME_SPEC or FILE_EXTENSION_SPEC * @param strict @@ -431,18 +431,18 @@ public final class ContentType implements IContentType, IContentTypeInfo { fileSpecs.add(newFileSpec); return true; } - // update file specs atomically so threads traversing the list of file specs don't have to synchronize + // update file specs atomically so threads traversing the list of file specs don't have to synchronize @SuppressWarnings("unchecked") ArrayList<FileSpec> tmpFileSpecs = (ArrayList<FileSpec>) fileSpecs.clone(); tmpFileSpecs.add(newFileSpec); catalog.associate(this, newFileSpec.getText(), newFileSpec.getType()); - // set the new file specs atomically + // set the new file specs atomically fileSpecs = tmpFileSpecs; return true; } /** - * Returns the default value for a property, recursively if necessary. + * Returns the default value for a property, recursively if necessary. */ String internalGetDefaultProperty(QualifiedName key) { // a special case for charset - users can override @@ -561,7 +561,7 @@ public final class ContentType implements IContentType, IContentTypeInfo { void processPreferences(Preferences contentTypeNode) { // user set default charset this.userCharset = contentTypeNode.get(PREF_DEFAULT_CHARSET, null); - // user set file names + // user set file names String userSetFileNames = contentTypeNode.get(PREF_FILE_NAMES, null); String[] fileNames = Util.parseItems(userSetFileNames); for (int i = 0; i < fileNames.length; i++) @@ -578,7 +578,7 @@ public final class ContentType implements IContentType, IContentTypeInfo { */ @Override public void removeFileSpec(String fileSpec, int type) throws CoreException { - Assert.isLegal(type == FILE_EXTENSION_SPEC || type == FILE_NAME_SPEC, "Unknown type: " + type); //$NON-NLS-1$ + Assert.isLegal(type == FILE_EXTENSION_SPEC || type == FILE_NAME_SPEC, "Unknown type: " + type); //$NON-NLS-1$ synchronized (this) { if (!internalRemoveFileSpec(fileSpec, type | SPEC_USER_DEFINED)) return; @@ -596,7 +596,7 @@ public final class ContentType implements IContentType, IContentTypeInfo { IStatus status = new Status(IStatus.ERROR, ContentMessages.OWNER_NAME, 0, message, bse); throw new CoreException(status); } - // notify listeners + // notify listeners manager.fireContentTypeChangeEvent(this); } diff --git a/bundles/org.eclipse.core.contenttype/src/org/eclipse/core/internal/content/ContentTypeBuilder.java b/bundles/org.eclipse.core.contenttype/src/org/eclipse/core/internal/content/ContentTypeBuilder.java index 8846ceac5..f4793fabe 100644 --- a/bundles/org.eclipse.core.contenttype/src/org/eclipse/core/internal/content/ContentTypeBuilder.java +++ b/bundles/org.eclipse.core.contenttype/src/org/eclipse/core/internal/content/ContentTypeBuilder.java @@ -23,12 +23,12 @@ import org.eclipse.osgi.util.NLS; import org.osgi.service.prefs.BackingStoreException; /** - * This class is a sidekick for ContentTypeManager that provides mechanisms for + * This class is a sidekick for ContentTypeManager that provides mechanisms for * creating content types from the extension registry (which ContentTypeManager * is oblivious to). */ public class ContentTypeBuilder { - public static final String PT_CONTENTTYPES = "contentTypes"; //$NON-NLS-1$ + public static final String PT_CONTENTTYPES = "contentTypes"; //$NON-NLS-1$ private ContentTypeCatalog catalog; private static String getUniqueId(String namespace, String baseTypeId) { @@ -142,7 +142,7 @@ public class ContentTypeBuilder { String[] fileNames = Util.parseItems(contentTypeCE.getAttributeAsIs("file-names")); //$NON-NLS-1$ String[] fileExtensions = Util.parseItems(contentTypeCE.getAttributeAsIs("file-extensions")); //$NON-NLS-1$ String baseTypeId = getUniqueId(namespace, contentTypeCE.getAttributeAsIs("base-type")); //$NON-NLS-1$ - String aliasTargetTypeId = getUniqueId(namespace, contentTypeCE.getAttributeAsIs("alias-for")); //$NON-NLS-1$ + String aliasTargetTypeId = getUniqueId(namespace, contentTypeCE.getAttributeAsIs("alias-for")); //$NON-NLS-1$ IConfigurationElement[] propertyCEs = null; Map<QualifiedName, String> defaultProperties = null; if ((propertyCEs = contentTypeCE.getChildren("property")).length > 0) { //$NON-NLS-1$ @@ -219,11 +219,11 @@ public class ContentTypeBuilder { } } - /* Adds extra file associations to existing content types. If the content + /* Adds extra file associations to existing content types. If the content * type has not been added, the file association is ignored. */ private void registerFileAssociation(IConfigurationElement fileAssociationElement) { - //TODO: need to ensure the config. element is valid + //TODO: need to ensure the config. element is valid String contentTypeId = getUniqueId(fileAssociationElement.getContributor().getName(), fileAssociationElement.getAttribute("content-type")); //$NON-NLS-1$ ContentType target = catalog.internalGetContentType(contentTypeId); if (target == null) diff --git a/bundles/org.eclipse.core.contenttype/src/org/eclipse/core/internal/content/ContentTypeHandler.java b/bundles/org.eclipse.core.contenttype/src/org/eclipse/core/internal/content/ContentTypeHandler.java index 1e1c935c2..dcf3926e7 100644 --- a/bundles/org.eclipse.core.contenttype/src/org/eclipse/core/internal/content/ContentTypeHandler.java +++ b/bundles/org.eclipse.core.contenttype/src/org/eclipse/core/internal/content/ContentTypeHandler.java @@ -4,7 +4,7 @@ * are made available under the terms of the Eclipse Public License v1.0 * which accompanies this distribution, and is available at * http://www.eclipse.org/legal/epl-v10.html - * + * * Contributors: * IBM Corporation - initial API and implementation *******************************************************************************/ @@ -18,14 +18,14 @@ import org.eclipse.core.runtime.content.*; import org.eclipse.core.runtime.preferences.IScopeContext; /** - * The only content types exposed to clients. Allows the content type registry to change + * The only content types exposed to clients. Allows the content type registry to change * underneath preserving handlers kept by clients. */ public class ContentTypeHandler implements IContentType { /** - * A dummy description object to be returned by getDescription when this - * handler's target cannot be determined. + * A dummy description object to be returned by getDescription when this + * handler's target cannot be determined. */ private class DummyContentDescription implements IContentDescription { @Override @@ -137,14 +137,14 @@ public class ContentTypeHandler implements IContentType { return null; // the content type may returned itself as the settings object (instance scope context) final IContentTypeSettings settings = target.getSettings(context); - // in that case, return this same handler; otherwise, just return the settings + // in that case, return this same handler; otherwise, just return the settings return settings == target ? this : settings; } /** - * Returns the content type this handler represents. + * Returns the content type this handler represents. * Note that this handles the case of aliasing. - * + * * Public for testing purposes only. */ public ContentType getTarget() { diff --git a/bundles/org.eclipse.core.contenttype/src/org/eclipse/core/internal/content/ContentTypeManager.java b/bundles/org.eclipse.core.contenttype/src/org/eclipse/core/internal/content/ContentTypeManager.java index 4f36b5e25..afeb32e90 100644 --- a/bundles/org.eclipse.core.contenttype/src/org/eclipse/core/internal/content/ContentTypeManager.java +++ b/bundles/org.eclipse.core.contenttype/src/org/eclipse/core/internal/content/ContentTypeManager.java @@ -4,7 +4,7 @@ * are made available under the terms of the Eclipse Public License v1.0 * which accompanies this distribution, and is available at * http://www.eclipse.org/legal/epl-v10.html - * + * * Contributors: * IBM Corporation - initial API and implementation *******************************************************************************/ @@ -26,10 +26,10 @@ public class ContentTypeManager extends ContentTypeMatcher implements IContentTy private ContentTypeCatalog catalog; private int catalogGeneration; - /** - * List of registered listeners (element type: + /** + * List of registered listeners (element type: * <code>IContentTypeChangeListener</code>). - * These listeners are to be informed when + * These listeners are to be informed when * something in a content type changes. */ protected final ListenerList contentTypeListeners = new ListenerList(); @@ -67,8 +67,8 @@ public class ContentTypeManager extends ContentTypeMatcher implements IContentTy } /** - * Obtains this platform's content type manager. - * + * Obtains this platform's content type manager. + * * @return the content type manager */ public static ContentTypeManager getInstance() { @@ -114,15 +114,15 @@ public class ContentTypeManager extends ContentTypeMatcher implements IContentTy protected synchronized ContentTypeCatalog getCatalog() { if (catalog != null) - // already has one + // already has one return catalog; - // create new catalog + // create new catalog ContentTypeCatalog newCatalog = new ContentTypeCatalog(this, catalogGeneration++); // build catalog by parsing the extension registry ContentTypeBuilder builder = createBuilder(newCatalog); try { builder.buildCatalog(); - // only remember catalog if building it was successful + // only remember catalog if building it was successful catalog = newCatalog; } catch (InvalidRegistryObjectException e) { // the registry has stale objects... just don't remember the returned (incomplete) catalog @@ -154,7 +154,7 @@ public class ContentTypeManager extends ContentTypeMatcher implements IContentTy @Override public void registryChanged(IRegistryChangeEvent event) { // no changes related to the content type registry - if (event.getExtensionDeltas(IContentConstants.RUNTIME_NAME, ContentTypeBuilder.PT_CONTENTTYPES).length == 0 && + if (event.getExtensionDeltas(IContentConstants.RUNTIME_NAME, ContentTypeBuilder.PT_CONTENTTYPES).length == 0 && event.getExtensionDeltas(IContentConstants.CONTENT_NAME, ContentTypeBuilder.PT_CONTENTTYPES).length == 0) return; invalidate(); @@ -165,7 +165,7 @@ public class ContentTypeManager extends ContentTypeMatcher implements IContentTy */ synchronized void invalidate() { if (ContentTypeManager.DEBUGGING && catalog != null) - ContentMessages.message("Registry discarded"); //$NON-NLS-1$ + ContentMessages.message("Registry discarded"); //$NON-NLS-1$ catalog = null; } diff --git a/bundles/org.eclipse.core.contenttype/src/org/eclipse/core/internal/content/ContentTypeSettings.java b/bundles/org.eclipse.core.contenttype/src/org/eclipse/core/internal/content/ContentTypeSettings.java index c8e027afe..d301dfb3a 100644 --- a/bundles/org.eclipse.core.contenttype/src/org/eclipse/core/internal/content/ContentTypeSettings.java +++ b/bundles/org.eclipse.core.contenttype/src/org/eclipse/core/internal/content/ContentTypeSettings.java @@ -4,7 +4,7 @@ * are made available under the terms of the Eclipse Public License v1.0 * which accompanies this distribution, and is available at * http://www.eclipse.org/legal/epl-v10.html - * + * * Contributors: * IBM Corporation - initial API and implementation *******************************************************************************/ @@ -33,7 +33,7 @@ public class ContentTypeSettings implements IContentTypeSettings, IContentTypeIn // don't do anything if already exists return; existingValues.add(fileSpec); - // set new preference value + // set new preference value String newValue = Util.toListString(existingValues.toArray()); ContentType.setPreference(contentTypeNode, key, newValue); try { @@ -108,7 +108,7 @@ public class ContentTypeSettings implements IContentTypeSettings, IContentTypeIn } /* - * @see IContentTypeSettings + * @see IContentTypeSettings */ @Override public void addFileSpec(String fileSpec, int type) throws CoreException { diff --git a/bundles/org.eclipse.core.contenttype/src/org/eclipse/core/internal/content/ContentTypeVisitor.java b/bundles/org.eclipse.core.contenttype/src/org/eclipse/core/internal/content/ContentTypeVisitor.java index 5b1ff5505..72e8c1c37 100644 --- a/bundles/org.eclipse.core.contenttype/src/org/eclipse/core/internal/content/ContentTypeVisitor.java +++ b/bundles/org.eclipse.core.contenttype/src/org/eclipse/core/internal/content/ContentTypeVisitor.java @@ -4,7 +4,7 @@ * are made available under the terms of the Eclipse Public License v1.0 * which accompanies this distribution, and is available at * http://www.eclipse.org/legal/epl-v10.html - * + * * Contributors: * IBM Corporation - initial API and implementation *******************************************************************************/ diff --git a/bundles/org.eclipse.core.contenttype/src/org/eclipse/core/internal/content/DefaultDescription.java b/bundles/org.eclipse.core.contenttype/src/org/eclipse/core/internal/content/DefaultDescription.java index 6cc7eb2e2..31fd6716b 100644 --- a/bundles/org.eclipse.core.contenttype/src/org/eclipse/core/internal/content/DefaultDescription.java +++ b/bundles/org.eclipse.core.contenttype/src/org/eclipse/core/internal/content/DefaultDescription.java @@ -4,7 +4,7 @@ * are made available under the terms of the Eclipse Public License v1.0 * which accompanies this distribution, and is available at * http://www.eclipse.org/legal/epl-v10.html - * + * * Contributors: * IBM Corporation - initial API and implementation *******************************************************************************/ @@ -14,7 +14,7 @@ import org.eclipse.core.runtime.QualifiedName; import org.eclipse.core.runtime.content.IContentDescription; /** - * A content description for which all properties have default values. + * A content description for which all properties have default values. */ public final class DefaultDescription extends BasicDescription { diff --git a/bundles/org.eclipse.core.contenttype/src/org/eclipse/core/internal/content/FileSpec.java b/bundles/org.eclipse.core.contenttype/src/org/eclipse/core/internal/content/FileSpec.java index b85e16c3e..1a5572c07 100644 --- a/bundles/org.eclipse.core.contenttype/src/org/eclipse/core/internal/content/FileSpec.java +++ b/bundles/org.eclipse.core.contenttype/src/org/eclipse/core/internal/content/FileSpec.java @@ -4,7 +4,7 @@ * are made available under the terms of the Eclipse Public License v1.0 * which accompanies this distribution, and is available at * http://www.eclipse.org/legal/epl-v10.html - * + * * Contributors: * IBM Corporation - initial API and implementation *******************************************************************************/ @@ -13,7 +13,7 @@ package org.eclipse.core.internal.content; import org.eclipse.core.runtime.content.IContentType; /** - * Provides a uniform representation for file specifications, such + * Provides a uniform representation for file specifications, such * as file names, file extensions and regular expressions. */ class FileSpec { diff --git a/bundles/org.eclipse.core.contenttype/src/org/eclipse/core/internal/content/IContentConstants.java b/bundles/org.eclipse.core.contenttype/src/org/eclipse/core/internal/content/IContentConstants.java index 298b1496c..b9afcf63b 100644 --- a/bundles/org.eclipse.core.contenttype/src/org/eclipse/core/internal/content/IContentConstants.java +++ b/bundles/org.eclipse.core.contenttype/src/org/eclipse/core/internal/content/IContentConstants.java @@ -4,15 +4,15 @@ * are made available under the terms of the Eclipse Public License v1.0 * which accompanies this distribution, and is available at * http://www.eclipse.org/legal/epl-v10.html - * + * * Contributors: * IBM Corporation - initial API and implementation *******************************************************************************/ package org.eclipse.core.internal.content; /** - * Container for the constants used by this plugin. - * + * Container for the constants used by this plugin. + * * @since org.eclipse.core.contenttype 3.2 */ public interface IContentConstants { diff --git a/bundles/org.eclipse.core.contenttype/src/org/eclipse/core/internal/content/IContentTypeInfo.java b/bundles/org.eclipse.core.contenttype/src/org/eclipse/core/internal/content/IContentTypeInfo.java index 9d6c7e346..3021ac613 100644 --- a/bundles/org.eclipse.core.contenttype/src/org/eclipse/core/internal/content/IContentTypeInfo.java +++ b/bundles/org.eclipse.core.contenttype/src/org/eclipse/core/internal/content/IContentTypeInfo.java @@ -4,7 +4,7 @@ * are made available under the terms of the Eclipse Public License v1.0 * which accompanies this distribution, and is available at * http://www.eclipse.org/legal/epl-v10.html - * + * * Contributors: * IBM Corporation - initial API and implementation *******************************************************************************/ @@ -17,13 +17,13 @@ import org.eclipse.core.runtime.QualifiedName; */ public abstract interface IContentTypeInfo { /** - * Returns a reference to the corresponding content type. + * Returns a reference to the corresponding content type. */ public abstract ContentType getContentType(); /** * Returns the default value for the given property, delegating to the - * ancestor type if necessary. + * ancestor type if necessary. */ public abstract String getDefaultProperty(QualifiedName key); } diff --git a/bundles/org.eclipse.core.contenttype/src/org/eclipse/core/internal/content/ILazySource.java b/bundles/org.eclipse.core.contenttype/src/org/eclipse/core/internal/content/ILazySource.java index e25c0aa16..9fd9d45a1 100644 --- a/bundles/org.eclipse.core.contenttype/src/org/eclipse/core/internal/content/ILazySource.java +++ b/bundles/org.eclipse.core.contenttype/src/org/eclipse/core/internal/content/ILazySource.java @@ -4,7 +4,7 @@ * are made available under the terms of the Eclipse Public License v1.0 * which accompanies this distribution, and is available at * http://www.eclipse.org/legal/epl-v10.html - * + * * Contributors: * IBM Corporation - initial API and implementation *******************************************************************************/ @@ -12,12 +12,12 @@ package org.eclipse.core.internal.content; /** * A common abstract view for lazy character/binary input streams. - * + * * @since 3.1 */ public interface ILazySource { /** - * @return a boolean indicating whether this stream is character or byte-based + * @return a boolean indicating whether this stream is character or byte-based */ public boolean isText(); diff --git a/bundles/org.eclipse.core.contenttype/src/org/eclipse/core/internal/content/LowLevelIOException.java b/bundles/org.eclipse.core.contenttype/src/org/eclipse/core/internal/content/LowLevelIOException.java index e2b3ba518..3cf418978 100644 --- a/bundles/org.eclipse.core.contenttype/src/org/eclipse/core/internal/content/LowLevelIOException.java +++ b/bundles/org.eclipse.core.contenttype/src/org/eclipse/core/internal/content/LowLevelIOException.java @@ -14,11 +14,11 @@ import java.io.IOException; import org.eclipse.core.runtime.Assert; /** - * A wrapper for IOExceptions, throw by LazyInputStream/Reader. + * A wrapper for IOExceptions, throw by LazyInputStream/Reader. * Its purpose is to allow one to differentiate - * between IOExceptions thrown by the base stream/reader from those + * between IOExceptions thrown by the base stream/reader from those * thrown by streams/readers built on top of LazyInputStream/Reader. - * + * * @see LazyInputStream * @see LazyReader */ @@ -32,7 +32,7 @@ import org.eclipse.core.runtime.Assert; private IOException actual; public LowLevelIOException(IOException actual) { - // ensure we don't wrap more than once + // ensure we don't wrap more than once Assert.isLegal(!(actual instanceof LowLevelIOException)); this.actual = actual; } diff --git a/bundles/org.eclipse.core.contenttype/src/org/eclipse/core/internal/content/PreferenceModifyListener.java b/bundles/org.eclipse.core.contenttype/src/org/eclipse/core/internal/content/PreferenceModifyListener.java index 91ade83e7..2bd2515e9 100644 --- a/bundles/org.eclipse.core.contenttype/src/org/eclipse/core/internal/content/PreferenceModifyListener.java +++ b/bundles/org.eclipse.core.contenttype/src/org/eclipse/core/internal/content/PreferenceModifyListener.java @@ -4,7 +4,7 @@ * are made available under the terms of the Eclipse Public License v1.0 * which accompanies this distribution, and is available at * http://www.eclipse.org/legal/epl-v10.html - * + * * Contributors: * IBM Corporation - initial API and implementation *******************************************************************************/ diff --git a/bundles/org.eclipse.core.contenttype/src/org/eclipse/core/internal/content/TextContentDescriber.java b/bundles/org.eclipse.core.contenttype/src/org/eclipse/core/internal/content/TextContentDescriber.java index 67562825c..948cbea00 100644 --- a/bundles/org.eclipse.core.contenttype/src/org/eclipse/core/internal/content/TextContentDescriber.java +++ b/bundles/org.eclipse.core.contenttype/src/org/eclipse/core/internal/content/TextContentDescriber.java @@ -16,13 +16,13 @@ import org.eclipse.core.runtime.content.IContentDescription; import org.eclipse.core.runtime.content.ITextContentDescriber; /** - * This class provides internal basis for text-based content describers. - * + * This class provides internal basis for text-based content describers. + * * <p> - * Note: do not add protected/public members to this class if you don't intend to + * Note: do not add protected/public members to this class if you don't intend to * make them public API. - * </p> - * + * </p> + * * @see org.eclipse.core.runtime.content.XMLRootElementContentDescriber2 * @since 3.0 */ @@ -36,7 +36,7 @@ public class TextContentDescriber implements ITextContentDescriber { */ @Override public int describe(Reader contents, IContentDescription description) throws IOException { - // we want to be pretty loose on detecting the text content type + // we want to be pretty loose on detecting the text content type return INDETERMINATE; } @@ -51,7 +51,7 @@ public class TextContentDescriber implements ITextContentDescriber { byte[] bom = Util.getByteOrderMark(contents); if (bom != null) description.setProperty(IContentDescription.BYTE_ORDER_MARK, bom); - // we want to be pretty loose on detecting the text content type + // we want to be pretty loose on detecting the text content type return INDETERMINATE; } diff --git a/bundles/org.eclipse.core.contenttype/src/org/eclipse/core/internal/content/Util.java b/bundles/org.eclipse.core.contenttype/src/org/eclipse/core/internal/content/Util.java index 2a58aff54..7d02fb78e 100644 --- a/bundles/org.eclipse.core.contenttype/src/org/eclipse/core/internal/content/Util.java +++ b/bundles/org.eclipse.core.contenttype/src/org/eclipse/core/internal/content/Util.java @@ -4,7 +4,7 @@ * are made available under the terms of the Eclipse Public License v1.0 * which accompanies this distribution, and is available at * http://www.eclipse.org/legal/epl-v10.html - * + * * Contributors: * IBM Corporation - initial API and implementation *******************************************************************************/ @@ -91,7 +91,7 @@ public class Util { } while (tokenizer.hasMoreTokens()); if (wasSeparator) // trailing separator - items.add(""); //$NON-NLS-1$ + items.add(""); //$NON-NLS-1$ return items; } @@ -110,9 +110,9 @@ public class Util { // ignore last comma return result.substring(0, result.length() - 1); } - + /* - * Reads bom from the stream. Note that the stream will not be repositioned + * Reads bom from the stream. Note that the stream will not be repositioned * when the method returns. */ public static byte[] getByteOrderMark(InputStream input) throws IOException { diff --git a/bundles/org.eclipse.core.contenttype/src/org/eclipse/core/internal/content/XMLContentDescriber.java b/bundles/org.eclipse.core.contenttype/src/org/eclipse/core/internal/content/XMLContentDescriber.java index 6464258af..32efe86a6 100644 --- a/bundles/org.eclipse.core.contenttype/src/org/eclipse/core/internal/content/XMLContentDescriber.java +++ b/bundles/org.eclipse.core.contenttype/src/org/eclipse/core/internal/content/XMLContentDescriber.java @@ -4,7 +4,7 @@ * are made available under the terms of the Eclipse Public License v1.0 * which accompanies this distribution, and is available at * http://www.eclipse.org/legal/epl-v10.html - * + * * Contributors: * IBM Corporation - initial API and implementation *******************************************************************************/ @@ -12,7 +12,7 @@ package org.eclipse.core.internal.content; /** * DO NOT REMOVE, used in a product. - * + * * A content describer for XML files. This class provides basis for XML-based * content describers. * <p> @@ -28,18 +28,18 @@ package org.eclipse.core.internal.content; * <li><?xml version="1.0" encoding="utf-16"?></li> * <li><?xml version="1.0" encoding="utf-16?></li> * </ul> - * + * * @noinstantiate This class is not intended to be instantiated by clients. * Clients should use it to provide their own XML-based * describers that can be referenced by the "describer" * configuration element in extensions to the * <code>org.eclipse.core.runtime.contentTypes</code> extension * point. - * + * * @see org.eclipse.core.runtime.content.IContentDescriber * @see "http://www.w3.org/TR/REC-xml *" - * - * @deprecated As of 3.5, replaced by {@link org.eclipse.core.runtime.content.XMLContentDescriber} + * + * @deprecated As of 3.5, replaced by {@link org.eclipse.core.runtime.content.XMLContentDescriber} */ public class XMLContentDescriber extends org.eclipse.core.runtime.content.XMLContentDescriber { } diff --git a/bundles/org.eclipse.core.contenttype/src/org/eclipse/core/internal/content/XMLRootHandler.java b/bundles/org.eclipse.core.contenttype/src/org/eclipse/core/internal/content/XMLRootHandler.java index ecfb24f82..457b51b59 100644 --- a/bundles/org.eclipse.core.contenttype/src/org/eclipse/core/internal/content/XMLRootHandler.java +++ b/bundles/org.eclipse.core.contenttype/src/org/eclipse/core/internal/content/XMLRootHandler.java @@ -24,14 +24,14 @@ import org.xml.sax.helpers.DefaultHandler; * using the <code>IExecutableExtension</code> mechanism. If the * <code>":-"</code> method is used, then the value is treated as the * <code>ELEMENT_TO_FIND</code>. - * + * * @since 3.0 */ public final class XMLRootHandler extends DefaultHandler implements LexicalHandler { /** * An exception indicating that the parsing should stop. This is usually * triggered when the top-level element has been found. - * + * * @since 3.0 */ private class StopParsingException extends SAXException { @@ -72,16 +72,11 @@ public final class XMLRootHandler extends DefaultHandler implements LexicalHandl * successful to the point of finding the top-level element. */ private String namespaceFound = null; - + public XMLRootHandler(boolean checkRoot) { this.checkRoot = checkRoot; } - /* - * (non-Javadoc) - * - * @see org.xml.sax.ext.LexicalHandler#comment(char[], int, int) - */ @Override public final void comment(final char[] ch, final int start, final int length) { // Not interested. @@ -89,9 +84,9 @@ public final class XMLRootHandler extends DefaultHandler implements LexicalHandl /** * Creates a new SAX parser for use within this instance. - * + * * @return The newly created parser. - * + * * @throws ParserConfigurationException * If a parser of the given configuration cannot be created. * @throws SAXException @@ -121,31 +116,16 @@ public final class XMLRootHandler extends DefaultHandler implements LexicalHandl return parser; } - /* - * (non-Javadoc) - * - * @see org.xml.sax.ext.LexicalHandler#endCDATA() - */ @Override public final void endCDATA() { // Not interested. } - /* - * (non-Javadoc) - * - * @see org.xml.sax.ext.LexicalHandler#endDTD() - */ @Override public final void endDTD() { // Not interested. } - /* - * (non-Javadoc) - * - * @see org.xml.sax.ext.LexicalHandler#endEntity(java.lang.String) - */ @Override public final void endEntity(final String name) { // Not interested. @@ -184,7 +164,7 @@ public final class XMLRootHandler extends DefaultHandler implements LexicalHandl /* * Resolve external entity definitions to an empty string. This is to speed - * up processing of files with external DTDs. Not resolving the contents + * up processing of files with external DTDs. Not resolving the contents * of the DTD is ok, as only the System ID of the DTD declaration is used. * @see org.xml.sax.helpers.DefaultHandler#resolveEntity(java.lang.String, java.lang.String) */ @@ -193,22 +173,11 @@ public final class XMLRootHandler extends DefaultHandler implements LexicalHandl return new InputSource(new StringReader("")); //$NON-NLS-1$ } - /* - * (non-Javadoc) - * - * @see org.xml.sax.ext.LexicalHandler#startCDATA() - */ @Override public final void startCDATA() { // Not interested. } - /* - * (non-Javadoc) - * - * @see org.xml.sax.ext.LexicalHandler#startDTD(java.lang.String, - * java.lang.String, java.lang.String) - */ @Override public final void startDTD(final String name, final String publicId, final String systemId) throws SAXException { dtdFound = systemId; @@ -217,12 +186,6 @@ public final class XMLRootHandler extends DefaultHandler implements LexicalHandl throw new StopParsingException(); } - /* - * (non-Javadoc) - * - * @see org.xml.sax.ContentHandler#startElement(java.lang.String, - * java.lang.String, java.lang.String, org.xml.sax.Attributes) - */ @Override public final void startElement(final String uri, final String elementName, final String qualifiedName, final Attributes attributes) throws SAXException { elementFound = elementName; @@ -230,11 +193,6 @@ public final class XMLRootHandler extends DefaultHandler implements LexicalHandl throw new StopParsingException(); } - /* - * (non-Javadoc) - * - * @see org.xml.sax.ext.LexicalHandler#startEntity(java.lang.String) - */ @Override public final void startEntity(final String name) { // Not interested. diff --git a/bundles/org.eclipse.core.contenttype/src/org/eclipse/core/runtime/content/BinarySignatureDescriber.java b/bundles/org.eclipse.core.contenttype/src/org/eclipse/core/runtime/content/BinarySignatureDescriber.java index 6dd13dcc2..eedc5e2bd 100644 --- a/bundles/org.eclipse.core.contenttype/src/org/eclipse/core/runtime/content/BinarySignatureDescriber.java +++ b/bundles/org.eclipse.core.contenttype/src/org/eclipse/core/runtime/content/BinarySignatureDescriber.java @@ -18,36 +18,36 @@ import org.eclipse.core.runtime.*; import org.eclipse.osgi.util.NLS; /** - * A content describer for binary formats that present some + * A content describer for binary formats that present some * simple signature at a known, fixed offset. * <p> * This executable extension supports three parameters: - * "signature", "offset" and "required", the first one being mandatory. + * "signature", "offset" and "required", the first one being mandatory. * If the * <code>":-"</code> method is used, then the value is treated as the * "signature". - * </p> + * </p> * <p> - * The "signature" parameter is a sequence of hex codes, one for each byte in + * The "signature" parameter is a sequence of hex codes, one for each byte in * the signature. For example, "CA FE BA BE" would be a signature for Java * class files. * </p> * <p> - * The "offset" parameter is an integer indicating the offset where the - * signature's first byte is found. + * The "offset" parameter is an integer indicating the offset where the + * signature's first byte is found. * </p> * <p> - * The "required" parameter is a boolean (default is " true") indicating whether - * the absence of a signature should deem the contents validity status as - * IContentDescriber.INVALID or IContentDescriber.INDETERMINATE. + * The "required" parameter is a boolean (default is " true") indicating whether + * the absence of a signature should deem the contents validity status as + * IContentDescriber.INVALID or IContentDescriber.INDETERMINATE. * </p> * <p> - * This class is not intended to be subclassed or instantiated by clients, + * This class is not intended to be subclassed or instantiated by clients, * only to be referenced by the "describer" configuration element in * extensions to the <code>org.eclipse.core.runtime.contentTypes</code> * extension point. * </p> - * + * * @since 3.0 */ public final class BinarySignatureDescriber implements IContentDescriber, IExecutableExtension { diff --git a/bundles/org.eclipse.core.contenttype/src/org/eclipse/core/runtime/content/IContentDescriber.java b/bundles/org.eclipse.core.contenttype/src/org/eclipse/core/runtime/content/IContentDescriber.java index 5820a1696..905f29664 100644 --- a/bundles/org.eclipse.core.contenttype/src/org/eclipse/core/runtime/content/IContentDescriber.java +++ b/bundles/org.eclipse.core.contenttype/src/org/eclipse/core/runtime/content/IContentDescriber.java @@ -15,19 +15,19 @@ import java.io.InputStream; import org.eclipse.core.runtime.QualifiedName; /** - * Content describers know how to retrieve metadata from + * Content describers know how to retrieve metadata from * contents. * <p> - * Note: It is expected that content describer implementations be declared in a package - * that is exempt from plug-in activation (using the Eclipse-AutoStart bundle - * manifest header). Since all describers are instantiated when the content type - * framework is initialized, failure in complying with this requirement causes - * premature activation, which must be avoided. Future implementations of the - * framework might refuse to instantiate describers if doing so would trigger + * Note: It is expected that content describer implementations be declared in a package + * that is exempt from plug-in activation (using the Eclipse-AutoStart bundle + * manifest header). Since all describers are instantiated when the content type + * framework is initialized, failure in complying with this requirement causes + * premature activation, which must be avoided. Future implementations of the + * framework might refuse to instantiate describers if doing so would trigger * activation of the corresponding plug-in. * </p> * <p> - * Describers for text-based content types should implement + * Describers for text-based content types should implement * <code>ITextContentDescriber</code> instead. * </p> * <p> @@ -39,42 +39,42 @@ import org.eclipse.core.runtime.QualifiedName; */ public interface IContentDescriber { /** - * Description result constant, indicating that it was not possible - * to determine whether the contents were valid for + * Description result constant, indicating that it was not possible + * to determine whether the contents were valid for * the intended content type. - * + * * @see #describe */ public final static int INDETERMINATE = 1; /** - * Description result constant, indicating the contents are invalid for + * Description result constant, indicating the contents are invalid for * the intended content type. - * + * * @see #describe */ public final static int INVALID = 0; /** - * Description result constant, indicating the contents are valid for + * Description result constant, indicating the contents are valid for * the intended content type. - * + * * @see #describe */ public final static int VALID = 2; /** - * Tries to fill a description for the given contents. Returns - * an <code>int</code> indicating whether the given stream of + * Tries to fill a description for the given contents. Returns + * an <code>int</code> indicating whether the given stream of * bytes represents a valid sample for its corresponding content type. - * If no content description is provided, this method should perform + * If no content description is provided, this method should perform * content type validation. * <p> - * The input stream must be kept open, and any IOExceptions while + * The input stream must be kept open, and any IOExceptions while * reading the stream should flow to the caller. * </p> - * + * * @param contents the contents to be examined - * @param description a description to be filled in, or <code>null</code> if - * only content type validation is to be performed + * @param description a description to be filled in, or <code>null</code> if + * only content type validation is to be performed * @return one of the following:<ul> * <li><code>VALID</code></li>, * <li><code>INVALID</code></li>, @@ -89,8 +89,8 @@ public interface IContentDescriber { public int describe(InputStream contents, IContentDescription description) throws IOException; /** - * Returns the properties supported by this describer. - * + * Returns the properties supported by this describer. + * * @return the supported properties * @see #describe */ diff --git a/bundles/org.eclipse.core.contenttype/src/org/eclipse/core/runtime/content/IContentDescription.java b/bundles/org.eclipse.core.contenttype/src/org/eclipse/core/runtime/content/IContentDescription.java index 84c9ea0c3..0632820db 100644 --- a/bundles/org.eclipse.core.contenttype/src/org/eclipse/core/runtime/content/IContentDescription.java +++ b/bundles/org.eclipse.core.contenttype/src/org/eclipse/core/runtime/content/IContentDescription.java @@ -4,7 +4,7 @@ * are made available under the terms of the Eclipse Public License v1.0 * which accompanies this distribution, and is available at * http://www.eclipse.org/legal/epl-v10.html - * + * * Contributors: * IBM Corporation - initial API and implementation *******************************************************************************/ @@ -14,10 +14,10 @@ import org.eclipse.core.internal.content.IContentConstants; import org.eclipse.core.runtime.QualifiedName; /** - * A content description object contains information about the nature of + * A content description object contains information about the nature of * arbitrary data. * <p> - * A content description object will always include the content type for the + * A content description object will always include the content type for the * examined contents, and may also include information on: * <ol> * <li>charset;</li> @@ -27,12 +27,12 @@ import org.eclipse.core.runtime.QualifiedName; * </p> * <p> * <cite>Content describers</cite> provided by plug-ins will fill in most of the - * properties in a content description object, except for the content type, - * what is done by the platform. After a content + * properties in a content description object, except for the content type, + * what is done by the platform. After a content * description is filled in by a content interpreter, it is marked as immutable - * by the platform, so calling any of the mutator methods defined in this - * interface will cause an <code>IllegalStateException</code> to be thrown. - * </p> + * by the platform, so calling any of the mutator methods defined in this + * interface will cause an <code>IllegalStateException</code> to be thrown. + * </p> * <p> * Default values for properties can be contributed by plug-ins as part of * the content type definition markup. @@ -40,9 +40,9 @@ import org.eclipse.core.runtime.QualifiedName; * <p> * This interface is not intended to be implemented by clients. * </p> - * - * @see IContentDescriber - * @since 3.0 + * + * @see IContentDescriber + * @since 3.0 */ public interface IContentDescription { /** @@ -50,59 +50,59 @@ public interface IContentDescription { */ public final static QualifiedName CHARSET = new QualifiedName(IContentConstants.RUNTIME_NAME, "charset"); //$NON-NLS-1$ /** - * Key for the "byte order mark" property. This property is only meaningful - * when describing byte streams. + * Key for the "byte order mark" property. This property is only meaningful + * when describing byte streams. */ public final static QualifiedName BYTE_ORDER_MARK = new QualifiedName(IContentConstants.RUNTIME_NAME, "bom"); //$NON-NLS-1$ /** - * Options constant meaning that all properties should be described. + * Options constant meaning that all properties should be described. */ public final static QualifiedName[] ALL = null; /** - * Constant that identifies the Byte-Order-Mark for contents encoded with - * the UTF-8 character encoding scheme. + * Constant that identifies the Byte-Order-Mark for contents encoded with + * the UTF-8 character encoding scheme. */ public final static byte[] BOM_UTF_8 = {(byte) 0xEF, (byte) 0xBB, (byte) 0xBF}; /** - * Constant that identifies the Byte-Order-Mark for contents encoded with - * the UTF-16 Big Endian character encoding scheme. + * Constant that identifies the Byte-Order-Mark for contents encoded with + * the UTF-16 Big Endian character encoding scheme. */ public final static byte[] BOM_UTF_16BE = {(byte) 0xFE, (byte) 0xFF}; /** - * Constant that identifies the Byte-Order-Mark for contents encoded with - * the UTF-16 Little Endian character encoding scheme. + * Constant that identifies the Byte-Order-Mark for contents encoded with + * the UTF-16 Little Endian character encoding scheme. */ public final static byte[] BOM_UTF_16LE = {(byte) 0xFF, (byte) 0xFE}; /** - * Returns whether the given property is requested to be described. This + * Returns whether the given property is requested to be described. This * method is intended to allow content describers to determine which * properties should be described. - * - * @param key a key for the property to be verified - * @return <code>true</code> if the property is to be described, + * + * @param key a key for the property to be verified + * @return <code>true</code> if the property is to be described, * <code>false</code> otherwise */ public boolean isRequested(QualifiedName key); /** * Returns the charset name to be used when reading the contents - * described by this object. + * described by this object. * <p> - * If a Unicode byte order mark has been found (the - * <code>BYTE_ORDER_MARK</code> property has been set), - * a corresponding charset name will be returned (e.g. "UTF-8", - * "UTF-16"). Otherwise, the value of the <code>CHARSET</code> - * property will be returned. + * If a Unicode byte order mark has been found (the + * <code>BYTE_ORDER_MARK</code> property has been set), + * a corresponding charset name will be returned (e.g. "UTF-8", + * "UTF-16"). Otherwise, the value of the <code>CHARSET</code> + * property will be returned. * </p> * @return a charset name, or <code>null</code> */ public String getCharset(); /** - * Returns the content type detected. Returns <code>null</code> if the + * Returns the content type detected. Returns <code>null</code> if the * content type could not be determined. - * + * * @return the corresponding content type, or <code>null</code> */ public IContentType getContentType(); @@ -114,26 +114,26 @@ public interface IContentDescription { * The qualifier part of the property name must be the unique identifier * of the declaring plug-in (e.g. <code>"com.example.plugin"</code>). * </p> - * + * * @param key the property key * @return the property value, or <code>null</code>, if the property is not - * found + * found */ public Object getProperty(QualifiedName key); /** - * Sets the given property to the given value. + * Sets the given property to the given value. * <p> * The qualifier part of the property name must be the unique identifier * of the declaring plug-in (e.g. <code>"com.example.plugin"</code>). * </p> * <p> - * This method should not be called by clients other than content + * This method should not be called by clients other than content * describers. An attempt to set a property from other contexts will cause - * an <code>IllegalStateException</code> to be thrown. + * an <code>IllegalStateException</code> to be thrown. * </p> - * - * @param key the qualified name of the property + * + * @param key the qualified name of the property * @param value the property value, or <code>null</code>, * if the property is to be removed * @throws IllegalStateException if called after this description has been diff --git a/bundles/org.eclipse.core.contenttype/src/org/eclipse/core/runtime/content/IContentType.java b/bundles/org.eclipse.core.contenttype/src/org/eclipse/core/runtime/content/IContentType.java index d307d557a..4fd5d2f9c 100644 --- a/bundles/org.eclipse.core.contenttype/src/org/eclipse/core/runtime/content/IContentType.java +++ b/bundles/org.eclipse.core.contenttype/src/org/eclipse/core/runtime/content/IContentType.java @@ -4,7 +4,7 @@ * are made available under the terms of the Eclipse Public License v1.0 * which accompanies this distribution, and is available at * http://www.eclipse.org/legal/epl-v10.html - * + * * Contributors: * IBM Corporation - initial API and implementation *******************************************************************************/ @@ -16,22 +16,22 @@ import org.eclipse.core.runtime.QualifiedName; import org.eclipse.core.runtime.preferences.IScopeContext; /** - * Content types represent and provide information on file types, such as + * Content types represent and provide information on file types, such as * associated file names/extensions, default charset, etc. * <p> * This interface is not intended to be implemented by clients. - * </p> - * + * </p> + * * @since 3.0 */ public interface IContentType extends IContentTypeSettings { /** - * File spec type flag constant, indicating that predefined file + * File spec type flag constant, indicating that predefined file * specifications should not be taken into account. */ public static final int IGNORE_PRE_DEFINED = 0x01; /** - * File spec type flag constant, indicating that user-defined file + * File spec type flag constant, indicating that user-defined file * specifications should not be taken into account. */ public static final int IGNORE_USER_DEFINED = 0x02; @@ -47,90 +47,90 @@ public interface IContentType extends IContentTypeSettings { /** * Returns a reference to this content type's base type. If this content type * does not have a base type (it is a root type), returns <code>null</code>. - * + * * @return this content type's base type, or <code>null</code> */ public IContentType getBaseType(); /** - * Returns the default content description for this content type. A default - * content description is returned by the content type API whenever + * Returns the default content description for this content type. A default + * content description is returned by the content type API whenever * content analysis could not find any particular information to be described - * about the contents being processed, so all default attributes for the + * about the contents being processed, so all default attributes for the * content type in question apply. * <p> - * Clients doing caching of content descriptions may choose to treat default - * descriptions in a special manner, since they are easily recoverable + * Clients doing caching of content descriptions may choose to treat default + * descriptions in a special manner, since they are easily recoverable * through this API. - * </p> - * + * </p> + * * @return a content description * @since 3.1 */ public IContentDescription getDefaultDescription(); /** - * Tries to obtain a description for the given contents. + * Tries to obtain a description for the given contents. * <p> - * Any IOExceptions that may occur while reading the given input stream - * will flow to the caller. The input stream will not be closed by this + * Any IOExceptions that may occur while reading the given input stream + * will flow to the caller. The input stream will not be closed by this * operation. * </p> - * + * * @param contents the contents to be interpreted * @param options an array of keys for all properties that should be described - * @return a content description if one could be obtained, or + * @return a content description if one could be obtained, or * <code>null</code> * @throws IOException if an error occurs while reading the contents - * @see IContentDescription + * @see IContentDescription */ public IContentDescription getDescriptionFor(InputStream contents, QualifiedName[] options) throws IOException; /** - * Tries to obtain a description for the given contents. + * Tries to obtain a description for the given contents. * <p> - * Any IOExceptions that may occur while reading the given reader - * will flow to the caller. The reader will not be closed by this + * Any IOExceptions that may occur while reading the given reader + * will flow to the caller. The reader will not be closed by this * operation. * </p> - * + * * @param contents the contents to be interpreted * @param options an array of keys for all properties that should be described - * @return a content description if one could be obtained, or + * @return a content description if one could be obtained, or * <code>null</code> * @throws UnsupportedOperationException if this content type - * has a describer that does not implement + * has a describer that does not implement * <code>ITextContentDescriber</code> - * @throws IOException if an error occurs while reading the contents + * @throws IOException if an error occurs while reading the contents * @see IContentDescription */ public IContentDescription getDescriptionFor(Reader contents, QualifiedName[] options) throws IOException; /** - * Returns the default charset for this content type if one has been defined, + * Returns the default charset for this content type if one has been defined, * <code>null</code> otherwise. * This refinement of the corresponding <code>IContentTypeSettings</code> * method also takes into account the charset defined by the content type * provider (or its base content type). - * + * * @return the default charset, or <code>null</code> */ @Override public String getDefaultCharset(); /** - * Returns file specifications from this content type. The type mask - * is a bit-wise or of file specification type constants indicating the - * file specification types of interest. + * Returns file specifications from this content type. The type mask + * is a bit-wise or of file specification type constants indicating the + * file specification types of interest. * This refinement of the corresponding <code>IContentTypeSettings</code> - * method supports additional flags because it also takes into account the - * file specifications defined by the content type provider (or its base + * method supports additional flags because it also takes into account the + * file specifications defined by the content type provider (or its base * content type). - * + * * @param type a bit-wise or of file specification type constants. Valid * flags are: *<ul> - *<li>one of <code>FILE_EXTENSION_SPEC</code> or + *<li>one of <code>FILE_EXTENSION_SPEC</code> or *<code>FILE_NAME_SPEC</code></li> *<li>and optionally, one of <code>IGNORE_PRE_DEFINED</code> *or <code>IGNORE_USER_DEFINED</code></li> @@ -145,9 +145,9 @@ public interface IContentType extends IContentTypeSettings { public String[] getFileSpecs(int type); /** - * Returns this content type's unique identifier. Each content type has an + * Returns this content type's unique identifier. Each content type has an * identifier by which they can be retrieved from the content type catalog. - * + * * @return this content type's unique identifier */ @Override @@ -155,15 +155,15 @@ public interface IContentType extends IContentTypeSettings { /** * Returns a user-friendly name for this content type. - * - * @return this content type's name + * + * @return this content type's name */ public String getName(); /** - * Returns whether this content type is associated with the + * Returns whether this content type is associated with the * given file name. - * + * * @param fileName the file name * @return <code>true</code> if this content type is associated with * the given file name, <code>false</code> otherwise @@ -172,11 +172,11 @@ public interface IContentType extends IContentTypeSettings { public boolean isAssociatedWith(String fileName); /** - * Returns whether this content type is associated with the + * Returns whether this content type is associated with the * given file name in the given preference scope. - * + * * @param fileName the file name - * @param context a preference scope context + * @param context a preference scope context * @return <code>true</code> if this content type is associated with * the given file name, <code>false</code> otherwise * @since 3.1 @@ -184,30 +184,30 @@ public interface IContentType extends IContentTypeSettings { public boolean isAssociatedWith(String fileName, IScopeContext context); /** - * Returns whether this content type is a kind of the given content + * Returns whether this content type is a kind of the given content * type. A content type A is a kind of a content type B if: * <ol> - * <li>A and B are the same content type, or</li> + * <li>A and B are the same content type, or</li> * <li>A's base type is B, or</li> * <li>A's base type is a kind of B.</li> * </ol> - * - * @param another a content type + * + * @param another a content type * @return <code>true</code> if this content type is a kind of the * given content type, <code>false</code> otherwise */ public boolean isKindOf(IContentType another); /** - * Returns the settings for this content type in the given + * Returns the settings for this content type in the given * preference context. - * - * @param context a preference scope context + * + * @param context a preference scope context * @return setting in the given context * @throws CoreException if this method fails. Reasons include: * <ul> * <li> An error occurred obtaining the settings.</li> - * </ul> + * </ul> * @since 3.1 */ public IContentTypeSettings getSettings(IScopeContext context) throws CoreException; diff --git a/bundles/org.eclipse.core.contenttype/src/org/eclipse/core/runtime/content/IContentTypeManager.java b/bundles/org.eclipse.core.contenttype/src/org/eclipse/core/runtime/content/IContentTypeManager.java index c78352d8c..1c9fb05f4 100644 --- a/bundles/org.eclipse.core.contenttype/src/org/eclipse/core/runtime/content/IContentTypeManager.java +++ b/bundles/org.eclipse.core.contenttype/src/org/eclipse/core/runtime/content/IContentTypeManager.java @@ -4,7 +4,7 @@ * are made available under the terms of the Eclipse Public License v1.0 * which accompanies this distribution, and is available at * http://www.eclipse.org/legal/epl-v10.html - * + * * Contributors: * IBM Corporation - initial API and implementation *******************************************************************************/ @@ -19,17 +19,17 @@ import org.eclipse.core.runtime.preferences.IScopeContext; * <p> * This interface is not intended to be implemented by clients. * </p> - * + * * @see org.eclipse.core.runtime.content.IContentTypeMatcher * @since 3.0 */ public interface IContentTypeManager extends IContentTypeMatcher { /** - * An event object which describes the details of a change to a - * content type. + * An event object which describes the details of a change to a + * content type. * <p> - * Types of changes include a change in the file associations or + * Types of changes include a change in the file associations or * a change in the encoding setting. * </p> */ @@ -40,14 +40,14 @@ public interface IContentTypeManager extends IContentTypeMatcher { private static final long serialVersionUID = 1L; /* * The context for the setting that changed. - * + * * @since 3.1 */ private IScopeContext context; /** * Constructor for a new content type change event. - * + * * @param source the content type that changed */ public ContentTypeChangeEvent(IContentType source) { @@ -56,7 +56,7 @@ public interface IContentTypeManager extends IContentTypeMatcher { /** * Constructor for a new content type change event. - * + * * @param source the content type that changed * @param context the context where a setting changed, or <code>null</code> * @since 3.1 @@ -68,7 +68,7 @@ public interface IContentTypeManager extends IContentTypeMatcher { /** * Return the content type object associated with this change event. - * + * * @return the content type */ public IContentType getContentType() { @@ -76,10 +76,10 @@ public interface IContentTypeManager extends IContentTypeMatcher { } /** - * Return the preference scope where the setting changed, or - * <code>null</code>, if the change happened in the content type manager - * default context. - * + * Return the preference scope where the setting changed, or + * <code>null</code>, if the change happened in the content type manager + * default context. + * * @return the context where the change happened, or <code>null</code> * @since 3.1 */ @@ -93,9 +93,9 @@ public interface IContentTypeManager extends IContentTypeMatcher { * <p> * Clients who reference the <code>org.eclipse.core.resources</code> * bundle are encouraged <em>not</em> to use this listener mechanism to - * detect encoding changes. The Core Resources bundle will + * detect encoding changes. The Core Resources bundle will * detect changes to content types and notify clients appropriately - * of potential changes to the encoding of files in the workspace + * of potential changes to the encoding of files in the workspace * via the resource change mechanism. * </p> * <p> @@ -108,7 +108,7 @@ public interface IContentTypeManager extends IContentTypeMatcher { * Notification that a content type has changed in the content type manager. * The given event object contains the content type which changed and must not * be <code>null</code>. - * + * * @param event the content type change event */ public void contentTypeChanged(ContentTypeChangeEvent event); @@ -120,7 +120,7 @@ public interface IContentTypeManager extends IContentTypeMatcher { * <p> * Clients may implement this interface. * </p> - * + * * @see IContentTypeManager#getMatcher(IContentTypeManager.ISelectionPolicy, IScopeContext) * @since 3.1 */ @@ -128,18 +128,18 @@ public interface IContentTypeManager extends IContentTypeMatcher { /** * Returns a subset of the given content types sorted by using a custom criterion. * <p> - * The given array of content types has already been sorted using - * the platform rules. If this object follows the same rules, further sorting - * is not necessary. + * The given array of content types has already been sorted using + * the platform rules. If this object follows the same rules, further sorting + * is not necessary. * </p> * <p> * The type of matching being performed (name, contents or name + contents) - * might affect the outcome for this method. For instance, for file name-only - * matching, the more general type could have higher priority. For content-based + * might affect the outcome for this method. For instance, for file name-only + * matching, the more general type could have higher priority. For content-based * matching, the more specific content type could be preferred instead. * </p> - * - * @param candidates an array containing content types matching some query + * + * @param candidates an array containing content types matching some query * @param fileName whether it is a file name-based content type matching * @param content whether its a content-based content type matching * @return an array of content types @@ -148,26 +148,26 @@ public interface IContentTypeManager extends IContentTypeMatcher { } /** - * Content type identifier constant for platform's primary - * text-based content type: <code>org.eclipse.core.runtime.text</code>. + * Content type identifier constant for platform's primary + * text-based content type: <code>org.eclipse.core.runtime.text</code>. * <p> - * All text-based content types ought to be sub types of the content type - * identified by this string. This provides a simple way for detecting + * All text-based content types ought to be sub types of the content type + * identified by this string. This provides a simple way for detecting * whether a content type is text-based: * <pre> * IContentType text = Platform.getContentTypeManager().getContentType(IContentTypeManager.CT_TEXT); * IContentType someType = ...; * boolean isTextBased = someType.isKindOf(text); - * </pre> + * </pre> * </p> */ - public final static String CT_TEXT = "org.eclipse.core.runtime.text"; //$NON-NLS-1$ + public final static String CT_TEXT = "org.eclipse.core.runtime.text"; //$NON-NLS-1$ /** * Register the given listener for notification of content type changes. * Calling this method multiple times with the same listener has no effect. The * given listener argument must not be <code>null</code>. - * + * * @param listener the content type change listener to register * @see #removeContentTypeChangeListener(IContentTypeManager.IContentTypeChangeListener) * @see IContentTypeManager.IContentTypeChangeListener @@ -175,11 +175,11 @@ public interface IContentTypeManager extends IContentTypeMatcher { public void addContentTypeChangeListener(IContentTypeChangeListener listener); /** - * Returns all content types known by the platform. + * Returns all content types known by the platform. * <p> * Returns an empty array if there are no content types available. * </p> - * + * * @return all content types known by the platform. */ public IContentType[] getAllContentTypes(); @@ -187,7 +187,7 @@ public interface IContentTypeManager extends IContentTypeMatcher { /** * Returns the content type with the given identifier, or <code>null</code> * if no such content type is known by the platform. - * + * * @param contentTypeIdentifier the identifier for the content type * @return the content type, or <code>null</code> */ @@ -195,21 +195,21 @@ public interface IContentTypeManager extends IContentTypeMatcher { /** * Returns a newly created content type matcher using the given content type selection policy - * and preference scope. If the preference scope is <code>null</code>, the default scope + * and preference scope. If the preference scope is <code>null</code>, the default scope * is used. - * + * * @param customPolicy a selection policy * @param context a user preference context to be used by the matcher, or <code>null</code> * @return a content type matcher that uses the given policy - * @since 3.1 + * @since 3.1 */ public IContentTypeMatcher getMatcher(ISelectionPolicy customPolicy, IScopeContext context); /** - * De-register the given listener from receiving notification of content type changes. + * De-register the given listener from receiving notification of content type changes. * Calling this method multiple times with the same listener has no * effect. The given listener argument must not be <code>null</code>. - * + * * @param listener the content type change listener to remove * @see #addContentTypeChangeListener(IContentTypeManager.IContentTypeChangeListener) * @see IContentTypeManager.IContentTypeChangeListener diff --git a/bundles/org.eclipse.core.contenttype/src/org/eclipse/core/runtime/content/IContentTypeMatcher.java b/bundles/org.eclipse.core.contenttype/src/org/eclipse/core/runtime/content/IContentTypeMatcher.java index eda3ede44..41d6d8a4f 100644 --- a/bundles/org.eclipse.core.contenttype/src/org/eclipse/core/runtime/content/IContentTypeMatcher.java +++ b/bundles/org.eclipse.core.contenttype/src/org/eclipse/core/runtime/content/IContentTypeMatcher.java @@ -15,11 +15,11 @@ import org.eclipse.core.runtime.QualifiedName; import org.eclipse.core.runtime.preferences.IScopeContext; /** - * An object that performs content type matching queries. + * An object that performs content type matching queries. * <p> * This interface is not intended to be implemented by clients. * </p> - * + * * @see IContentTypeManager#getMatcher(IContentTypeManager.ISelectionPolicy, IScopeContext) * @since 3.1 */ @@ -27,32 +27,32 @@ public interface IContentTypeMatcher { /** * Returns the preferred content type for the given contents and file name. * <p> - * Returns <code>null</code> if no associated content types are + * Returns <code>null</code> if no associated content types are * found. * </p> * <p> - * If a file name is not provided, the entire content type registry will be - * queried. For performance reasons, it is highly recommended + * If a file name is not provided, the entire content type registry will be + * queried. For performance reasons, it is highly recommended * to provide a file name if available. - * </p> + * </p> * <p> - * Any IOExceptions that may occur while reading the given input stream - * will flow to the caller. The input stream will not be closed by this + * Any IOExceptions that may occur while reading the given input stream + * will flow to the caller. The input stream will not be closed by this * operation. - * </p> - * + * </p> + * * @param contents an input stream - * @param fileName the file name associated to the contents, or <code>null</code> + * @param fileName the file name associated to the contents, or <code>null</code> * @return the preferred content type associated to the given file name, or <code>null</code> - * @throws IOException if an error occurs while reading the contents + * @throws IOException if an error occurs while reading the contents */ public IContentType findContentTypeFor(InputStream contents, String fileName) throws IOException; /** - * Returns the preferred content type for the given file name. If multiple content types + * Returns the preferred content type for the given file name. If multiple content types * are associated with the given file name, the one considered the most appropriated will * be returned. If there are no content types associated, <code>null</code> is returned. - * + * * @param fileName the name of the file * @return the preferred content type associated to the given file name, or <code>null</code> */ @@ -64,18 +64,18 @@ public interface IContentTypeMatcher { * Returns an empty array if no associated content types are found. * </p> * <p> - * If a file name is not provided, the entire content type registry will be - * queried. For performance reasons, it is highly recommended + * If a file name is not provided, the entire content type registry will be + * queried. For performance reasons, it is highly recommended * to provide a file name if available. * </p> * <p> - * Any IOExceptions that may occur while reading the given input stream - * will flow to the caller. The input stream will not be closed by this + * Any IOExceptions that may occur while reading the given input stream + * will flow to the caller. The input stream will not be closed by this * operation. - * </p> - * + * </p> + * * @param contents an input stream - * @param fileName the file name associated to the contents, or <code>null</code> + * @param fileName the file name associated to the contents, or <code>null</code> * @return all content types associated to the given contents and file name * @throws IOException if an error occurs while reading the contents */ @@ -83,58 +83,58 @@ public interface IContentTypeMatcher { /** * Returns all content types known by the platform that are associated to the given file name. - * <p> + * <p> * Returns an empty array if there are no content types associated. * </p> - * + * * @param fileName the name of the file * @return all content types associated to the given file spec */ public IContentType[] findContentTypesFor(String fileName); /** - * Tries to obtain a description for the given contents and file name. + * Tries to obtain a description for the given contents and file name. * <p> - * Any IOExceptions that may occur while reading the given input stream - * will flow to the caller. The input stream will not be closed by this + * Any IOExceptions that may occur while reading the given input stream + * will flow to the caller. The input stream will not be closed by this * operation. * </p> * <p> - * If a file name is not provided, the entire content type registry will be - * queried. For performance reasons, it is highly recommended + * If a file name is not provided, the entire content type registry will be + * queried. For performance reasons, it is highly recommended * to provide a file name if available. - * </p> - * + * </p> + * * @param contents the contents to be interpreted * @param fileName the file name associated to the contents, or <code>null</code> - * @param options an array of keys for all properties that should be - * described, or <code>IContentDescription.ALL</code>, for all of them + * @param options an array of keys for all properties that should be + * described, or <code>IContentDescription.ALL</code>, for all of them * @return a content description if one could be obtained, or <code>null</code> * @throws IOException if an error occurs while reading the contents - * @see IContentDescription + * @see IContentDescription */ public IContentDescription getDescriptionFor(InputStream contents, String fileName, QualifiedName[] options) throws IOException; /** - * Tries to obtain a description for the given contents and file name. + * Tries to obtain a description for the given contents and file name. * <p> - * Any IOExceptions that may occur while reading the given input stream - * will flow to the caller. The reader will not be closed by this + * Any IOExceptions that may occur while reading the given input stream + * will flow to the caller. The reader will not be closed by this * operation. * </p> * <p> - * If a file name is not provided, the entire content type registry will be - * queried. For performance reasons, it is highly recommended + * If a file name is not provided, the entire content type registry will be + * queried. For performance reasons, it is highly recommended * to provide a file name if available. - * </p> - * + * </p> + * * @param contents the contents to be interpreted * @param fileName the file name associated to the contents, or <code>null</code> - * @param options an array of keys for all properties that should be - * described, or <code>IContentDescription.ALL</code>, for all of them + * @param options an array of keys for all properties that should be + * described, or <code>IContentDescription.ALL</code>, for all of them * @return a content description if one could be obtained, or <code>null</code> * @throws IOException if an error occurs while reading the contents - * @see IContentDescription + * @see IContentDescription */ public IContentDescription getDescriptionFor(Reader contents, String fileName, QualifiedName[] options) throws IOException; }
\ No newline at end of file diff --git a/bundles/org.eclipse.core.contenttype/src/org/eclipse/core/runtime/content/IContentTypeSettings.java b/bundles/org.eclipse.core.contenttype/src/org/eclipse/core/runtime/content/IContentTypeSettings.java index c2d6502d3..17f9035d3 100644 --- a/bundles/org.eclipse.core.contenttype/src/org/eclipse/core/runtime/content/IContentTypeSettings.java +++ b/bundles/org.eclipse.core.contenttype/src/org/eclipse/core/runtime/content/IContentTypeSettings.java @@ -4,7 +4,7 @@ * are made available under the terms of the Eclipse Public License v1.0 * which accompanies this distribution, and is available at * http://www.eclipse.org/legal/epl-v10.html - * + * * Contributors: * IBM Corporation - initial API and implementation *******************************************************************************/ @@ -18,7 +18,7 @@ import org.eclipse.core.runtime.preferences.IScopeContext; * <p> * This interface is not intended to be implemented by clients. * </p> - * + * * @see IContentType * @see IContentType#getSettings(IScopeContext) * @since 3.1 @@ -34,40 +34,40 @@ public interface IContentTypeSettings { public static final int FILE_NAME_SPEC = 0x04; /** - * Adds a user-defined file specification to the corresponding content type. Has no + * Adds a user-defined file specification to the corresponding content type. Has no * effect if the given file specification is already defined. - * + * * @param fileSpec the file specification - * @param type the type of the file specification. One of - * <code>FILE_NAME_SPEC</code>, + * @param type the type of the file specification. One of + * <code>FILE_NAME_SPEC</code>, * <code>FILE_EXTENSION_SPEC</code>. - * @throws IllegalArgumentException if the type bit mask is + * @throws IllegalArgumentException if the type bit mask is * incorrect * @throws CoreException if this method fails. Reasons include: * <ul> * <li> An error occurred persisting this setting.</li> * </ul> * @see #FILE_NAME_SPEC - * @see #FILE_EXTENSION_SPEC + * @see #FILE_EXTENSION_SPEC */ public void addFileSpec(String fileSpec, int type) throws CoreException; /** - * Returns the default charset for the corresponding content type if - * it has been set, or + * Returns the default charset for the corresponding content type if + * it has been set, or * <code>null</code> otherwise. - * + * * @return the default charset, or <code>null</code> */ public String getDefaultCharset(); /** - * Returns the file specifications for the corresponding content type. The type mask - * is a bit-wise or of file specification type constants indicating the + * Returns the file specifications for the corresponding content type. The type mask + * is a bit-wise or of file specification type constants indicating the * file specification types of interest. - * + * * @param type a bit-wise or of file specification type constants. Valid - * flags are one of <code>FILE_EXTENSION_SPEC</code> or + * flags are one of <code>FILE_EXTENSION_SPEC</code> or *<code>FILE_NAME_SPEC</code> * @return the file specification * @see #FILE_NAME_SPEC @@ -76,23 +76,23 @@ public interface IContentTypeSettings { public String[] getFileSpecs(int type); /** - * Returns the corresponding content type's unique identifier. Each content - * type has an identifier by which they can be retrieved from the content + * Returns the corresponding content type's unique identifier. Each content + * type has an identifier by which they can be retrieved from the content * type catalog. - * + * * @return the content type unique identifier */ public String getId(); /** - * Removes a user-defined file specification from the corresponding content type. Has no + * Removes a user-defined file specification from the corresponding content type. Has no * effect if the given file specification was not defined by the user. - * + * * @param fileSpec the file specification - * @param type the type of the file specification. One of - * <code>FILE_NAME_SPEC</code>, + * @param type the type of the file specification. One of + * <code>FILE_NAME_SPEC</code>, * <code>FILE_EXTENSION_SPEC</code>. - * @throws IllegalArgumentException if the type bit mask is + * @throws IllegalArgumentException if the type bit mask is * incorrect * @throws CoreException if this method fails. Reasons include: * <ul> @@ -104,11 +104,11 @@ public interface IContentTypeSettings { public void removeFileSpec(String fileSpec, int type) throws CoreException; /** - * Sets the default charset for the corresponding content type. If - * <code>null</code> is provided, restores the pre-defined default charset. - * + * Sets the default charset for the corresponding content type. If + * <code>null</code> is provided, restores the pre-defined default charset. + * * @param userCharset the new charset for the content type, or - * <code>null</code> + * <code>null</code> * @throws CoreException if this method fails. Reasons include: * <ul> * <li> An error occurred persisting this setting.</li> diff --git a/bundles/org.eclipse.core.contenttype/src/org/eclipse/core/runtime/content/ITextContentDescriber.java b/bundles/org.eclipse.core.contenttype/src/org/eclipse/core/runtime/content/ITextContentDescriber.java index b80f29522..bd248a5eb 100644 --- a/bundles/org.eclipse.core.contenttype/src/org/eclipse/core/runtime/content/ITextContentDescriber.java +++ b/bundles/org.eclipse.core.contenttype/src/org/eclipse/core/runtime/content/ITextContentDescriber.java @@ -15,40 +15,40 @@ import java.io.Reader; /** * Text content describers extend basic content describers to provide - * the ability of scanning character streams (readers). Describers for - * text-based content types must implement this interface + * the ability of scanning character streams (readers). Describers for + * text-based content types must implement this interface * instead of <code>IContentDescription</code>. * <p> - * Note: It is expected that content describer implementations be declared in a package - * that is exempt from plug-in activation (using the Eclipse-AutoStart bundle - * manifest header). Since all describers are instantiated when the content type - * framework is initialized, failure in complying with this requirement causes - * premature activation, which must be avoided. Future implementations of the - * framework might refuse to instantiate describers if doing so would trigger + * Note: It is expected that content describer implementations be declared in a package + * that is exempt from plug-in activation (using the Eclipse-AutoStart bundle + * manifest header). Since all describers are instantiated when the content type + * framework is initialized, failure in complying with this requirement causes + * premature activation, which must be avoided. Future implementations of the + * framework might refuse to instantiate describers if doing so would trigger * activation of the corresponding plug-in. * </p> * <p> * Clients may implement this interface. * </p> - * + * * @see IContentDescription * @since 3.0 */ public interface ITextContentDescriber extends IContentDescriber { /** - * Tries to fill a description for the given contents. Returns - * an <code>int</code> indicating whether the given stream of - * characters represents a valid sample for this describer's corresponding - * content type. If no content description is provided, this method should + * Tries to fill a description for the given contents. Returns + * an <code>int</code> indicating whether the given stream of + * characters represents a valid sample for this describer's corresponding + * content type. If no content description is provided, this method should * only perform content type validation. * <p> - * The stream provided must be kept open, and any IOExceptions while + * The stream provided must be kept open, and any IOExceptions while * reading it should flow to the caller. * </p> - * + * * @param contents the contents to be examined - * @param description a description to be filled in, or <code>null</code> if - * only content type validation is to be performed + * @param description a description to be filled in, or <code>null</code> if + * only content type validation is to be performed * @return one of the following:<ul> * <li><code>VALID</code></li> * <li><code>INVALID</code></li> diff --git a/bundles/org.eclipse.core.contenttype/src/org/eclipse/core/runtime/content/XMLContentDescriber.java b/bundles/org.eclipse.core.contenttype/src/org/eclipse/core/runtime/content/XMLContentDescriber.java index 97afe97ce..6f0fa8a04 100644 --- a/bundles/org.eclipse.core.contenttype/src/org/eclipse/core/runtime/content/XMLContentDescriber.java +++ b/bundles/org.eclipse.core.contenttype/src/org/eclipse/core/runtime/content/XMLContentDescriber.java @@ -4,7 +4,7 @@ * are made available under the terms of the Eclipse Public License v1.0 * which accompanies this distribution, and is available at * http://www.eclipse.org/legal/epl-v10.html - * + * * Contributors: * IBM Corporation - initial API and implementation *******************************************************************************/ @@ -33,7 +33,7 @@ import org.eclipse.core.runtime.QualifiedName; * <li><?xml version="1.0" encoding="utf-16"?></li> * <li><?xml version="1.0" encoding="utf-16?></li> * </ul> - * + * * @noinstantiate This class is not intended to be instantiated by clients. * Clients should use it to provide their own XML-based * describers that can be referenced by the "describer" diff --git a/bundles/org.eclipse.core.contenttype/src/org/eclipse/core/runtime/content/XMLRootElementContentDescriber.java b/bundles/org.eclipse.core.contenttype/src/org/eclipse/core/runtime/content/XMLRootElementContentDescriber.java index 979dbdf5f..17006e3de 100644 --- a/bundles/org.eclipse.core.contenttype/src/org/eclipse/core/runtime/content/XMLRootElementContentDescriber.java +++ b/bundles/org.eclipse.core.contenttype/src/org/eclipse/core/runtime/content/XMLRootElementContentDescriber.java @@ -22,18 +22,18 @@ import org.xml.sax.InputSource; * DTD system identifier in an XML file. * <p> * This executable extension supports two parameters: - * "dtd" and "element". + * "dtd" and "element". * At least one of them <strong>must</strong> be provided. If the * <code>":-"</code> method is used, then the value is treated as * "element". - * </p> + * </p> * <p> - * This class is not intended to be subclassed or instantiated by clients, + * This class is not intended to be subclassed or instantiated by clients, * only to be referenced by the "describer" configuration element in * extensions to the <code>org.eclipse.core.runtime.contentTypes</code> * extension point. * </p> - * + * * @since 3.0 * @deprecated Use {@link XMLRootElementContentDescriber2} instead * @noinstantiate This class is not intended to be instantiated by clients. @@ -58,7 +58,7 @@ public final class XMLRootElementContentDescriber extends XMLContentDescriber im /* (Intentionally not included in javadoc) * Determines the validation status for the given contents. - * + * * @param contents the contents to be evaluated * @return one of the following:<ul> * <li><code>VALID</code></li>, @@ -82,7 +82,7 @@ public final class XMLRootElementContentDescriber extends XMLContentDescriber im return INDETERMINATE; if ((elementToFind != null) && (!elementToFind.equals(properties.get(XMLRootElementContentDescriber2.ELEMENT)))) return INDETERMINATE; - // We must be okay then. + // We must be okay then. return VALID; } @@ -101,9 +101,9 @@ public final class XMLRootElementContentDescriber extends XMLContentDescriber im // call the basic XML describer to do basic recognition if (super.describe2(contents, description, properties) == INVALID) return INVALID; - // super.describe will have consumed some chars, need to rewind + // super.describe will have consumed some chars, need to rewind contents.reset(); - // Check to see if we matched our criteria. + // Check to see if we matched our criteria. return checkCriteria(new InputSource(contents), properties); } diff --git a/bundles/org.eclipse.core.contenttype/src/org/eclipse/core/runtime/content/XMLRootElementContentDescriber2.java b/bundles/org.eclipse.core.contenttype/src/org/eclipse/core/runtime/content/XMLRootElementContentDescriber2.java index ff9855c43..551ac3c0f 100644 --- a/bundles/org.eclipse.core.contenttype/src/org/eclipse/core/runtime/content/XMLRootElementContentDescriber2.java +++ b/bundles/org.eclipse.core.contenttype/src/org/eclipse/core/runtime/content/XMLRootElementContentDescriber2.java @@ -23,17 +23,17 @@ import org.xml.sax.InputSource; import org.xml.sax.SAXException; /** - * A content describer for detecting the name of the top-level element, + * A content describer for detecting the name of the top-level element, * its namespace and the DTD system identifier in an XML file. * <p> - * This executable extension supports "element" parameter, that + * This executable extension supports "element" parameter, that * can be specified more than once. If the * <code>":-"</code> method is used, then the value is treated as * "element" (always just one) * </p> * <p> * The value of "element" is specified using such a format - * <code>{namespace}name/dtd</code>. The namespace or dtd part + * <code>{namespace}name/dtd</code>. The namespace or dtd part * can be omitted and accepted are values like <code>name/dtd</code>, * <code>{ns}name</code> and <code>name</code>. * </p> @@ -43,25 +43,25 @@ import org.xml.sax.SAXException; * match those in the document. * </p> * <p> - * If the "element" name part is "*", e.g. <code>{namespace}*</code>, - * it denotes a wildcard match. If the "element" namespace part is empty, - * e.g. <code>{}name</code>, only these documents with the root element - * that belong to the unnamed namespace <code><elem xmlns=""></code> + * If the "element" name part is "*", e.g. <code>{namespace}*</code>, + * it denotes a wildcard match. If the "element" namespace part is empty, + * e.g. <code>{}name</code>, only these documents with the root element + * that belong to the unnamed namespace <code><elem xmlns=""></code> * will be detected. * </p> * <p> * This class should be used instead of {@link XMLRootElementContentDescriber} - * which doesn't detect namespaces and doesn't allow to specify - * more than one set of dtds, root element names and namespaces which + * which doesn't detect namespaces and doesn't allow to specify + * more than one set of dtds, root element names and namespaces which * should be detected. * </p> * <p> - * This class is not intended to be subclassed or instantiated by clients, + * This class is not intended to be subclassed or instantiated by clients, * only to be referenced by the "describer" configuration element in * extensions to the <code>org.eclipse.core.runtime.contentTypes</code> * extension point. * </p> - * + * * @since org.eclipse.core.contenttype 3.3 * @noinstantiate This class is not intended to be instantiated by clients. */ @@ -78,7 +78,7 @@ public final class XMLRootElementContentDescriber2 extends XMLContentDescriber i * The top-level elements we are looking for. This value will be initialized * by the <code>setInitializationData</code> method. If no value is * provided, then this means that we don't care what the top-level element - * will be. The list is a collection of <code>QualifiedElement</code>. + * will be. The list is a collection of <code>QualifiedElement</code>. */ private QualifiedElement[] elementsToFind = null; @@ -118,7 +118,7 @@ public final class XMLRootElementContentDescriber2 extends XMLContentDescriber i /* (Intentionally not included in javadoc) * Determines the validation status for the given contents. - * + * * @param contents the contents to be evaluated * @return one of the following:<ul> * <li><code>VALID</code></li>, @@ -149,7 +149,7 @@ public final class XMLRootElementContentDescriber2 extends XMLContentDescriber i if (!foundOne) return INDETERMINATE; } - // We must be okay then. + // We must be okay then. return VALID; } @@ -168,9 +168,9 @@ public final class XMLRootElementContentDescriber2 extends XMLContentDescriber i // call the basic XML describer to do basic recognition if (super.describe2(contents, description, properties) == INVALID) return INVALID; - // super.describe will have consumed some chars, need to rewind + // super.describe will have consumed some chars, need to rewind contents.reset(); - // Check to see if we matched our criteria. + // Check to see if we matched our criteria. return checkCriteria(new InputSource(contents), properties); } @@ -242,7 +242,7 @@ public final class XMLRootElementContentDescriber2 extends XMLContentDescriber i else if (data instanceof Hashtable) { List<QualifiedElement> elements = null; - // the describer parameters have to be read again, because "element" parameter can be specified multiple times + // the describer parameters have to be read again, because "element" parameter can be specified multiple times // and the given hashtable carries only one of them IConfigurationElement describerElement = config.getChildren("describer")[0]; //$NON-NLS-1$ IConfigurationElement[] params = describerElement.getChildren("parameter"); //$NON-NLS-1$ |