Class VirtualViewerAPIException

  • All Implemented Interfaces:
    java.io.Serializable

    public class VirtualViewerAPIException
    extends java.lang.Exception
    Exception base class for exceptions thrown by a content handler API method. All VirtualViewerAPIExceptions will be logged, propagated to the client, and their message shown to the user in the form of an immediate alert.
    See Also:
    Serialized Form
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.String getUserAppropriateMessage()  
      • 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

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

      • VirtualViewerAPIException

        public VirtualViewerAPIException​(java.lang.Exception cause)
        Parameters:
        cause - original causal exception
      • VirtualViewerAPIException

        public VirtualViewerAPIException​(java.lang.String message,
                                         java.lang.Exception cause)
        Parameters:
        message - The message to be displayed to the user
        cause - original causal exception
      • VirtualViewerAPIException

        public VirtualViewerAPIException​(java.lang.String message)
        Parameters:
        message - The message to be displayed to the user
    • Method Detail

      • getUserAppropriateMessage

        public java.lang.String getUserAppropriateMessage()