| /******************************************************************************* |
| * Copyright (c) 2000, 2019 IBM Corporation and others. |
| * |
| * This program and the accompanying materials |
| * are made available under the terms of the Eclipse Public License 2.0 |
| * which accompanies this distribution, and is available at |
| * https://www.eclipse.org/legal/epl-2.0/ |
| * |
| * SPDX-License-Identifier: EPL-2.0 |
| * |
| * Contributors: |
| * IBM Corporation - initial API and implementation |
| *******************************************************************************/ |
| package org.eclipse.jdt.core.compiler; |
| |
| import org.eclipse.jdt.internal.compiler.problem.DefaultProblem; |
| |
| /** |
| * Richer description of a Java problem, as detected by the compiler or some of the underlying |
| * technology reusing the compiler. With the introduction of <code>org.eclipse.jdt.core.compiler.CompilationParticipant</code>, |
| * the simpler problem interface {@link IProblem} did not carry enough information to better |
| * separate and categorize Java problems. In order to minimize impact on existing API, Java problems |
| * are still passed around as {@link IProblem}, though actual implementations should explicitly |
| * extend {@link CategorizedProblem}. Participants can produce their own problem definitions, |
| * and given these are categorized problems, they can be better handled by clients (such as user |
| * interface). |
| * <p> |
| * A categorized problem provides access to: |
| * <ul> |
| * <li> its location (originating source file name, source position, line number) </li> |
| * <li> its message description </li> |
| * <li> predicates to check its severity (error, warning, or info) </li> |
| * <li> its ID : a number identifying the very nature of this problem. All possible IDs for standard Java |
| * problems are listed as constants on {@link IProblem}. </li> |
| * <li> its marker type : a string identifying the problem creator. It corresponds to the marker type |
| * chosen if this problem was to be persisted. Standard Java problems are associated to marker |
| * type "org.eclipse.jdt.core.problem"). </li> |
| * <li> its category ID : a number identifying the category this problem belongs to. All possible IDs for |
| * standard Java problem categories are listed in this class. </li> |
| * </ul> |
| * <p> |
| * Note: the compiler produces IProblems internally, which are turned into markers by the JavaBuilder |
| * so as to persist problem descriptions. This explains why there is no API allowing to reach IProblem detected |
| * when compiling. However, the Java problem markers carry equivalent information to IProblem, in particular |
| * their ID (attribute "id") is set to one of the IDs defined on this interface. |
| * <p> |
| * Note: Standard Java problems produced by Java default tooling will be subclasses of this class. Technically, most |
| * API methods dealing with problems are referring to {@link IProblem} for backward compatibility reason. |
| * It is intended that {@link CategorizedProblem} will be subclassed for custom problem implementation when |
| * participating in compilation operations, so as to allow participant to contribute their own marker types, and thus |
| * defining their own domain specific problem/category IDs. |
| * <p> |
| * Note: standard Java problems produced by Java default tooling will set the marker |
| * <code> IMarker#SOURCE_ID</code> attribute to |
| * <code> JavaBuilder#SOURCE_ID</code>; compiler |
| * participants may specify the <code> IMarker#SOURCE_ID</code> |
| * attribute of their markers by adding it to the extra marker attributes of the problems they generate; |
| * markers resulting from compiler participants' problems that do not have the |
| * <code> IMarker#SOURCE_ID</code> extra attribute set do not have the |
| * <code> JavaBuilder#SOURCE_ID</code> attribute set either. |
| * |
| * @since 3.2 |
| */ |
| public abstract class CategorizedProblem implements IProblem { |
| |
| /** |
| * List of standard category IDs used by Java problems, more categories will be added |
| * in the future. |
| */ |
| public static final int CAT_UNSPECIFIED = 0; |
| /** Category for problems related to buildpath */ |
| public static final int CAT_BUILDPATH = 10; |
| /** Category for fatal problems related to syntax */ |
| public static final int CAT_SYNTAX = 20; |
| /** Category for fatal problems in import statements */ |
| public static final int CAT_IMPORT = 30; |
| /** Category for fatal problems related to types, could be addressed by some type change */ |
| public static final int CAT_TYPE = 40; |
| /** Category for fatal problems related to type members, could be addressed by some field or method change */ |
| public static final int CAT_MEMBER = 50; |
| /** Category for fatal problems which could not be addressed by external changes, but require an edit to be addressed */ |
| public static final int CAT_INTERNAL = 60; |
| /** Category for optional problems in Javadoc */ |
| public static final int CAT_JAVADOC = 70; |
| /** Category for optional problems related to coding style practices */ |
| public static final int CAT_CODE_STYLE = 80; |
| /** Category for optional problems related to potential programming flaws */ |
| public static final int CAT_POTENTIAL_PROGRAMMING_PROBLEM = 90; |
| /** Category for optional problems related to naming conflicts */ |
| public static final int CAT_NAME_SHADOWING_CONFLICT = 100; |
| /** Category for optional problems related to deprecation */ |
| public static final int CAT_DEPRECATION = 110; |
| /** Category for optional problems related to unnecessary code */ |
| public static final int CAT_UNNECESSARY_CODE = 120; |
| /** Category for optional problems related to type safety in generics */ |
| public static final int CAT_UNCHECKED_RAW = 130; |
| /** Category for optional problems related to internationalization of String literals */ |
| public static final int CAT_NLS = 140; |
| /** Category for optional problems related to access restrictions */ |
| public static final int CAT_RESTRICTION = 150; |
| /** |
| * Category for fatal problems relating to modules |
| * @since 3.14 |
| */ |
| public static final int CAT_MODULE = 160; |
| /** |
| * @since 3.18 |
| */ |
| public static final int CAT_COMPLIANCE = 170; |
| /** Category for problems related to preview features |
| * @since 3.20*/ |
| public static final int CAT_PREVIEW_RELATED = 180; |
| |
| /** |
| * Returns an integer identifying the category of this problem. Categories, like problem IDs are |
| * defined in the context of some marker type. Custom implementations of {@link CategorizedProblem} |
| * may choose arbitrary values for problem/category IDs, as long as they are associated with a different |
| * marker type. |
| * Standard Java problem markers (i.e. marker type is "org.eclipse.jdt.core.problem") carry an |
| * attribute "categoryId" persisting the originating problem category ID as defined by this method). |
| * @return id - an integer identifying the category of this problem |
| */ |
| public abstract int getCategoryID(); |
| |
| /** |
| * Returns the marker type associated to this problem, if it gets persisted into a marker by the JavaBuilder |
| * Standard Java problems are associated to marker type "org.eclipse.jdt.core.problem"). |
| * Note: problem markers are expected to extend "org.eclipse.core.resources.problemmarker" marker type. |
| * @return the type of the marker which would be associated to the problem |
| */ |
| public abstract String getMarkerType(); |
| |
| /** |
| * Returns the names of the extra marker attributes associated to this problem when persisted into a marker |
| * by the JavaBuilder. Extra attributes are only optional, and are allowing client customization of generated |
| * markers. By default, no EXTRA attributes is persisted, and a categorized problem only persists the following attributes: |
| * <ul> |
| * <li> <code>IMarker#MESSAGE</code> -> {@link IProblem#getMessage()}</li> |
| * <li> <code>IMarker#SEVERITY</code> -> |
| * <code> IMarker#SEVERITY_ERROR</code>, <code>IMarker#SEVERITY_WARNING</code>, or <code>IMarker#SEVERITY_INFO</code>, |
| * depending on {@link IProblem#isError()}, {@link IProblem#isWarning()}, or or {@link IProblem#isInfo()}</li> |
| * <li> <code>IJavaModelMarker#ID</code> -> {@link IProblem#getID()}</li> |
| * <li> <code>IMarker#CHAR_START</code> -> {@link IProblem#getSourceStart()}</li> |
| * <li> <code>IMarker#CHAR_END</code> -> {@link IProblem#getSourceEnd()}</li> |
| * <li> <code>IMarker#LINE_NUMBER</code> -> {@link IProblem#getSourceLineNumber()}</li> |
| * <li> <code>IJavaModelMarker#ARGUMENTS</code> -> some <code>String[]</code> used to compute quickfixes </li> |
| * <li> <code>IJavaModelMarker#CATEGORY_ID</code> -> {@link CategorizedProblem#getCategoryID()}</li> |
| * </ul> |
| * The names must be eligible for marker creation, as defined by <code>IMarker#setAttributes(String[], Object[])</code>, |
| * and there must be as many names as values according to {@link #getExtraMarkerAttributeValues()}. |
| * Note that extra marker attributes will be inserted after default ones (as described in {@link CategorizedProblem#getMarkerType()}, |
| * and thus could be used to override defaults. |
| * @return the names of the corresponding marker attributes |
| */ |
| public String[] getExtraMarkerAttributeNames() { |
| return CharOperation.NO_STRINGS; |
| } |
| |
| /** |
| * Returns the respective values for the extra marker attributes associated to this problem when persisted into |
| * a marker by the JavaBuilder. Each value must correspond to a matching attribute name, as defined by |
| * {@link #getExtraMarkerAttributeNames()}. |
| * The values must be eligible for marker creation, as defined by <code> IMarker#setAttributes(String[], Object[])}</code>. |
| * @return the values of the corresponding extra marker attributes |
| */ |
| public Object[] getExtraMarkerAttributeValues() { |
| return DefaultProblem.EMPTY_VALUES; |
| } |
| /** |
| * {@inheritDoc} |
| * <p>Note: This implementation always returns <code>false</code>, subclasses can override.</p> |
| * |
| * @since 3.12 |
| */ |
| @Override |
| public boolean isInfo() { |
| return false; |
| } |
| } |