org.eclipse.jdt.core.IJavaModelMarker.java Source code

Introduction

Here is the source code for org.eclipse.jdt.core.IJavaModelMarker.java

Source

/*******************************************************************************
 * Copyright (c) 2000, 2011 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;

import org.eclipse.core.resources.IMarker;

/**
 * Markers used by the Java model.
 * <p>
 * This interface declares constants only.
 * </p>
 * @noimplement This interface is not intended to be implemented by clients.
 */
public interface IJavaModelMarker {

    /**
     * Java model problem marker type (value
     * <code>"org.eclipse.jdt.core.problem"</code>). This can be used to
     * recognize those markers in the workspace that flag problems detected by
     * the Java tooling during compilation.
     */
    String JAVA_MODEL_PROBLEM_MARKER = JavaCore.PLUGIN_ID + ".problem"; //$NON-NLS-1$

    /**
     * Java model transient problem marker type (value
     * <code>"org.eclipse.jdt.core.transient_problem"</code>). This can be
     * used to recognize those markers in the workspace that flag transient
     * problems detected by the Java tooling (such as a problem detected by the
     * outliner, or a problem detected during a code completion). Since 1.0,
     * transient problems are reported as <code>IProblem</code> through
     * various API. Only the evaluation API is still producing markers for
     * transient problems.
     *
     * @see org.eclipse.jdt.core.compiler.IProblem
     * @see org.eclipse.jdt.core.eval.ICodeSnippetRequestor#acceptProblem(org.eclipse.core.resources.IMarker,String,
     *      int)
     */
    String TRANSIENT_PROBLEM = JavaCore.PLUGIN_ID + ".transient_problem"; //$NON-NLS-1$

    /**
     * Java model task marker type (value
     * <code>"org.eclipse.jdt.core.task"</code>). This can be used to
     * recognize task markers in the workspace that correspond to tasks
     * specified in Java source comments and detected during compilation (for
     * example, 'TO-DO: ...'). Tasks are identified by a task tag, which can be
     * customized through <code>JavaCore</code> option
     * <code>"org.eclipse.jdt.core.compiler.taskTag"</code>.
     *
     * @since 2.1
     */
    String TASK_MARKER = JavaCore.PLUGIN_ID + ".task"; //$NON-NLS-1$

    /**
     * Id marker attribute (value <code>"arguments"</code>). Arguments are
     * concatenated into one String, prefixed with an argument count (followed
     * with colon separator) and separated with '#' characters. For example: {
     * "foo", "bar" } is encoded as "2:foo#bar", { } is encoded as "0:".
     * <p>Empty argument is encoded as three spaces ("   ").</p>
     * <p>If the argument contains a '#', the character is doubled.<br>
     * {"foo#test", "bar" } is encoded as "2:foo##test#bar"
     * </p>
     * 
     * @since 2.0
     * @see CorrectionEngine#getProblemArguments(IMarker)
     */
    String ARGUMENTS = "arguments"; //$NON-NLS-1$

    /**
     * ID marker attribute (value <code>"id"</code>).
     */
    String ID = "id"; //$NON-NLS-1$

    /**
     * ID category marker attribute (value <code>"categoryId"</code>)
     * @since 3.2
     */
    String CATEGORY_ID = "categoryId"; //$NON-NLS-1$

    /**
     * Flags marker attribute (value <code>"flags"</code>). Reserved for
     * future use.
     */
    String FLAGS = "flags"; //$NON-NLS-1$

    /**
     * Cycle detected marker attribute (value <code>"cycleDetected"</code>).
     * Used only on buildpath problem markers. The value of this attribute is
     * either "true" or "false".
     */
    String CYCLE_DETECTED = "cycleDetected"; //$NON-NLS-1$

    /**
     * Build path problem marker type (value
     * <code>"org.eclipse.jdt.core.buildpath_problem"</code>). This can be
     * used to recognize those markers in the workspace that flag problems
     * detected by the Java tooling during classpath setting.
     */
    String BUILDPATH_PROBLEM_MARKER = JavaCore.PLUGIN_ID + ".buildpath_problem"; //$NON-NLS-1$

    /**
     * Classpath file format marker attribute (value
     * <code>"classpathFileFormat"</code>). Used only on buildpath problem
     * markers. The value of this attribute is either "true" or "false".
     *
     * @since 2.0
     */
    String CLASSPATH_FILE_FORMAT = "classpathFileFormat"; //$NON-NLS-1$

    /**
     * Output overlapping another source attribute (value <code>"outputOverlappingSource"</code>). 
     * Used only on buildpath problem markers. The value of this attribute is 
     * either "true" or "false".
     * 
     * @since 3.6.4
     */
    String OUTPUT_OVERLAPPING_SOURCE = "outputOverlappingSource"; //$NON-NLS-1$
}