code cleaning (no functional changes)

[phpeclipse.git] / net.sourceforge.phpeclipse / src / net / sourceforge / phpeclipse / phpeditor / IJavaAnnotation.java

diff --git a/net.sourceforge.phpeclipse/src/net/sourceforge/phpeclipse/phpeditor/IJavaAnnotation.java b/net.sourceforge.phpeclipse/src/net/sourceforge/phpeclipse/phpeditor/IJavaAnnotation.java
index 266d368..f35399b 100644 (file)
--- a/net.sourceforge.phpeclipse/src/net/sourceforge/phpeclipse/phpeditor/IJavaAnnotation.java
+++ b/net.sourceforge.phpeclipse/src/net/sourceforge/phpeclipse/phpeditor/IJavaAnnotation.java
@@ -12,6 +12,8 @@ package net.sourceforge.phpeclipse.phpeditor;
 
 import java.util.Iterator;
 
+import net.sourceforge.phpdt.core.ICompilationUnit;
+
 import org.eclipse.swt.graphics.Image;
 import org.eclipse.swt.widgets.Display;
 
@@ -20,36 +22,29 @@ import org.eclipse.swt.widgets.Display;
  * and problems.
  * 
  * @see org.eclipse.core.resources.IMarker
- * @see org.eclipse.jdt.core.compiler.IProblem
+ * @see net.sourceforge.phpdt.core.compiler.IProblem
  */
 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.
@@ -59,6 +54,14 @@ public interface IJavaAnnotation {
        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.
         * 
@@ -89,4 +92,16 @@ public interface IJavaAnnotation {
         * @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);
 }