- java.lang.Object
-
- java.lang.Throwable
-
- java.lang.Exception
-
- javax.websocket.DecodeException
-
- All Implemented Interfaces:
- Serializable
public class DecodeException extends Exception
A general exception that occurs when trying to decode a custom object from a text or binary message.- Author:
- dannycoward
- See Also:
- Serialized Form
-
-
Constructor Summary
Constructors Constructor and Description DecodeException(ByteBuffer bb, String message)Constructs a DecodedException with the given ByteBuffer that cannot be decoded, and reason why.DecodeException(ByteBuffer bb, String message, Throwable cause)Constructor with the binary data that could not be decoded, and the reason why it failed to be, and the cause.DecodeException(String encodedString, String message)Constructs a DecodedException with the given encoded string that cannot be decoded, and reason why.DecodeException(String encodedString, String message, Throwable cause)Constructor with the text data that could not be decoded, and the reason why it failed to be, and the cause.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method and Description ByteBuffergetBytes()Return the ByteBuffer containing either the whole message, or the partial message, that could not be decoded, ornullif this exception arose from a failure to decode a text message.StringgetText()Return the encoded string that is either the whole message, or the partial message that could not be decoded, ornullif this exception arose from a failure to decode a binary message..-
Methods inherited from class java.lang.Throwable
addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
-
-
-
-
Constructor Detail
-
DecodeException
public DecodeException(ByteBuffer bb, String message, Throwable cause)
Constructor with the binary data that could not be decoded, and the reason why it failed to be, and the cause. The buffer may represent the whole message, or the part of the message most relevant to the decoding error, depending whether the application is using one of the streaming methods or not.- Parameters:
bb- the byte buffer containing the (part of) the message that could not be decoded.message- the reason for the failure.cause- the cause of the error.
-
DecodeException
public DecodeException(String encodedString, String message, Throwable cause)
Constructor with the text data that could not be decoded, and the reason why it failed to be, and the cause. The encoded string may represent the whole message, or the part of the message most relevant to the decoding error, depending whether the application is using one of the streaming methods or not.- Parameters:
encodedString- the string representing the (part of) the message that could not be decoded.message- the reason for the failure.cause- the cause of the error.
-
DecodeException
public DecodeException(ByteBuffer bb, String message)
Constructs a DecodedException with the given ByteBuffer that cannot be decoded, and reason why. The buffer may represent the whole message, or the part of the message most relevant to the decoding error, depending whether the application is using one of the streaming methods or not.- Parameters:
bb- the byte buffer containing the (part of) the message that could not be decoded.message- the reason for the failure.
-
DecodeException
public DecodeException(String encodedString, String message)
Constructs a DecodedException with the given encoded string that cannot be decoded, and reason why. The encoded string may represent the whole message, or the part of the message most relevant to the decoding error, depending whether the application is using one of the streaming methods or not.- Parameters:
encodedString- the string representing the (part of) the message that could not be decoded.message- the reason for the failure.
-
-
Method Detail
-
getBytes
public ByteBuffer getBytes()
Return the ByteBuffer containing either the whole message, or the partial message, that could not be decoded, ornullif this exception arose from a failure to decode a text message.- Returns:
- the binary data not decoded or
nullfor text message failures.
-
getText
public String getText()
Return the encoded string that is either the whole message, or the partial message that could not be decoded, ornullif this exception arose from a failure to decode a binary message..- Returns:
- the text not decoded or
nullfor binary message failures.
-
-
Document created the 11/06/2005, last modified the 18/08/2025
Source of the printed document:https://www.gaudry.be/en/java-api-javaee-rf-javax/websocket/DecodeException.html
The infobrol is a personal site whose content is my sole responsibility. The text is available under CreativeCommons license (BY-NC-SA). More info on the terms of use and the author.
References
These references and links indicate documents consulted during the writing of this page, or which may provide additional information, but the authors of these sources can not be held responsible for the content of this page.
The author of this site is solely responsible for the way in which the various concepts, and the freedoms that are taken with the reference works, are presented here. Remember that you must cross multiple source information to reduce the risk of errors.