Class BackendException

  • All Implemented Interfaces:
    java.io.Serializable

    public final class BackendException
    extends java.lang.Exception
    A subclass of Exception that encapsulates the reasons for a failure originating in implementations of Backend.
    See Also:
    Serialized Form
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.Object[] getFormat()
      Get the format string values associated with the instance.
      BackendException.Reason getReason()
      Get the reason for this exception.
      • Methods inherited from class java.lang.Throwable

        addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, 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

      • BackendException

        public BackendException​(BackendException.Reason reason,
                                java.lang.Object... format)
        Public constructor for BackendException.
        Parameters:
        reason - The BackendException.Reason which caused this exception to be thrown
        format - Format string values used when converting exceptions to user-facing strings.
    • Method Detail

      • getFormat

        public java.lang.Object[] getFormat()
        Get the format string values associated with the instance.
        Returns:
        Array of Object for string formatting purposes