/*******************************************************************************
* Copyright (c) 2000, 2005 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.erlide.ui.internal;
import java.io.StringWriter;
import java.lang.reflect.InvocationTargetException;
import org.eclipse.core.runtime.CoreException;
import org.eclipse.core.runtime.IStatus;
import org.eclipse.jface.dialogs.ErrorDialog;
import org.eclipse.jface.dialogs.MessageDialog;
import org.eclipse.swt.widgets.Shell;
import org.erlide.backend.api.BackendException;
import org.erlide.runtime.rpc.RpcException;
import org.erlide.ui.ErlideUIMessages;
import org.erlide.util.ErlLogger;
/**
* The default exception handler shows an error dialog when one of its handle
* methods is called. If the passed exception is a <code>CoreException</code> an
* error dialog pops up showing the exception's status information. For a
* <code>InvocationTargetException</code> a normal message dialog pops up
* showing the exception's message. Additionally the exception is written to the
* platform log.
*/
public class ExceptionHandler {
private static final ExceptionHandler fgInstance = new ExceptionHandler();
/**
* Handles the given <code>CoreException</code>. The workbench shell is used
* as a parent for the dialog window.
*
* @param e
* the <code>CoreException</code> to be handled
* @param title
* the dialog window's window title
* @param message
* message to be displayed by the dialog window
*/
public static void handle(final CoreException e, final String title,
final String message) {
handle(e, ErlideUIPlugin.getActiveWorkbenchShell(), title, message);
}
/**
* Handles the given <code>CoreException</code>.
*
* @param e
* the <code>CoreException</code> to be handled
* @param parent
* the dialog window's parent shell
* @param title
* the dialog window's window title
* @param message
* message to be displayed by the dialog window
*/
public static void handle(final CoreException e, final Shell parent,
final String title, final String message) {
fgInstance.perform(e, parent, title, message);
}
/**
* Handles the given <code>InvocationTargetException</code>. The workbench
* shell is used as a parent for the dialog window.
*
* @param e
* the <code>InvocationTargetException</code> to be handled
* @param title
* the dialog window's window title
* @param message
* message to be displayed by the dialog window
*/
public static void handle(final InvocationTargetException e, final String title,
final String message) {
handle(e, ErlideUIPlugin.getActiveWorkbenchShell(), title, message);
}
/**
* Handles the given <code>InvocationTargetException</code>.
*
* @param e
* the <code>InvocationTargetException</code> to be handled
* @param parent
* the dialog window's parent shell
* @param title
* the dialog window's window title
* @param message
* message to be displayed by the dialog window
*/
public static void handle(final InvocationTargetException e, final Shell parent,
final String title, final String message) {
fgInstance.perform(e, parent, title, message);
}
// ---- Hooks for subclasses to control exception handling
// ------------------------------------
protected void perform(final CoreException e, final Shell shell, final String title,
final String message) {
final IStatus status = e.getStatus();
ErlideUIPlugin.log(e);
if (status != null) {
ErrorDialog.openError(shell, title, message, status);
} else {
displayMessageDialog(e.getMessage(), shell, title, message);
}
}
protected void perform(final InvocationTargetException e, final Shell shell,
final String title, final String message) {
final Throwable target = e.getTargetException();
if (target instanceof CoreException) {
perform((CoreException) target, shell, title, message);
} else {
ErlideUIPlugin.log(e);
if (e.getMessage() != null && e.getMessage().length() > 0) {
displayMessageDialog(e.getMessage(), shell, title, message);
} else {
displayMessageDialog(target.getMessage(), shell, title, message);
}
}
}
protected void perform(final BackendException e, final Shell shell,
final String title, final String message) {
ErlLogger.error(e);
displayMessageDialog(e.getMessage(), shell, title, message);
}
protected void perform(final RpcException e, final Shell shell, final String title,
final String message) {
ErlLogger.error(e);
displayMessageDialog(e.getMessage(), shell, title, message);
}
private void displayMessageDialog(final String exceptionMessage, final Shell shell,
final String title, final String message) {
final StringWriter msg = new StringWriter();
if (message != null) {
msg.write(message);
msg.write("\n\n"); //$NON-NLS-1$
}
if (exceptionMessage == null || exceptionMessage.length() == 0) {
msg.write(ErlideUIMessages.ExceptionHandler_seeErrorLogMessage);
} else {
msg.write(exceptionMessage);
}
MessageDialog.openError(shell, title, msg.toString());
}
public static void handle(final BackendException e, final Shell shell,
final String title, final String message) {
fgInstance.perform(e, shell, title, message);
}
public static void handle(final RpcException e, final Shell shell, final String title,
final String message) {
fgInstance.perform(e, shell, title, message);
}
}