5f3fff2b8c986966a4e617a68ac5da868350c711
[phpeclipse.git] / net.sourceforge.phpeclipse / src / net / sourceforge / phpdt / core / IProblemRequestor.java
1 /*******************************************************************************
2  * Copyright (c) 2002 International Business Machines Corp. and others.
3  * All rights reserved. This program and the accompanying materials 
4  * are made available under the terms of the Common Public License v0.5 
5  * which accompanies this distribution, and is available at
6  * http://www.eclipse.org/legal/cpl-v05.html
7  * 
8  * Contributors:
9  *     IBM Corporation - initial API and implementation
10  ******************************************************************************/
11 package net.sourceforge.phpdt.core;
12
13 import net.sourceforge.phpdt.core.compiler.IProblem;
14
15 /**
16  * A callback interface for receiving java problem as they are discovered
17  * by some Java operation.
18  * 
19  * @see IProblem
20  * @since 2.0
21  */
22 public interface IProblemRequestor {
23         
24         /**
25          * Notification of a Java problem.
26          * 
27          * @param problem IProblem - The discovered Java problem.
28          */     
29         void acceptProblem(IProblem problem);
30
31         /**
32          * Notification sent before starting the problem detection process.
33          * Typically, this would tell a problem collector to clear previously recorded problems.
34          */
35         void beginReporting();
36
37         /**
38          * Notification sent after having completed problem detection process.
39          * Typically, this would tell a problem collector that no more problems should be expected in this
40          * iteration.
41          */
42         void endReporting();
43
44         /**
45          * Predicate allowing the problem requestor to signal whether or not it is currently
46          * interested by problem reports. When answering <code>false</false>, problem will
47          * not be discovered any more until the next iteration.
48          * 
49          * This  predicate will be invoked once prior to each problem detection iteration.
50          * 
51          * @return boolean - indicates whether the requestor is currently interested by problems.
52          */
53         boolean isActive();
54 }