net.sourceforge.phpeclipse/src/net/sourceforge/phpdt/core/IProblemRequestor.java

   1 /*******************************************************************************
   2  * Copyright (c) 2000, 2003 IBM Corporation and others.
   3  * All rights reserved. This program and the accompanying materials
   4  * are made available under the terms of the Common Public License v1.0
   5  * which accompanies this distribution, and is available at
   6  * http://www.eclipse.org/legal/cpl-v10.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 by
  17  * 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
  28          *            IProblem - The discovered Java problem.
  29          */
  30         void acceptProblem(IProblem problem);
  31
  32         /**
  33          * Notification sent before starting the problem detection process.
  34          * Typically, this would tell a problem collector to clear previously
  35          * recorded problems.
  36          */
  37         void beginReporting();
  38
  39         /**
  40          * Notification sent after having completed problem detection process.
  41          * Typically, this would tell a problem collector that no more problems
  42          * should be expected in this iteration.
  43          */
  44         void endReporting();
  45
  46         /**
  47          * Predicate allowing the problem requestor to signal whether or not it is
  48          * currently interested by problem reports. When answering
  49          * <code>false</false>, problem will
  50          * not be discovered any more until the next iteration.
  51          *
  52          * This  predicate will be invoked once prior to each problem detection iteration.
  53          *
  54          * @return boolean - indicates whether the requestor is currently interested by problems.
  55          */
  56         boolean isActive();
  57 }