javax.websocket

Class DecodeException

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.

Since:

DRAFT 002

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 data being 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 data being decoded, and the reason why it failed to be, and the cause.

Method Summary

Methods

Modifier and Type	Method and Description
ByteBuffer	getBytes() Return the ByteBuffer that cannot be decoded.
String	getText() Return the encoded string that cannot be decoded.

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

DecodeException

public DecodeException(ByteBuffer bb,
               String message,
               Throwable cause)

Constructor with the data being decoded, and the reason why it failed to be, and the cause. The buffer may represent the whole message, or part of the message, depending whether the application is using one of the streaming methods or not.

Parameters:

bb - the byte buffer with the data 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 data being decoded, and the reason why it failed to be, and the cause. The encoded string may represent the whole message, or part of the message, depending whether the application is using one of the streaming methods or not.

Parameters:

encodedString - the string 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 part of the message, depending whether the application is using one of the streaming methods or not.

Parameters:

bb - the byte buffer with the data that could not be decoded

message - TODO

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 part of the message, depending whether the application is using one of the streaming methods or not.

Parameters:

encodedString - TODO

message - the reason for the failure

Method Detail

getBytes

public ByteBuffer getBytes()

Return the ByteBuffer that cannot be decoded.

Returns:

the data not decoded.

getText

public String getText()

Return the encoded string that cannot be decoded.

Returns:

the text not decoded.