1) Moved net.sourceforge.phpeclipse.ui\src\net\sourceforge\phpdt back to net.sourcefo...
[phpeclipse.git] / net.sourceforge.phpeclipse / src / net / sourceforge / phpeclipse / phpeditor / JavaAnnotationIterator.java
diff --git a/net.sourceforge.phpeclipse/src/net/sourceforge/phpeclipse/phpeditor/JavaAnnotationIterator.java b/net.sourceforge.phpeclipse/src/net/sourceforge/phpeclipse/phpeditor/JavaAnnotationIterator.java
new file mode 100644 (file)
index 0000000..40ef7c2
--- /dev/null
@@ -0,0 +1,107 @@
+/*******************************************************************************
+ * 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.Collections;
+import java.util.Iterator;
+
+import org.eclipse.jface.text.source.Annotation;
+import org.eclipse.jface.text.source.IAnnotationModel;
+
+/**
+ * Filters problems based on their types.
+ */
+public class JavaAnnotationIterator implements Iterator {
+
+       private Iterator fIterator;
+
+       private Annotation fNext;
+
+       private boolean fSkipIrrelevants;
+
+       private boolean fReturnAllAnnotations;
+
+       /**
+        * Equivalent to
+        * <code>JavaAnnotationIterator(model, skipIrrelevants, false)</code>.
+        */
+       public JavaAnnotationIterator(IAnnotationModel model,
+                       boolean skipIrrelevants) {
+               this(model, skipIrrelevants, false);
+       }
+
+       /**
+        * Returns a new JavaAnnotationIterator.
+        * 
+        * @param model
+        *            the annotation model
+        * @param skipIrrelevants
+        *            whether to skip irrelevant annotations
+        * @param returnAllAnnotations
+        *            Whether to return non IJavaAnnotations as well
+        */
+       public JavaAnnotationIterator(IAnnotationModel model,
+                       boolean skipIrrelevants, boolean returnAllAnnotations) {
+               fReturnAllAnnotations = returnAllAnnotations;
+               if (model != null)
+                       fIterator = model.getAnnotationIterator();
+               else
+                       fIterator = Collections.EMPTY_LIST.iterator();
+               fSkipIrrelevants = skipIrrelevants;
+               skip();
+       }
+
+       private void skip() {
+               while (fIterator.hasNext()) {
+                       Annotation next = (Annotation) fIterator.next();
+                       if (next instanceof IJavaAnnotation) {
+                               if (fSkipIrrelevants) {
+                                       if (!next.isMarkedDeleted()) {
+                                               fNext = next;
+                                               return;
+                                       }
+                               } else {
+                                       fNext = next;
+                                       return;
+                               }
+                       } else if (fReturnAllAnnotations) {
+                               fNext = next;
+                               return;
+                       }
+               }
+               fNext = null;
+       }
+
+       /*
+        * @see Iterator#hasNext()
+        */
+       public boolean hasNext() {
+               return fNext != null;
+       }
+
+       /*
+        * @see Iterator#next()
+        */
+       public Object next() {
+               try {
+                       return fNext;
+               } finally {
+                       skip();
+               }
+       }
+
+       /*
+        * @see Iterator#remove()
+        */
+       public void remove() {
+               throw new UnsupportedOperationException();
+       }
+}