Changes:

[phpeclipse.git] / net.sourceforge.phpeclipse / src / net / sourceforge / phpdt / core / IProblemRequestor.java

diff --git a/net.sourceforge.phpeclipse/src/net/sourceforge/phpdt/core/IProblemRequestor.java b/net.sourceforge.phpeclipse/src/net/sourceforge/phpdt/core/IProblemRequestor.java
new file mode 100644 (file)
index 0000000..5f2e487
--- /dev/null
+++ b/net.sourceforge.phpeclipse/src/net/sourceforge/phpdt/core/IProblemRequestor.java
@@ -0,0 +1,55 @@
+/*******************************************************************************
+ * 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.phpdt.core;
+
+import net.sourceforge.phpdt.core.compiler.IProblem;
+
+
+/**
+ * A callback interface for receiving java problem as they are discovered
+ * by some Java operation.
+ * 
+ * @see IProblem
+ * @since 2.0
+ */
+public interface IProblemRequestor {
+       
+       /**
+        * Notification of a Java problem.
+        * 
+        * @param problem IProblem - The discovered Java problem.
+        */     
+       void acceptProblem(IProblem problem);
+
+       /**
+        * Notification sent before starting the problem detection process.
+        * Typically, this would tell a problem collector to clear previously recorded problems.
+        */
+       void beginReporting();
+
+       /**
+        * Notification sent after having completed problem detection process.
+        * Typically, this would tell a problem collector that no more problems should be expected in this
+        * iteration.
+        */
+       void endReporting();
+
+       /**
+        * Predicate allowing the problem requestor to signal whether or not it is currently
+        * interested by problem reports. When answering <code>false</false>, problem will
+        * not be discovered any more until the next iteration.
+        * 
+        * This  predicate will be invoked once prior to each problem detection iteration.
+        * 
+        * @return boolean - indicates whether the requestor is currently interested by problems.
+        */
+       boolean isActive();
+}