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