1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
|
/*******************************************************************************
* Copyright (c) 2001, 2004 IBM Corporation and others.
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Eclipse Public License v1.0
* which accompanies this distribution, and is available at
* http://www.eclipse.org/legal/epl-v10.html
*
* Contributors:
* IBM Corporation - initial API and implementation
*******************************************************************************/
package org.eclipse.wst.command.internal.provisional.env.core.common;
import org.eclipse.core.runtime.IStatus;
/**
* Log objects provide a means for logging information for FFDC etc.
*/
public interface Log
{
public static final int OK = 0;
public static final int INFO = 1;
public static final int WARNING = 2;
public static final int ERROR = 4;
/**
* Returns true if logging is enabled.
* There is no requirement to call this method before attempting
* a call to one of the <code>log</code> methods, as they will
* quietly do nothing if logging is disabled. This method can be
* useful, however, anywhere the cost of building up the parameters
* to a log method might be high and best avoided except when logging
* is enabled.
* @return True if logging is enabled, and false otherwise.
*/
public boolean isEnabled ();
/**
* Returns true if the the debug option is set to true.
*/
public boolean isEnabled (String option);
/**
* Logs a <code>Throwable</code>.
* @param severity The severity of the logging entry.
* @param messageNum The message number.
* @param caller The object (for non-static methods) or class (for
* static methods) doing the logging.
* @param method The simple name of the method doing the loging.
* @param throwable The Throwable to log.
*/
public void log ( int severity, int messageNum, Object caller, String method, Throwable throwable );
/**
* Logs a <code>Throwable</code>.
* @param severity The severity of the logging entry.
* @param debug option
* @param messageNum The message number.
* @param caller The object (for non-static methods) or class (for
* static methods) doing the logging.
* @param method The simple name of the method doing the loging.
* @param throwable The Throwable to log.
*/
public void log ( int severity, String option, int messageNum, Object caller, String method, Throwable throwable );
/**
* Logs a <code>Status</code>.
* @param severity The severity of the logging entry.
* @param messageNum The message number.
* @param caller The object (for non-static methods) or class (for
* static methods) doing the logging.
* @param method The simple name of the method doing the loging.
* @param status The Status to log.
*/
public void log ( int severity, int messageNum, Object caller, String method, IStatus status );
/**
* Logs a <code>Status</code>.
* @param severity The severity of the logging entry.
* @param debug option
* @param messageNum The message number.
* @param caller The object (for non-static methods) or class (for
* static methods) doing the logging.
* @param method The simple name of the method doing the loging.
* @param status The Status to log.
*/
public void log ( int severity, String option, int messageNum, Object caller, String method, IStatus status );
/**
* Logs an <code>Object</code>.
* @param severity The severity of the logging entry.
* @param messageNum The message number.
* @param caller The object (for non-static methods) or class (for
* static methods) doing the logging.
* @param method The simple name of the method doing the loging.
* @param object The Object to log.
*/
public void log ( int severity, int messageNum, Object caller, String method, Object object );
/**
* Logs an <code>Object</code>.
* @param severity The severity of the logging entry.
* @param debug option
* @param messageNum The message number.
* @param caller The object (for non-static methods) or class (for
* static methods) doing the logging.
* @param method The simple name of the method doing the loging.
* @param object The Object to log.
*/
public void log ( int severity, String option, int messageNum, Object caller, String method, Object object );
}
|
