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
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
|
/*******************************************************************************
* Copyright (c) 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.jst.jsp.ui.internal;
import com.ibm.icu.util.StringTokenizer;
import org.eclipse.core.runtime.IStatus;
import org.eclipse.core.runtime.Platform;
import org.eclipse.core.runtime.Status;
import org.osgi.framework.Bundle;
/**
* Small convenience class to log messages to plugin's log file and also, if desired,
* the console. This class should only be used by classes in this plugin. Other
* plugins should make their own copy, with appropriate ID.
*/
public class Logger {
private static final String PLUGIN_ID = "org.eclipse.jst.jsp.ui"; //$NON-NLS-1$
private static final String TRACEFILTER_LOCATION = "/debug/tracefilter"; //$NON-NLS-1$
public static final int OK = IStatus.OK; // 0
public static final int INFO = IStatus.INFO; // 1
public static final int WARNING = IStatus.WARNING; // 2
public static final int ERROR = IStatus.ERROR; // 4
public static final int OK_DEBUG = 200 + OK;
public static final int INFO_DEBUG = 200 + INFO;
public static final int WARNING_DEBUG = 200 + WARNING;
public static final int ERROR_DEBUG = 200 + ERROR;
/**
* Adds message to log.
* @param level severity level of the message (OK, INFO, WARNING, ERROR, OK_DEBUG, INFO_DEBUG, WARNING_DEBUG, ERROR_DEBUG)
* @param message text to add to the log
* @param exception exception thrown
*/
protected static void _log(int level, String message, Throwable exception) {
if (level == OK_DEBUG || level == INFO_DEBUG || level == WARNING_DEBUG || level == ERROR_DEBUG) {
if (!isDebugging())
return;
}
int severity = IStatus.OK;
switch (level) {
case INFO_DEBUG :
case INFO :
severity = IStatus.INFO;
break;
case WARNING_DEBUG :
case WARNING :
severity = IStatus.WARNING;
break;
case ERROR_DEBUG :
case ERROR :
severity = IStatus.ERROR;
}
message = (message != null) ? message : "null"; //$NON-NLS-1$
Status statusObj = new Status(severity, PLUGIN_ID, severity, message, exception);
Bundle bundle = Platform.getBundle(PLUGIN_ID);
if (bundle != null)
Platform.getLog(bundle).log(statusObj);
}
/**
* Prints message to log if category matches /debug/tracefilter option.
* @param message text to print
* @param category category of the message, to be compared with /debug/tracefilter
*/
protected static void _trace(String category, String message, Throwable exception) {
if (isTracing(category)) {
message = (message != null) ? message : "null"; //$NON-NLS-1$
Status statusObj = new Status(IStatus.OK, PLUGIN_ID, IStatus.OK, message, exception);
Bundle bundle = Platform.getBundle(PLUGIN_ID);
if (bundle != null)
Platform.getLog(bundle).log(statusObj);
}
}
/**
* @return true if the platform is debugging
*/
public static boolean isDebugging() {
return Platform.inDebugMode();
}
/**
* Determines if currently tracing a category
* @param category
* @return true if tracing category, false otherwise
*/
public static boolean isTracing(String category) {
if (!isDebugging())
return false;
String traceFilter = Platform.getDebugOption(PLUGIN_ID + TRACEFILTER_LOCATION);
if (traceFilter != null) {
StringTokenizer tokenizer = new StringTokenizer(traceFilter, ","); //$NON-NLS-1$
while (tokenizer.hasMoreTokens()) {
String cat = tokenizer.nextToken().trim();
if (category.equals(cat)) {
return true;
}
}
}
return false;
}
public static void log(int level, String message) {
_log(level, message, null);
}
public static void log(int level, String message, Throwable exception) {
_log(level, message, exception);
}
public static void logException(String message, Throwable exception) {
_log(ERROR, message, exception);
}
public static void logException(Throwable exception) {
_log(ERROR, exception.getMessage(), exception);
}
public static void traceException(String category, String message, Throwable exception) {
_trace(category, message, exception);
}
public static void traceException(String category, Throwable exception) {
_trace(category, exception.getMessage(), exception);
}
public static void trace(String category, String message) {
_trace(category, message, null);
}
}
|