X-Git-Url: http://secure.phpeclipse.com

diff --git a/net.sourceforge.phpeclipse/src/net/sourceforge/phpeclipse/phpeditor/IJavaAnnotation.java b/net.sourceforge.phpeclipse/src/net/sourceforge/phpeclipse/phpeditor/IJavaAnnotation.java
new file mode 100644
index 0000000..266d368
--- /dev/null
+++ b/net.sourceforge.phpeclipse/src/net/sourceforge/phpeclipse/phpeditor/IJavaAnnotation.java
@@ -0,0 +1,92 @@
+/*******************************************************************************
+ * Copyright (c) 2000, 2003 IBM Corporation and others.
+ * All rights reserved. This program and the accompanying materials 
+ * are made available under the terms of the Common Public License v1.0
+ * which accompanies this distribution, and is available at
+ * http://www.eclipse.org/legal/cpl-v10.html
+ * 
+ * Contributors:
+ *     IBM Corporation - initial API and implementation
+ *******************************************************************************/
+package net.sourceforge.phpeclipse.phpeditor;
+
+import java.util.Iterator;
+
+import org.eclipse.swt.graphics.Image;
+import org.eclipse.swt.widgets.Display;
+
+/**
+ * Interface of annotations representing markers
+ * and problems.
+ * 
+ * @see org.eclipse.core.resources.IMarker
+ * @see org.eclipse.jdt.core.compiler.IProblem
+ */
+public interface IJavaAnnotation {
+	
+	AnnotationType getAnnotationType();
+	
+	boolean isTemporary();
+	
+	String getMessage();
+	
+	String[] getArguments();
+	
+	int getId();
+	
+	
+	Image getImage(Display display);
+	
+	/**
+	 * 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()
+	 */
+	boolean isRelevant();
+	
+	/**
+	 * Returns whether this annotation is overlaid.
+	 * 
+	 * @return <code>true</code> if overlaid
+	 */
+	boolean hasOverlay();
+	
+	/**
+	 * Returns an iterator for iterating over the
+ 	 * annotation which are overlaid by this annotation.
+	 * 
+	 * @return an iterator over the overlaid annotaions
+	 */
+	Iterator getOverlaidIterator();
+	
+	/**
+	 * Adds the given annotation to the list of
+	 * annotations which are overlaid by this annotations.
+	 *  
+	 * @param annotation	the problem annoation
+	 */
+	void addOverlaid(IJavaAnnotation annotation);
+	
+	/**
+	 * Removes the given annotation from the list of
+	 * annotations which are overlaid by this annotation.
+	 *  
+	 * @param annotation	the problem annoation
+	 */
+	void removeOverlaid(IJavaAnnotation annotation);
+	
+	/**
+	 * Tells whether this annotation is a problem
+	 * annotation.
+	 * 
+	 * @return <code>true</code> if it is a problem annotation
+	 */
+	boolean isProblem();
+}