net.sourceforge.phpeclipse/src/net/sourceforge/phpdt/core/IJavaModelMarker.java

   1 /*******************************************************************************
   2  * Copyright (c) 2000, 2003 IBM Corporation and others.
   3  * All rights reserved. This program and the accompanying materials
   4  * are made available under the terms of the Common Public License v1.0
   5  * which accompanies this distribution, and is available at
   6  * http://www.eclipse.org/legal/cpl-v10.html
   7  *
   8  * Contributors:
   9  *     IBM Corporation - initial API and implementation
  10  *******************************************************************************/
  11 package net.sourceforge.phpdt.core;
  12
  13
  14 /**
  15  * Markers used by the Java model.
  16  * <p>
  17  * This interface declares constants only; it is not intended to be implemented
  18  * or extended.
  19  * </p>
  20  */
  21 public interface IJavaModelMarker {
  22
  23         /**
  24          * Java model problem marker type (value <code>"org.eclipse.jdt.core.problem"</code>).
  25          * This can be used to recognize those markers in the workspace that flag problems
  26          * detected by the Java tooling during compilation.
  27          */
  28         public static final String JAVA_MODEL_PROBLEM_MARKER = JavaCore.PLUGIN_ID + ".problem"; //$NON-NLS-1$
  29
  30
  31         /**
  32          * Java model transient problem marker type (value <code>"org.eclipse.jdt.core.transient_problem"</code>).
  33          * This can be used to recognize those markers in the workspace that flag transient
  34          * problems detected by the Java tooling (such as a problem
  35          * detected by the outliner, or a problem detected during a code completion)
  36          */
  37         public static final String TRANSIENT_PROBLEM = JavaCore.PLUGIN_ID + ".transient_problem"; //$NON-NLS-1$
  38
  39         /**
  40          * Java model task marker type (value <code>"org.eclipse.jdt.core.task"</code>).
  41          * This can be used to recognize task markers in the workspace that correspond to tasks
  42          * specified in Java source comments and detected during compilation (for example, 'TO-DO: ...').
  43          * Tasks are identified by a task tag, which can be customized through <code>PHPCore</code>
  44          * option <code>"org.eclipse.jdt.core.compiler.taskTag"</code>.
  45          * @since 2.1
  46          */
  47         public static final String TASK_MARKER = JavaCore.PLUGIN_ID + ".task"; //$NON-NLS-1$
  48
  49
  50     /**
  51          * Id marker attribute (value <code>"arguments"</code>).
  52          * Arguments are concatenated into one String, prefixed with an argument count (followed with colon
  53          * separator) and separated with '#' characters. For example:
  54          *     { "foo", "bar" } is encoded as "2:foo#bar",
  55          *     {  } is encoded as "0: "
  56          * @since 2.0
  57          */
  58          public static final String ARGUMENTS = "arguments"; //$NON-NLS-1$
  59
  60         /**
  61          * Id marker attribute (value <code>"id"</code>).
  62          */
  63          public static final String ID = "id"; //$NON-NLS-1$
  64
  65         /**
  66          * Flags marker attribute (value <code>"flags"</code>).
  67          * Reserved for future use.
  68          */
  69          public static final String FLAGS = "flags"; //$NON-NLS-1$
  70
  71         /**
  72          * Cycle detected marker attribute (value <code>"cycleDetected"</code>).
  73          * Used only on buildpath problem markers.
  74          * The value of this attribute is either "true" or "false".
  75          */
  76          public static final String CYCLE_DETECTED = "cycleDetected"; //$NON-NLS-1$
  77
  78         /**
  79          * Build path problem marker type (value <code>"org.eclipse.jdt.core.buildpath_problem"</code>).
  80          * This can be used to recognize those markers in the workspace that flag problems
  81          * detected by the Java tooling during classpath setting.
  82          */
  83         public static final String BUILDPATH_PROBLEM_MARKER = JavaCore.PLUGIN_ID + ".buildpath_problem"; //$NON-NLS-1$
  84
  85         /**
  86          * Classpath file format marker attribute (value <code>"classpathFileFormat"</code>).
  87          * Used only on buildpath problem markers.
  88          * The value of this attribute is either "true" or "false".
  89          *
  90          * @since 2.0
  91          */
  92          public static final String CLASSPATH_FILE_FORMAT = "classpathFileFormat"; //$NON-NLS-1$
  93
  94 }