| /******************************************************************************* |
| * Copyright (c) 2007, 2010 IBM Corporation and others. |
| * All rights reserved. This 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: |
| * IBM Corporation - initial API and implementation |
| *******************************************************************************/ |
| package org.eclipse.pde.api.tools.internal.provisional; |
| |
| /** |
| * Interface that defines all the constants used to create the Api tooling markers. |
| * |
| * This interface is not intended to be extended or implemented. |
| * |
| * @since 1.0.0 |
| * @noimplement This interface is not intended to be implemented by clients. |
| */ |
| public interface IApiMarkerConstants { |
| |
| /** |
| * Constant representing the name of the 'problem' attribute on api tooling markers. |
| * Value is: <code>problemid</code> |
| */ |
| public static final String MARKER_ATTR_PROBLEM_ID = "problemid"; //$NON-NLS-1$ |
| /** |
| * Constant representing the name of the 'kind' attribute on API tooling markers. |
| * Value is: <code>kind</code> |
| */ |
| public static final String MARKER_ATTR_KIND = "kind"; //$NON-NLS-1$ |
| /** |
| * Constant representing the handle id attribute of a java element. |
| * Value is: <code>org.eclipse.jdt.internal.core.JavaModelManager.handleId</code> |
| */ |
| public static final String MARKER_ATTR_HANDLE_ID = "org.eclipse.jdt.internal.core.JavaModelManager.handleId" ; //$NON-NLS-1$ |
| /** |
| * Constant representing the handle id for an {@link org.eclipse.pde.api.tools.internal.provisional.problems.IApiProblemFilter} |
| * <br> |
| * Value is: <code>filterhandle</code> |
| */ |
| public static final String MARKER_ATTR_FILTER_HANDLE_ID = "filterhandle"; //$NON-NLS-1$ |
| /** |
| * Constant representing the name of the @since tag version attribute on API tooling markers, |
| * or the new value for the bundle version. |
| * Value is: <code>version</code> |
| */ |
| public static final String MARKER_ATTR_VERSION = "version"; //$NON-NLS-1$ |
| /** |
| * Constant representing the name of the message arguments attribute on API tooling markers. |
| * Value is <code>messagearguments</code> |
| */ |
| public static final String MARKER_ATTR_MESSAGE_ARGUMENTS = "messagearguments"; //$NON-NLS-1$ |
| /** |
| * Constant representing the id for the default API baseline problem marker. |
| * Value is: <code>org.eclipse.pde.api.tools.api_profile</code> |
| */ |
| public static final String DEFAULT_API_BASELINE_PROBLEM_MARKER = ApiPlugin.PLUGIN_ID + ".api_profile"; //$NON-NLS-1$ |
| /** |
| * Constant representing the id for the API component resolution problem marker. |
| * Value is: <code>org.eclipse.pde.api.tools.api_component_resolution</code> |
| */ |
| public static final String API_COMPONENT_RESOLUTION_PROBLEM_MARKER = ApiPlugin.PLUGIN_ID + ".api_component_resolution"; //$NON-NLS-1$ |
| /** |
| * Constant representing the id for the fatal problem marker. |
| * Value is: <code>org.eclipse.pde.api.tools.fatal_problem</code> |
| * @since 1.1 |
| */ |
| public static final String FATAL_PROBLEM_MARKER = ApiPlugin.PLUGIN_ID + ".fatal_problem"; //$NON-NLS-1$ |
| /** |
| * Constant representing the id for the compatibility problem marker. |
| * Value is: <code>org.eclipse.pde.api.tools.compatibility</code> |
| */ |
| public static final String COMPATIBILITY_PROBLEM_MARKER = ApiPlugin.PLUGIN_ID + ".compatibility"; //$NON-NLS-1$ |
| /** |
| * Constant representing the id for the API usage problem marker. |
| * Value is: <code>org.eclipse.pde.api.tools.api_usage</code> |
| */ |
| public static final String API_USAGE_PROBLEM_MARKER = ApiPlugin.PLUGIN_ID + ".api_usage"; //$NON-NLS-1$ |
| /** |
| * Constant representing the id for the unused problem filter problem markers |
| * <br> |
| * Value is: <code>org.eclipse.pde.api.tools.unused_filter</code> |
| */ |
| public static final String UNUSED_FILTER_PROBLEM_MARKER = ApiPlugin.PLUGIN_ID + ".unused_filters"; //$NON-NLS-1$ |
| /** |
| * Constant representing the id for the version numbering problem marker. |
| * Value is: <code>org.eclipse.pde.api.tools.version_numbering</code> |
| */ |
| public static final String VERSION_NUMBERING_PROBLEM_MARKER = ApiPlugin.PLUGIN_ID + ".version_numbering"; //$NON-NLS-1$ |
| /** |
| * Constant representing the id for the missing @since tag problem marker. |
| * Value is: <code>org.eclipse.pde.api.tools.marker.sincetags</code> |
| */ |
| public static final String SINCE_TAGS_PROBLEM_MARKER = ApiPlugin.PLUGIN_ID + ".marker.sincetags"; //$NON-NLS-1$ |
| /** |
| * Constant representing the id for the unsupported Javadoc tag marker |
| * Values is : <code>>org.eclipse.pde.api.tools.unsupported_tags</code> |
| */ |
| public static final String UNSUPPORTED_TAG_PROBLEM_MARKER = ApiPlugin.PLUGIN_ID + ".unsupported_tags"; //$NON-NLS-1$ |
| /** |
| * Constant representing the name of the 'apiMarkerID' attribute on API tooling markers. |
| * Value is: <code>apiMarkerID</code> |
| */ |
| public static final String API_MARKER_ATTR_ID = "apiMarkerID"; //$NON-NLS-1$ |
| /** |
| * Constant representing the apiMarkerID value for default API baseline markers. |
| * Value is: <code>1</code> |
| */ |
| public static final int DEFAULT_API_BASELINE_MARKER_ID = 1; |
| /** |
| * Constant representing the apiMarkerID value for compatibility markers. |
| * Value is: <code>2</code> |
| */ |
| public static final int COMPATIBILITY_MARKER_ID = 2; |
| /** |
| * Constant representing the apiMarkerID value for api usage markers. |
| * Value is: <code>3</code> |
| */ |
| public static final int API_USAGE_MARKER_ID = 3; |
| /** |
| * Constant representing the apiMarkerID value for version numbering markers. |
| * Value is: <code>4</code> |
| */ |
| public static final int VERSION_NUMBERING_MARKER_ID = 4; |
| /** |
| * Constant representing the apiMarkerID value for since tags markers. |
| * Value is: <code>5</code> |
| */ |
| public static final int SINCE_TAG_MARKER_ID = 5; |
| /** |
| * Constant representing the apiMarkerID value for unsupported javadoc tag markers |
| * Value is: <code>6</code> |
| */ |
| public static final int UNSUPPORTED_TAG_MARKER_ID = 6; |
| /** |
| * Constant representing the apiMarkerID value for duplicate javadoc tag markers |
| * Value is: <code>7</code> |
| */ |
| public static final int DUPLICATE_TAG_MARKER_ID = 7; |
| /** |
| * Constant representing the apiMarkerID value for api component resolution markers. |
| * Value is: <code>8</code> |
| */ |
| public static final int API_COMPONENT_RESOLUTION_MARKER_ID = 8; |
| /** |
| * Constant representing the apiMarkerID value for unused problem filter markers. |
| * Value is: <code>9</code> |
| */ |
| public static final int UNUSED_PROBLEM_FILTER_MARKER_ID = 9; |
| /** |
| * Constant representing the description for the bundle version marker. |
| * Value is: <code>description</code> |
| */ |
| public static final String VERSION_NUMBERING_ATTR_DESCRIPTION = "description"; //$NON-NLS-1$ |
| /** |
| * Constant representing the type name of the 'problem' attribute on api tooling markers. |
| * Value is: <code>problemTypeName</code> |
| */ |
| public static final String MARKER_ATTR_PROBLEM_TYPE_NAME = "problemTypeName"; //$NON-NLS-1$ |
| |
| } |