net.sourceforge.phpeclipse.externaltools/src/net/sourceforge/phpdt/externaltools/model/IRunnerLog.java

   1 package net.sourceforge.phpdt.externaltools.model;
   2
   3 /**********************************************************************
   4 Copyright (c) 2002 IBM Corp. and others. All rights reserved.
   5 This file is made available under the terms of the Common Public License v1.0
   6 which accompanies this distribution, and is available at
   7 http://www.eclipse.org/legal/cpl-v10.html
   8
   9 Contributors:
  10 **********************************************************************/
  11
  12 /**
  13  * Provides an API for <code>IExternalToolRunner</code> implementors
  14  * to log messages captured from the running tool's output.
  15  * <p>
  16  * This interface is not be extended nor implemented by clients.
  17  * </p>
  18  */
  19 public interface IRunnerLog {
  20         public static final int LEVEL_ERROR = 0;
  21         public static final int LEVEL_WARNING = 10;
  22         public static final int LEVEL_INFO = 20;
  23         public static final int LEVEL_VERBOSE = 30;
  24         public static final int LEVEL_DEBUG = 40;
  25
  26         /**
  27          * Places the specified message text into the log. Ignored
  28          * if the specified message level is higher than the
  29          * current filter level.
  30          *
  31          * @param message the text to add to the log
  32          * @param level the message priority
  33          */
  34         public void append(String message, int level);
  35
  36         /**
  37          * Returns the current level used for filtering
  38          * messages. Any calls to <code>append</code> with
  39          * a level greater than this filter value will be
  40          * ignored.
  41          */
  42         public int getFilterLevel();
  43 }