Package jakarta.websocket

Class EncodeException

  • All Implemented Interfaces:
    java.io.Serializable
    public class EncodeException
extends java.lang.Exception
    A general exception that occurs when trying to encode a custom object to a string or binary message.
    Author:
    dannycoward
    See Also:
    Serialized Form

    • Constructor Summary

      Constructors 
      Constructor Description
      EncodeException​(java.lang.Object object, java.lang.String message)
      Constructor with the object being encoded, and the reason why it failed to be.
      EncodeException​(java.lang.Object object, java.lang.String message, java.lang.Throwable cause)
      Constructor with the object being encoded, and the reason why it failed to be, and the cause.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.Object getObject()
      Return the Object that could not be encoded.

      • 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

      • EncodeException

        public EncodeException​(java.lang.Object object,
                       java.lang.String message)
        Constructor with the object being encoded, and the reason why it failed to be.
        Parameters:
        object - the object that could not be encoded.
        message - the reason for the failure.

      • EncodeException

        public EncodeException​(java.lang.Object object,
                       java.lang.String message,
                       java.lang.Throwable cause)
        Constructor with the object being encoded, and the reason why it failed to be, and the cause.
        Parameters:
        object - the object that could not be encoded.
        message - the reason for the failure.
        cause - the cause of the problem.

    • Method Detail

      • getObject

        public java.lang.Object getObject()
        Return the Object that could not be encoded.
        Returns:
        the object.