1 /******************************************************************************* 2 * Copyright (c) 2007, 2013 IBM Corporation and others. 3 * 4 * This program and the accompanying materials 5 * are made available under the terms of the Eclipse Public License 2.0 6 * which accompanies this distribution, and is available at 7 * https://www.eclipse.org/legal/epl-2.0/ 8 * 9 * SPDX-License-Identifier: EPL-2.0 10 * 11 * Contributors: 12 * IBM Corporation - initial API and implementation 13 *******************************************************************************/ 14 package org.eclipse.pde.api.tools.internal.provisional; 15 16 /** 17 * Interface that defines all the constants used to create the API Tools 18 * markers. 19 * 20 * This interface is not intended to be extended or implemented. 21 * 22 * @since 1.0.0 23 * @noimplement This interface is not intended to be implemented by clients. 24 */ 25 public interface IApiMarkerConstants { 26 27 /** 28 * Constant representing the name of the 'problem' attribute on API Tools 29 * markers. Value is: <code>problemid</code> 30 */ 31 public static final String MARKER_ATTR_PROBLEM_ID = "problemid"; //$NON-NLS-1$ 32 /** 33 * Constant representing the name of the 'kind' attribute on API Tools 34 * markers. Value is: <code>kind</code> 35 */ 36 public static final String MARKER_ATTR_KIND = "kind"; //$NON-NLS-1$ 37 /** 38 * Constant representing the handle id attribute of a java element. Value 39 * is: <code>org.eclipse.jdt.internal.core.JavaModelManager.handleId</code> 40 */ 41 public static final String MARKER_ATTR_HANDLE_ID = "org.eclipse.jdt.internal.core.JavaModelManager.handleId"; //$NON-NLS-1$ 42 /** 43 * Constant representing the handle id for an 44 * {@link org.eclipse.pde.api.tools.internal.provisional.problems.IApiProblemFilter} 45 * <br> 46 * Value is: <code>filterhandle</code> 47 */ 48 public static final String MARKER_ATTR_FILTER_HANDLE_ID = "filterhandle"; //$NON-NLS-1$ 49 /** 50 * Constant representing the name of the @since tag version attribute on API 51 * Tools markers, or the new value for the bundle version. Value is: 52 * <code>version</code> 53 */ 54 public static final String MARKER_ATTR_VERSION = "version"; //$NON-NLS-1$ 55 /** 56 * Constant representing the name of the message arguments attribute on API 57 * Tools markers. Value is <code>messagearguments</code> 58 */ 59 public static final String MARKER_ATTR_MESSAGE_ARGUMENTS = "messagearguments"; //$NON-NLS-1$ 60 /** 61 * Constant representing the id for the default API baseline problem marker. 62 * Value is: <code>org.eclipse.pde.api.tools.api_profile</code> 63 */ 64 public static final String DEFAULT_API_BASELINE_PROBLEM_MARKER = ApiPlugin.PLUGIN_ID + ".api_profile"; //$NON-NLS-1$ 65 /** 66 * Constant representing the id for the API component resolution problem 67 * marker. Value is: 68 * <code>org.eclipse.pde.api.tools.api_component_resolution</code> 69 */ 70 public static final String API_COMPONENT_RESOLUTION_PROBLEM_MARKER = ApiPlugin.PLUGIN_ID + ".api_component_resolution"; //$NON-NLS-1$ 71 /** 72 * Constant representing the id for the fatal problem marker. Value is: 73 * <code>org.eclipse.pde.api.tools.fatal_problem</code> 74 * 75 * @since 1.1 76 */ 77 public static final String FATAL_PROBLEM_MARKER = ApiPlugin.PLUGIN_ID + ".fatal_problem"; //$NON-NLS-1$ 78 /** 79 * Constant representing the id for the compatibility problem marker. Value 80 * is: <code>org.eclipse.pde.api.tools.compatibility</code> 81 */ 82 public static final String COMPATIBILITY_PROBLEM_MARKER = ApiPlugin.PLUGIN_ID + ".compatibility"; //$NON-NLS-1$ 83 /** 84 * Constant representing the id for the API usage problem marker. Value is: 85 * <code>org.eclipse.pde.api.tools.api_usage</code> 86 */ 87 public static final String API_USAGE_PROBLEM_MARKER = ApiPlugin.PLUGIN_ID + ".api_usage"; //$NON-NLS-1$ 88 /** 89 * Constant representing the id for the unused problem filter problem 90 * markers <br> 91 * Value is: <code>org.eclipse.pde.api.tools.unused_filter</code> 92 */ 93 public static final String UNUSED_FILTER_PROBLEM_MARKER = ApiPlugin.PLUGIN_ID + ".unused_filters"; //$NON-NLS-1$ 94 /** 95 * Constant representing the id for the version numbering problem marker. 96 * Value is: <code>org.eclipse.pde.api.tools.version_numbering</code> 97 */ 98 public static final String VERSION_NUMBERING_PROBLEM_MARKER = ApiPlugin.PLUGIN_ID + ".version_numbering"; //$NON-NLS-1$ 99 /** 100 * Constant representing the id for the missing @since tag problem marker. 101 * Value is: <code>org.eclipse.pde.api.tools.marker.sincetags</code> 102 */ 103 public static final String SINCE_TAGS_PROBLEM_MARKER = ApiPlugin.PLUGIN_ID + ".marker.sincetags"; //$NON-NLS-1$ 104 /** 105 * Constant representing the id for the unsupported Javadoc tag marker 106 * Values is : <code>org.eclipse.pde.api.tools.unsupported_tags</code> 107 */ 108 public static final String UNSUPPORTED_TAG_PROBLEM_MARKER = ApiPlugin.PLUGIN_ID + ".unsupported_tags"; //$NON-NLS-1$ 109 /** 110 * Constant representing the id for the unsupported annotations marker <br> 111 * <br> 112 * Value is: <code>org.eclipse.pde.api.tools.unsupported_annotations</code> 113 */ 114 public static final String UNSUPPORTED_ANNOTATION_PROBLEM_MARKER = ApiPlugin.PLUGIN_ID + ".unsupported_annotations"; //$NON-NLS-1$ 115 /** 116 * Constant representing the name of the 'apiMarkerID' attribute on API 117 * Tools markers. Value is: <code>apiMarkerID</code> 118 */ 119 public static final String API_MARKER_ATTR_ID = "apiMarkerID"; //$NON-NLS-1$ 120 /** 121 * Constant representing the apiMarkerID value for default API baseline 122 * markers. Value is: <code>1</code> 123 */ 124 public static final int DEFAULT_API_BASELINE_MARKER_ID = 1; 125 /** 126 * Constant representing the apiMarkerID value for compatibility markers. 127 * Value is: <code>2</code> 128 */ 129 public static final int COMPATIBILITY_MARKER_ID = 2; 130 /** 131 * Constant representing the apiMarkerID value for API usage markers. Value 132 * is: <code>3</code> 133 */ 134 public static final int API_USAGE_MARKER_ID = 3; 135 /** 136 * Constant representing the apiMarkerID value for version numbering 137 * markers. Value is: <code>4</code> 138 */ 139 public static final int VERSION_NUMBERING_MARKER_ID = 4; 140 /** 141 * Constant representing the apiMarkerID value for since tags markers. Value 142 * is: <code>5</code> 143 */ 144 public static final int SINCE_TAG_MARKER_ID = 5; 145 /** 146 * Constant representing the apiMarkerID value for unsupported javadoc tag 147 * markers Value is: <code>6</code> 148 */ 149 public static final int UNSUPPORTED_TAG_MARKER_ID = 6; 150 /** 151 * Constant representing the apiMarkerID value for duplicate JavaDoc tag 152 * markers Value is: <code>7</code> 153 */ 154 public static final int DUPLICATE_TAG_MARKER_ID = 7; 155 /** 156 * Constant representing the apiMarkerID value for API component resolution 157 * markers. Value is: <code>8</code> 158 */ 159 public static final int API_COMPONENT_RESOLUTION_MARKER_ID = 8; 160 /** 161 * Constant representing the apiMarkerID value for unused problem filter 162 * markers. Value is: <code>9</code> 163 */ 164 public static final int UNUSED_PROBLEM_FILTER_MARKER_ID = 9; 165 /** 166 * Constant representing the apiMarkerID value for a duplicate annotation <br> 167 * <br> 168 * Value is: <code>10</code> 169 * 170 * @since 1.0.600 171 */ 172 public static final int DUPLICATE_ANNOTATION_MARKER_ID = 10; 173 /** 174 * Constant representing the apiMarkerID for unsupported annotation markers. <br> 175 * <br> 176 * Value is: <code>11</code> 177 * 178 * @since 1.0.600 179 */ 180 public static final int UNSUPPORTED_ANNOTATION_MARKER_ID = 11; 181 /** 182 * Constant representing the description for the bundle version marker. 183 * Value is: <code>description</code> 184 */ 185 public static final String VERSION_NUMBERING_ATTR_DESCRIPTION = "description"; //$NON-NLS-1$ 186 /** 187 * Constant representing the type name of the 'problem' attribute on API 188 * Tools markers. Value is: <code>problemTypeName</code> 189 */ 190 public static final String MARKER_ATTR_PROBLEM_TYPE_NAME = "problemTypeName"; //$NON-NLS-1$ 191 /** 192 * Constant representing the id for the API Use Scan breakage problem 193 * marker. Value is: 194 * <code>org.eclipse.pde.api.tools.marker.apiusescan</code> 195 */ 196 public static final String API_USESCAN_PROBLEM_MARKER = ApiPlugin.PLUGIN_ID + ".marker.apiusescan"; //$NON-NLS-1$ 197 /** 198 * Constant representing the id for the additional marker attribute for 199 * storing the type name This will be used to delete the markers when a 200 * missing type becomes available Value is: <code>apiUseScanType</code> 201 */ 202 public static final String API_USESCAN_TYPE = "apiUseScanType"; //$NON-NLS-1$ 203 204 } 205