Class EBaseException

    • Field Summary

      Fields 
      Modifier and Type Field Description
      java.lang.Object[] mParams
      Parameters to the exception error message.
    • Constructor Summary

      Constructors 
      Constructor Description
      EBaseException​(java.lang.Exception cause)
      Constructs an instance of this exception given the cause exception.
      EBaseException​(java.lang.String msgFormat)
      Constructs an instance of this exception with the given resource key.
      EBaseException​(java.lang.String msgFormat, java.lang.Object[] params)
      Constructs an instance of this exception given the resource key and an array of parameters.
      EBaseException​(java.lang.String msgFormat, java.lang.Object[] params, java.lang.Exception cause)
      Constructs an instance of this exception given the resource key, an array of parameters, and the cause exception.
      EBaseException​(java.lang.String msgFormat, java.lang.Throwable cause)
      Constructs an instance of this exception given the resource key and the cause exception.
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      protected java.lang.String getBundleName()
      Returns the given resource bundle name.
      java.lang.Object[] getParameters()
      Returns the list of parameters.
      java.lang.String toString()
      Returns the exception string in the default locale.
      java.lang.String toString​(java.util.Locale locale)
      Returns the exception string in the given locale.
      • Methods inherited from class java.lang.Throwable

        addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
    • Field Detail

      • mParams

        public java.lang.Object[] mParams
        Parameters to the exception error message.
    • Constructor Detail

      • EBaseException

        public EBaseException​(java.lang.String msgFormat)
        Constructs an instance of this exception with the given resource key. If resource key is not found in the resource bundle, the resource key specified is used as the error message.
         new EBaseException(BaseResources.PERMISSION_DENIED);
         new EBaseException("An plain error message");
         

        Parameters:
        msgFormat - The error message resource key.
      • EBaseException

        public EBaseException​(java.lang.String msgFormat,
                              java.lang.Throwable cause)
        Constructs an instance of this exception given the resource key and the cause exception.
             try {
                 ...
             } catch (IOExeption e) {
                 throw new EBaseException(BaseResources.INTERNAL_ERROR_1, e);
             }
         
        Parameters:
        msgFormat - The resource key
        cause - The cause exception
      • EBaseException

        public EBaseException​(java.lang.String msgFormat,
                              java.lang.Object[] params)
        Constructs an instance of this exception given the resource key and an array of parameters.

        Parameters:
        msgFormat - The resource key
        params - Array of params
      • EBaseException

        public EBaseException​(java.lang.String msgFormat,
                              java.lang.Object[] params,
                              java.lang.Exception cause)
        Constructs an instance of this exception given the resource key, an array of parameters, and the cause exception.

        Parameters:
        msgFormat - The resource key
        params - Array of params
        cause - The cause exception
      • EBaseException

        public EBaseException​(java.lang.Exception cause)
        Constructs an instance of this exception given the cause exception.
             try {
                 ...
             } catch (IOExeption e) {
                 throw new EBaseException(e);
             }
         
        Parameters:
        cause - The cause exception
    • Method Detail

      • getParameters

        public java.lang.Object[] getParameters()
        Returns the list of parameters.

        Returns:
        List of parameters.
      • toString

        public java.lang.String toString()
        Returns the exception string in the default locale.

        Overrides:
        toString in class java.lang.Throwable
        Returns:
        The exception string in the default locale.
      • toString

        public java.lang.String toString​(java.util.Locale locale)
        Returns the exception string in the given locale.

        Parameters:
        locale - The locale
        Returns:
        The exception string in the given locale.
      • getBundleName

        protected java.lang.String getBundleName()
        Returns the given resource bundle name.
        Returns:
        the name of the resource bundle for this class.