KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > eclipse > jdt > core > IJavaModelMarker


1 /*******************************************************************************
2  * Copyright (c) 2000, 2006 IBM Corporation and others.
3  * All rights reserved. This program and the accompanying materials
4  * are made available under the terms of the Eclipse Public License v1.0
5  * which accompanies this distribution, and is available at
6  * http://www.eclipse.org/legal/epl-v10.html
7  *
8  * Contributors:
9  * IBM Corporation - initial API and implementation
10  *******************************************************************************/
11 package org.eclipse.jdt.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>"org.eclipse.jdt.core.problem"</code>). This can be used to
25      * recognize those markers in the workspace that flag problems detected by
26      * the Java tooling during compilation.
27      */
28     String JavaDoc JAVA_MODEL_PROBLEM_MARKER = JavaCore.PLUGIN_ID + ".problem"; //$NON-NLS-1$
29
30     /**
31      * Java model transient problem marker type (value
32      * <code>"org.eclipse.jdt.core.transient_problem"</code>). This can be
33      * used to recognize those markers in the workspace that flag transient
34      * problems detected by the Java tooling (such as a problem detected by the
35      * outliner, or a problem detected during a code completion). Since 1.0,
36      * transient problems are reported as <code>IProblem</code> through
37      * various API. Only the evaluation API is still producing markers for
38      * transient problems.
39      *
40      * @see org.eclipse.jdt.core.compiler.IProblem
41      * @see org.eclipse.jdt.core.eval.ICodeSnippetRequestor#acceptProblem(org.eclipse.core.resources.IMarker,String,
42      * int)
43      */
44     String JavaDoc TRANSIENT_PROBLEM = JavaCore.PLUGIN_ID + ".transient_problem"; //$NON-NLS-1$
45
46     /**
47      * Java model task marker type (value
48      * <code>"org.eclipse.jdt.core.task"</code>). This can be used to
49      * recognize task markers in the workspace that correspond to tasks
50      * specified in Java source comments and detected during compilation (for
51      * example, 'TO-DO: ...'). Tasks are identified by a task tag, which can be
52      * customized through <code>JavaCore</code> option
53      * <code>"org.eclipse.jdt.core.compiler.taskTag"</code>.
54      *
55      * @since 2.1
56      */
57     String JavaDoc TASK_MARKER = JavaCore.PLUGIN_ID + ".task"; //$NON-NLS-1$
58
59     /**
60      * Id marker attribute (value <code>"arguments"</code>). Arguments are
61      * concatenated into one String, prefixed with an argument count (followed
62      * with colon separator) and separated with '#' characters. For example: {
63      * "foo", "bar" } is encoded as "2:foo#bar", { } is encoded as "0: "
64      *
65      * @since 2.0
66      */
67     String JavaDoc ARGUMENTS = "arguments"; //$NON-NLS-1$
68
69     /**
70      * ID marker attribute (value <code>"id"</code>).
71      */
72     String JavaDoc ID = "id"; //$NON-NLS-1$
73
74     /**
75      * ID category marker attribute (value <code>"categoryId"</code>)
76      * @since 3.2
77      */
78     String JavaDoc CATEGORY_ID = "categoryId"; //$NON-NLS-1$
79
80     /**
81      * Flags marker attribute (value <code>"flags"</code>). Reserved for
82      * future use.
83      */
84     String JavaDoc FLAGS = "flags"; //$NON-NLS-1$
85
86     /**
87      * Cycle detected marker attribute (value <code>"cycleDetected"</code>).
88      * Used only on buildpath problem markers. The value of this attribute is
89      * either "true" or "false".
90      */
91     String JavaDoc CYCLE_DETECTED = "cycleDetected"; //$NON-NLS-1$
92
93     /**
94      * Build path problem marker type (value
95      * <code>"org.eclipse.jdt.core.buildpath_problem"</code>). This can be
96      * used to recognize those markers in the workspace that flag problems
97      * detected by the Java tooling during classpath setting.
98      */
99     String JavaDoc 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 JavaDoc CLASSPATH_FILE_FORMAT = "classpathFileFormat"; //$NON-NLS-1$
110 }
111
Popular Tags