Refactory
[phpeclipse.git] / 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 to log
14  * 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
22         public static final int LEVEL_WARNING = 10;
23
24         public static final int LEVEL_INFO = 20;
25
26         public static final int LEVEL_VERBOSE = 30;
27
28         public static final int LEVEL_DEBUG = 40;
29
30         /**
31          * Places the specified message text into the log. Ignored if the specified
32          * message level is higher than the current filter level.
33          * 
34          * @param message
35          *            the text to add to the log
36          * @param level
37          *            the message priority
38          */
39         public void append(String message, int level);
40
41         /**
42          * Returns the current level used for filtering messages. Any calls to
43          * <code>append</code> with a level greater than this filter value will be
44          * ignored.
45          */
46         public int getFilterLevel();
47 }