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