001: /*******************************************************************************
002: * Copyright (c) 2000, 2006 IBM Corporation and others.
003: * All rights reserved. This program and the accompanying materials
004: * are made available under the terms of the Eclipse Public License v1.0
005: * which accompanies this distribution, and is available at
006: * http://www.eclipse.org/legal/epl-v10.html
007: *
008: * Contributors:
009: * IBM Corporation - initial API and implementation
010: *******************************************************************************/package org.eclipse.jdt.core;
011:
012: /**
013: * Markers used by the Java model.
014: * <p>
015: * This interface declares constants only; it is not intended to be implemented
016: * or extended.
017: * </p>
018: */
019: public interface IJavaModelMarker {
020:
021: /**
022: * Java model problem marker type (value
023: * <code>"org.eclipse.jdt.core.problem"</code>). This can be used to
024: * recognize those markers in the workspace that flag problems detected by
025: * the Java tooling during compilation.
026: */
027: String JAVA_MODEL_PROBLEM_MARKER = JavaCore.PLUGIN_ID + ".problem"; //$NON-NLS-1$
028:
029: /**
030: * Java model transient problem marker type (value
031: * <code>"org.eclipse.jdt.core.transient_problem"</code>). This can be
032: * used to recognize those markers in the workspace that flag transient
033: * problems detected by the Java tooling (such as a problem detected by the
034: * outliner, or a problem detected during a code completion). Since 1.0,
035: * transient problems are reported as <code>IProblem</code> through
036: * various API. Only the evaluation API is still producing markers for
037: * transient problems.
038: *
039: * @see org.eclipse.jdt.core.compiler.IProblem
040: * @see org.eclipse.jdt.core.eval.ICodeSnippetRequestor#acceptProblem(org.eclipse.core.resources.IMarker,String,
041: * int)
042: */
043: String TRANSIENT_PROBLEM = JavaCore.PLUGIN_ID
044: + ".transient_problem"; //$NON-NLS-1$
045:
046: /**
047: * Java model task marker type (value
048: * <code>"org.eclipse.jdt.core.task"</code>). This can be used to
049: * recognize task markers in the workspace that correspond to tasks
050: * specified in Java source comments and detected during compilation (for
051: * example, 'TO-DO: ...'). Tasks are identified by a task tag, which can be
052: * customized through <code>JavaCore</code> option
053: * <code>"org.eclipse.jdt.core.compiler.taskTag"</code>.
054: *
055: * @since 2.1
056: */
057: String TASK_MARKER = JavaCore.PLUGIN_ID + ".task"; //$NON-NLS-1$
058:
059: /**
060: * Id marker attribute (value <code>"arguments"</code>). Arguments are
061: * concatenated into one String, prefixed with an argument count (followed
062: * with colon separator) and separated with '#' characters. For example: {
063: * "foo", "bar" } is encoded as "2:foo#bar", { } is encoded as "0: "
064: *
065: * @since 2.0
066: */
067: String ARGUMENTS = "arguments"; //$NON-NLS-1$
068:
069: /**
070: * ID marker attribute (value <code>"id"</code>).
071: */
072: String ID = "id"; //$NON-NLS-1$
073:
074: /**
075: * ID category marker attribute (value <code>"categoryId"</code>)
076: * @since 3.2
077: */
078: String CATEGORY_ID = "categoryId"; //$NON-NLS-1$
079:
080: /**
081: * Flags marker attribute (value <code>"flags"</code>). Reserved for
082: * future use.
083: */
084: String FLAGS = "flags"; //$NON-NLS-1$
085:
086: /**
087: * Cycle detected marker attribute (value <code>"cycleDetected"</code>).
088: * Used only on buildpath problem markers. The value of this attribute is
089: * either "true" or "false".
090: */
091: String CYCLE_DETECTED = "cycleDetected"; //$NON-NLS-1$
092:
093: /**
094: * Build path problem marker type (value
095: * <code>"org.eclipse.jdt.core.buildpath_problem"</code>). This can be
096: * used to recognize those markers in the workspace that flag problems
097: * detected by the Java tooling during classpath setting.
098: */
099: String BUILDPATH_PROBLEM_MARKER = JavaCore.PLUGIN_ID
100: + ".buildpath_problem"; //$NON-NLS-1$
101:
102: /**
103: * Classpath file format marker attribute (value
104: * <code>"classpathFileFormat"</code>). Used only on buildpath problem
105: * markers. The value of this attribute is either "true" or "false".
106: *
107: * @since 2.0
108: */
109: String CLASSPATH_FILE_FORMAT = "classpathFileFormat"; //$NON-NLS-1$
110: }
|