org.eclipse.core.runtime

Class CoreException

java.lang.Object

java.lang.Throwable

java.lang.Exception

org.eclipse.core.runtime.CoreException

All Implemented Interfaces:

java.io.Serializable

public class CoreException
extends java.lang.Exception

A checked exception representing a failure.

Core exceptions contain a status object describing the cause of the exception.

This class can be used without OSGi running.

See Also:

IStatus, Serialized Form

Constructor Summary

Constructors

Constructor and Description
CoreException(IStatus status) Creates a new exception with the given status object.

Method Summary

Modifier and Type	Method and Description
java.lang.Throwable	getCause() Returns the cause of this exception, or null if none.
IStatus	getStatus() Returns the status object for this exception.
void	printStackTrace() Prints a stack trace out for the exception, and any nested exception that it may have embedded in its Status object.
void	printStackTrace(java.io.PrintStream output) Prints a stack trace out for the exception, and any nested exception that it may have embedded in its Status object.
void	printStackTrace(java.io.PrintWriter output) Prints a stack trace out for the exception, and any nested exception that it may have embedded in its Status object.

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, setStackTrace, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

CoreException

public CoreException(IStatus status)

Creates a new exception with the given status object. The message of the given status is used as the exception message.

Parameters:

status - the status object to be associated with this exception

Method Detail

getCause

public java.lang.Throwable getCause()

Returns the cause of this exception, or null if none.

Overrides:

getCause in class java.lang.Throwable

Returns:

the cause for this exception

Since:

3.4

getStatus

public final IStatus getStatus()

Returns the status object for this exception.

IMPORTANT:
The result must NOT be used for logging, error reporting, or as a method return value, since that code pattern hides the original stack trace. Instead, create a new Status with your plug-in ID and this CoreException, and use that new status for error reporting or as a method return value. For example, instead of:

      yourPlugin.getLog().log(exception.getStatus());
   

Use:

      IStatus result = new Status(exception.getStatus().getSeverity(), pluginId, message, exception);
      yourPlugin.getLog().log(result);
   

Returns:

a status object

printStackTrace

public void printStackTrace()

Prints a stack trace out for the exception, and any nested exception that it may have embedded in its Status object.

Overrides:

printStackTrace in class java.lang.Throwable

printStackTrace

public void printStackTrace(java.io.PrintStream output)

Prints a stack trace out for the exception, and any nested exception that it may have embedded in its Status object.

Overrides:

printStackTrace in class java.lang.Throwable

Parameters:

output - the stream to write to

printStackTrace

public void printStackTrace(java.io.PrintWriter output)

Prints a stack trace out for the exception, and any nested exception that it may have embedded in its Status object.

Overrides:

printStackTrace in class java.lang.Throwable

Parameters:

output - the stream to write to