Class DPRAException

  • All Implemented Interfaces:
    java.io.Serializable

    public class DPRAException
    extends java.lang.Exception
    Represents an error with a user-friendly message when performing operations in the Insight (new) add-on.
    Since:
    4.2.0
    See Also:
    Serialized Form
    • Constructor Summary

      Constructors 
      Constructor Description
      DPRAException​(com.onwbp.base.text.UserMessage message)
      Constructs a new instance without a cause.
      DPRAException​(com.onwbp.base.text.UserMessage message, java.lang.Throwable cause)
      Constructs a new instance with a cause.
      DPRAException​(java.lang.String message)
      Constructs a new instance without a cause.
      DPRAException​(java.lang.String message, java.lang.Throwable cause)
      Constructs a new instance with a cause.
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.String getMessage()  
      java.lang.String getMessage​(java.util.Locale locale)
      Returns the error message for a locale.
      com.onwbp.base.text.UserMessage getUserMessage()
      Returns the localized error message.
      • 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

        equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
    • Constructor Detail

      • DPRAException

        public DPRAException​(java.lang.String message)
        Constructs a new instance without a cause.
        Parameters:
        message - The error message.
      • DPRAException

        public DPRAException​(java.lang.String message,
                             java.lang.Throwable cause)
        Constructs a new instance with a cause.
        Parameters:
        message - The error message.
        cause - The wrapped error.
      • DPRAException

        public DPRAException​(com.onwbp.base.text.UserMessage message)
        Constructs a new instance without a cause.
        Parameters:
        message - The localized error message.
      • DPRAException

        public DPRAException​(com.onwbp.base.text.UserMessage message,
                             java.lang.Throwable cause)
        Constructs a new instance with a cause.
        Parameters:
        message - The localized error message.
        cause - The wrapped error.
    • Method Detail

      • getUserMessage

        public com.onwbp.base.text.UserMessage getUserMessage()
        Returns the localized error message.
      • getMessage

        public java.lang.String getMessage()
        Overrides:
        getMessage in class java.lang.Throwable
      • getMessage

        public java.lang.String getMessage​(java.util.Locale locale)
        Returns the error message for a locale.