Class BirtException

java.lang.Object
java.lang.Throwable
java.lang.Exception
org.eclipse.birt.core.exception.BirtException
All Implemented Interfaces:
Serializable
Direct Known Subclasses:
CoreException, FrameworkException

public class BirtException extends Exception
Define BIRT's Exception framework. Every BIRT exception has to include an error code, which is a string. Different BIRT modules use different prefix for error codes. For example,
  • DE uses DESIGN_EXCEPTION_
  • DtE uses DATA_EXCEPTION_
  • FPE uses GENERATION_EXCEPTION_ and VIEW_EXCEPTION_
  • UI uses UI_EXCEPTION_
  • Chart used CHART_EXCEPTION_
  • viewer uses VIERER_EXCEPTION_
  • as prefix. An error code is used for retrieving error message, which is externalizable, and can be seen by end users. The error code itself allows the identification of the subcomponent that generates the exception, avoiding the need to create exceltion subclasses such as BirtEngineException, BirtDtEException, etc. Note that the resource key (or error code), message arguments and resource bundle are immutable.
    See Also:
    • Field Details

      • sResourceKey

        protected final String sResourceKey
        The resource key that represents the internal error code used in fetching an externalized message
      • oaMessageArguments

        protected final Object[] oaMessageArguments
        Optional arguments to be used with a resource key to build the error message
      • rb

        protected final transient ResourceBundle rb
        The resource bundle that holds a collection of messages for a specific locale
      • pluginId

        protected String pluginId
        The unique identifier of the plug-in associated with this exception
      • severity

        protected int severity
        The severity of this exception. One of
        • CANCEL
        • ERROR (default value)
        • WARNING
        • INFO
        • or OK (0)
      • OK

        public static final int OK
        Status severity constant (value 0) indicating this exception represents the nominal case. This constant is also used as the status code representing the nominal case.
        See Also:
      • INFO

        public static final int INFO
        Status type severity (bit mask, value 1) indicating this exception is informational only.
        See Also:
      • WARNING

        public static final int WARNING
        Status type severity (bit mask, value 2) indicating this exception represents a warning.
        See Also:
      • ERROR

        public static final int ERROR
        Status type severity (bit mask, value 4) indicating this exception represents an error.
        See Also:
      • CANCEL

        public static final int CANCEL
        Status type severity (bit mask, value 8) indicating this exception represents a cancelation
        See Also:
    • Constructor Details

      • BirtException

        public BirtException(String message)
        Parameters:
        mesage - error message
      • BirtException

        @Deprecated public BirtException(String errorCode, ResourceBundle bundle)
        Deprecated.
        Constructs a new Birt exception with no cause object.
        Parameters:
        errorCode - used to retrieve a piece of externalized message displayed to end user.
        resourceBundle - the resourceBundle used to translate the message.
      • BirtException

        @Deprecated public BirtException(String errorCode, ResourceBundle bundle, Throwable cause)
        Deprecated.
        Parameters:
        errorCode - used to retrieve a piece of externalized message displayed to end user.
        resourceBundle - the resourceBundle used to translate the message.
        cause - the nested exception
      • BirtException

        @Deprecated public BirtException(String errorCode, Object[] args, ResourceBundle bundle, Throwable cause)
        Deprecated.
        Parameters:
        errorCode - used to retrieve a piece of externalized message displayed to end user.
        resourceBundle - the resourceBundle used to translate the message.
        args - string arguments used to format error messages
      • BirtException

        @Deprecated public BirtException(String errorCode, Object arg0, ResourceBundle bundle, Throwable cause)
        Deprecated.
        Parameters:
        errorCode - used to retrieve a piece of externalized message displayed to end user.
        resourceBundle - the resourceBundle used to translate the message.
        cause - the nested exception
        arg0 - first argument used to format error messages
      • BirtException

        @Deprecated public BirtException(String errorCode, Object[] args, ResourceBundle bundle)
        Deprecated.
        Parameters:
        errorCode - used to retrieve a piece of externalized message displayed to end user.
        resourceBundle - the resourceBundle used to translate the message.
        args - string arguments used to format error messages
      • BirtException

        @Deprecated public BirtException(String errorCode, Object arg0, ResourceBundle bundle)
        Deprecated.
        Parameters:
        errorCode - used to retrieve a piece of externalized message displayed to end user.
        resourceBundle - the resourceBundle used to translate the message.
        cause - the nested exception
        arg0 - first argument used to format error messages
      • BirtException

        @Deprecated public BirtException(String errorCode, Object arg0)
        Deprecated.
        Parameters:
        errorCode - used to retrieve a piece of externalized message displayed to end user.
        arg0 - first argument used to format error messages
      • BirtException

        @Deprecated public BirtException(String errorCode, Object[] args, Throwable cause)
        Deprecated.
        Parameters:
        errorCode - used to retrieve a piece of externalized message displayed to end user.
        cause - the nested exception
        args - string arguments used to format error messages
      • BirtException

        public BirtException(String pluginId, String errorCode, ResourceBundle bundle)
        Constructs a new Birt exception with no cause object.
        Parameters:
        pluginId - Returns the unique identifier of the plug-in associated with this exception *
        errorCode - used to retrieve a piece of externalized message displayed to end user.
        resourceBundle - the resourceBundle used to translate the message.
      • BirtException

        public BirtException()
      • BirtException

        public BirtException(String pluginId, String errorCode, ResourceBundle bundle, Throwable cause)
        Parameters:
        pluginId - Returns the unique identifier of the plug-in associated with this exception
        errorCode - used to retrieve a piece of externalized message displayed to end user.
        resourceBundle - the resourceBundle used to translate the message.
        cause - the nested exception
      • BirtException

        public BirtException(String pluginId, String errorCode, Object[] args, ResourceBundle bundle, Throwable cause)
        Parameters:
        pluginId - Returns the unique identifier of the plug-in associated with this exception
        errorCode - used to retrieve a piece of externalized message displayed to end user.
        resourceBundle - the resourceBundle used to translate the message.
        args - string arguments used to format error messages
      • BirtException

        public BirtException(String pluginId, String errorCode, Object arg0, ResourceBundle bundle, Throwable cause)
        Parameters:
        pluginId - Returns the unique identifier of the plug-in associated with this exception
        errorCode - used to retrieve a piece of externalized message displayed to end user.
        resourceBundle - the resourceBundle used to translate the message.
        cause - the nested exception
        arg0 - first argument used to format error messages
      • BirtException

        public BirtException(String pluginId, String errorCode, Object[] args, ResourceBundle bundle)
        Parameters:
        pluginId - Returns the unique identifier of the plug-in associated with this exception
        errorCode - used to retrieve a piece of externalized message displayed to end user.
        resourceBundle - the resourceBundle used to translate the message.
        args - string arguments used to format error messages
      • BirtException

        public BirtException(String pluginId, String errorCode, Object arg0, ResourceBundle bundle)
        Parameters:
        pluginId - Returns the unique identifier of the plug-in associated with this exception
        errorCode - used to retrieve a piece of externalized message displayed to end user.
        resourceBundle - the resourceBundle used to translate the message.
        cause - the nested exception
        arg0 - first argument used to format error messages
      • BirtException

        public BirtException(String pluginId, String errorCode, Object arg0)
        Parameters:
        pluginId - Returns the unique identifier of the plug-in associated with this exception
        severity -
        errorCode - used to retrieve a piece of externalized message displayed to end user.
        arg0 - first argument used to format error messages
      • BirtException

        public BirtException(String pluginId, String errorCode, Object[] args, Throwable cause)
        Parameters:
        errorCode - used to retrieve a piece of externalized message displayed to end user.
        cause - the nested exception
        args - string arguments used to format error messages
    • Method Details

      • getErrorCode

        public String getErrorCode()
        Returns:
        Returns the errorCode.
      • getLocalizedMessage

        public String getLocalizedMessage()
        Overrides:
        getLocalizedMessage in class Throwable
      • getMessage

        public String getMessage()
        Overrides:
        getMessage in class Throwable
      • getLocalizedMessage

        protected String getLocalizedMessage(String errorCode)
        Returns a localized message based on an error code. Overwrite this method if you do not want to pass in the resource bundle
        Parameters:
        errorCode - the error code
        Returns:
        Localized display message.
      • getPluginId

        public String getPluginId()
        Returns the unique identifier of the plug-in associated with this exception (this is the plug-in that defines the meaning of the error code).
        Returns:
        the unique identifier of the relevant plug-in
      • getSeverity

        public int getSeverity()
        Returns the severity. The severities are as follows (in descending order):
        • CANCEL- cancelation occurred
        • ERROR- a serious error (most severe)
        • WARNING- a warning (less severe)
        • INFO- an informational ("fyi") message (least severe)
        • OK- everything is just fine
        Returns:
        the severity: one of OK,ERROR, INFO,WARNING, or CANCEL
      • setSeverity

        public void setSeverity(int severity)
        Sets the severity of the exception.
        Parameters:
        severity - the severity; one of OK,ERROR, INFO,WARNING, or CANCEL