Package com.intellij.diagnostic

Class PluginException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

com.intellij.diagnostic.PluginException

All Implemented Interfaces:

java.io.Serializable

public class PluginException
extends java.lang.RuntimeException

Represents an internal error caused by a plugin. It may happen if the plugin's code fails with an exception, or if the plugin violates some contract of IntelliJ Platform. If such exceptions are thrown or logged via Logger.error(Throwable) method and reported to JetBrains by user, they may be automatically attributed to corresponding plugins.

If the problem is caused by a class, use createByClass(java.lang.String, java.lang.Throwable, java.lang.Class<?>) to create an instance. If the problem is caused by an extension, implement PluginAware in its extension class to get the plugin ID.

In order to report problems from code in 'intellij.platform.extensions' module where this class is not accessible, use ExtensionInstantiationException or ExtensionException instead.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
PluginException(java.lang.String message, PluginId pluginId)
PluginException(java.lang.String message, java.lang.Throwable cause, PluginId pluginId)
PluginException(java.lang.Throwable e, PluginId pluginId)

Method Summary

Modifier and Type	Method and Description
static PluginException	createByClass(java.lang.String errorMessage, java.lang.Throwable cause, java.lang.Class<?> pluginClass) Creates an exception caused by a problem in a plugin's code.
static PluginException	createByClass(java.lang.Throwable cause, java.lang.Class<?> pluginClass) Creates an exception caused by a problem in a plugin's code, takes error message from the cause exception.
java.lang.String	getMessage()
PluginId	getPluginId()
static void	logPluginError(Logger logger, java.lang.String errorMessage, java.lang.Throwable cause, java.lang.Class<?> pluginClass) Log an error caused by a problem in a plugin's code.

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

PluginException

public PluginException(java.lang.String message,
                       java.lang.Throwable cause,
                       PluginId pluginId)

PluginException

public PluginException(java.lang.Throwable e,
                       PluginId pluginId)

PluginException

public PluginException(java.lang.String message,
                       PluginId pluginId)

Method Detail

getPluginId

public PluginId getPluginId()

getMessage

public java.lang.String getMessage()

Overrides:

getMessage in class java.lang.Throwable

createByClass

public static PluginException createByClass(java.lang.String errorMessage,
                                            java.lang.Throwable cause,
                                            java.lang.Class<?> pluginClass)

Creates an exception caused by a problem in a plugin's code.

Parameters:

pluginClass - a problematic class which caused the error

createByClass

public static PluginException createByClass(java.lang.Throwable cause,
                                            java.lang.Class<?> pluginClass)

Creates an exception caused by a problem in a plugin's code, takes error message from the cause exception.

Parameters:

pluginClass - a problematic class which caused the error

logPluginError

public static void logPluginError(Logger logger,
                                  java.lang.String errorMessage,
                                  java.lang.Throwable cause,
                                  java.lang.Class<?> pluginClass)

Log an error caused by a problem in a plugin's code.

Parameters:

pluginClass - a problematic class which caused the error