Package com.insightful.splusserver.exception.api

Class ApiException

  • All Implemented Interfaces:
    java.io.Serializable
    Direct Known Subclasses:
    ServerCreationException
    public class ApiException
extends BaseException
    This class represents exceptions thrown by the Java Api. It might embed another exception.
    Author:
    TIBCO
    See Also:
    Serialized Form

    • Constructor Summary

      Constructors 
      Constructor Description
      ApiException()
      Constructs an ApiException object, which contains information about API exceptions.
      ApiException​(BridgeException exception)
      Constructs an ApiException object that embeds another exception.
      ApiException​(java.lang.String message)
      Constructs an ApiException object, which captures a string containing information about the exception.
      ApiException​(java.lang.String message, java.lang.Throwable exception)
      Constructs an ApiException object that contains an embedded exception, and which captures a string containing information about the exception.
      ApiException​(java.lang.Throwable exception)
      Constructs an ApiException object that embeds another exception.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.String getXml()
      Returning XML representation representing the exception.
      int ordinal()
      Returning id of exception to facilitate unmarshaling XML representation back into Java object

      • 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

      • ApiException

        public ApiException()
        Constructs an ApiException object, which contains information about API exceptions.

      • ApiException

        public ApiException​(java.lang.String message)
        Constructs an ApiException object, which captures a string containing information about the exception.
        Parameters:
        message - A string containing information about the exception.

      • ApiException

        public ApiException​(java.lang.Throwable exception)
        Constructs an ApiException object that embeds another exception.
        Parameters:
        exception - The embedded exception.

      • ApiException

        public ApiException​(java.lang.String message,
                    java.lang.Throwable exception)
        Constructs an ApiException object that contains an embedded exception, and which captures a string containing information about the exception.
        Parameters:
        message - A string containing information about the exception.
        exception - The embedded exception.

      • ApiException

        public ApiException​(BridgeException exception)
        Constructs an ApiException object that embeds another exception.
        Parameters:
        exception - The embedded exception.

    • Method Detail

      • ordinal

        public int ordinal()
        Returning id of exception to facilitate unmarshaling XML representation back into Java object
        Specified by:
        ordinal in class BaseException
        Returns:
        Id of exception as int

      • getXml

        public java.lang.String getXml()
        Returning XML representation representing the exception.
        Overrides:
        getXml in class BaseException
        Returns:
        XML representation of exception as a String