import org.eclipse.swt.graphics.Image;
import org.eclipse.swt.widgets.Display;
+import net.sourceforge.phpdt.core.ICompilationUnit;
+
/**
* Interface of annotations representing markers
* and problems.
*/
public interface IJavaAnnotation {
- AnnotationType getAnnotationType();
-
- boolean isTemporary();
-
- String getMessage();
-
- String[] getArguments();
-
- int getId();
+ /**
+ * @see org.eclipse.jface.text.source.Annotation#getType()
+ */
+ String getType();
+ /**
+ * @see org.eclipse.jface.text.source.Annotation#isPersistent()
+ */
+ boolean isPersistent();
- Image getImage(Display display);
+ /**
+ * @see org.eclipse.jface.text.source.Annotation#isMarkedDeleted()
+ */
+ boolean isMarkedDeleted();
/**
- * Returns whether this annotation is relavant.
- * <p>
- * If the annotation is overlaid then it is not
- * relevant. After all overlays have been removed
- * the annotation might either become relevant again
- * or stay irrelevant.
- * </p>
- *
- * @return <code>true</code> if relevant
- * @see #hasOverlay()
+ * @see org.eclipse.jface.text.source.Annotation#getText()
*/
- boolean isRelevant();
+ String getText();
/**
* Returns whether this annotation is overlaid.
boolean hasOverlay();
/**
+ * Returns the overlay of this annotation.
+ *
+ * @return the annotation's overlay
+ * @since 3.0
+ */
+ IJavaAnnotation getOverlay();
+
+ /**
* Returns an iterator for iterating over the
* annotation which are overlaid by this annotation.
*
* @return <code>true</code> if it is a problem annotation
*/
boolean isProblem();
+
+ /**
+ * Returns the compilation unit corresponding to the document on which the annotation is set
+ * or <code>null</code> if no corresponding co0mpilationunit exists.
+ */
+ ICompilationUnit getCompilationUnit();
+
+ String[] getArguments();
+
+ int getId();
+
+ Image getImage(Display display);
}