info.textgrid.lab.core.swtutils

Class LogUtil

java.lang.Object

info.textgrid.lab.core.swtutils.LogUtil

public class LogUtil
extends Object

A small tool helping to log to the Eclipse log file. Instantiate with the plugin id and then call any of the log*(...) method. As a convenience, this will also return the created status object.

Constructor Summary

Constructors

Constructor and Description
LogUtil(String pluginId)

Method Summary

Modifier and Type	Method and Description
String	getPluginId()
int	getStyle()
IStatus	log(int severity, String message, Object... arguments)
IStatus	log(int severity, Throwable cause, String message, Object... arguments) Creates and handles a status object.
IStatus	logError(String message, Object... arguments)
IStatus	logError(Throwable e)
IStatus	logError(Throwable e, String message, Object... arguments)
void	setStyle(int style)
IStatus	trace(String message, Object... arguments)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

LogUtil

public LogUtil(String pluginId)

Method Detail

getStyle

public int getStyle()

setStyle

public void setStyle(int style)

getPluginId

public String getPluginId()

log

public IStatus log(int severity,
                   Throwable cause,
                   String message,
                   Object... arguments)

Creates and handles a status object.

Parameters:

severity - the severity of the error. This is one of IStatus' severity constants, see IStatus.getSeverity().

cause - an exception that has caused the problem. May be null if message is not null. If this is a CoreException, the method will generate a MultiStatus containing the nested status object and the severity argument will be ignored.

message - a message describing the problem to log. This may contain patterns as described for MessageFormat.format(String, Object...). It may be null if a cause has been given.

arguments - optional arguments that get merged into the message as described at MessageFormat.format(String, Object...).

Returns:

the status object that has been created and logged.

logError

public IStatus logError(Throwable e,
                        String message,
                        Object... arguments)

logError

public IStatus logError(Throwable e)

log

public IStatus log(int severity,
                   String message,
                   Object... arguments)

logError

public IStatus logError(String message,
                        Object... arguments)

trace

public IStatus trace(String message,
                     Object... arguments)