Package co.arago.hiro.client.exceptions

Class WebSocketMessageException

java.lang.Object

java.lang.Throwable

java.lang.Exception

co.arago.hiro.client.exceptions.HiroException

co.arago.hiro.client.exceptions.WebSocketMessageException

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

UnauthorizedWebSocketException

public class WebSocketMessageException
extends HiroException

A base exception for WebSockets. Contains an error code.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
WebSocketMessageException(java.lang.String message, int code)	Constructs a new exception with the specified detail message.
WebSocketMessageException(java.lang.String message, int code, java.lang.Throwable cause)	Constructs a new exception with the specified detail message and cause.
WebSocketMessageException(java.lang.String message, int code, java.lang.Throwable cause, boolean enableSuppression, boolean writableStackTrace)	Constructs a new exception with the specified detail message, cause, suppression enabled or disabled, and writable stack trace enabled or disabled.

Method Summary

Modifier and Type	Method	Description
int	getCode()	get the error code
java.lang.String	toString()

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

WebSocketMessageException

public WebSocketMessageException(java.lang.String message,
                                 int code)

Constructs a new exception with the specified detail message. The cause is not initialized, and may subsequently be initialized by a call to Throwable.initCause(java.lang.Throwable).

Parameters:

message - the detail message. The detail message is saved for later retrieval by the Throwable.getMessage() method.

code - The code for the error (Similar to a HTTP status code).

WebSocketMessageException

public WebSocketMessageException(java.lang.String message,
                                 int code,
                                 java.lang.Throwable cause)

Constructs a new exception with the specified detail message and cause.

Note that the detail message associated with cause is not automatically incorporated in this exception's detail message.

Parameters:

message - the detail message (which is saved for later retrieval by the Throwable.getMessage() method).

code - The code for the error (Similar to a HTTP status code).

cause - the cause (which is saved for later retrieval by the Throwable.getCause() method). (A null value is permitted, and indicates that the cause is nonexistent or unknown.)

Since:

1.4

WebSocketMessageException

public WebSocketMessageException(java.lang.String message,
                                 int code,
                                 java.lang.Throwable cause,
                                 boolean enableSuppression,
                                 boolean writableStackTrace)

Constructs a new exception with the specified detail message, cause, suppression enabled or disabled, and writable stack trace enabled or disabled.

Parameters:

message - the detail message.

code - The code for the error (Similar to a HTTP status code).

cause - the cause. (A null value is permitted, and indicates that the cause is nonexistent or unknown.)

enableSuppression - whether or not suppression is enabled or disabled

writableStackTrace - whether or not the stack trace should be writable

Since:

1.7

Method Detail

getCode

public int getCode()

get the error code

Returns:

The status code

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Throwable