Class ClientException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

cl.netswitch.lib.client.ClientException

All Implemented Interfaces:

Serializable

public class ClientException
extends RuntimeException

Signals that a client error of some kind has occurred. This exception is the superclass of all the other exceptions defined and used in a client.

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
ClientException()	Constructs a new ClientException instance.
ClientException(int errorCode)	Constructs a new ClientException with an error code.
ClientException(int errorCode, Throwable cause)	Constructs a new ClientException with an error code and cause.
ClientException(String message)	Constructs a new ClientException with a message.
ClientException(String message, int errorCode)	Constructs a new ClientException with an error message and error code.
ClientException(String message, int errorCode, Throwable cause)	Constructs a new ClientException with an error message, error code and cause.
ClientException(String message, String userMessage)	Constructs a new ClientException with an error and user message.
ClientException(String message, String userMessage, int errorCode)	Constructs a new ClientException with an error message, user message and error code.
ClientException(String message, String userMessage, int errorCode, Throwable cause)	Constructs a new ClientException with an error message, user message, error code and cause.
ClientException(String message, String userMessage, Throwable cause)	Constructs a new ClientException with an error message, user message and cause.
ClientException(String message, Throwable cause)	Constructs a new ClientException with a message and cause.
ClientException(Throwable cause)	Constructs a new ClientException with a cause.

Method Summary

Modifier and Type	Method	Description
int	getErrorCode()	Returns the error code of this ClientException.
String	getUserMessage()	Returns the user message of this ClientException.
static Message	throwOnError(Message message)	Throws a ClientException if the status of the supplied message is an error.

Methods inherited from class Throwable

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

Methods inherited from class Object

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

Constructor Details

ClientException

public ClientException()

Constructs a new ClientException instance. The user message is initialized to null, and the error code is initialized to zero (0).

ClientException

public ClientException(String message)

Constructs a new ClientException with a message. The user message is initialized to null, and the error code is initialized to zero (0).

Parameters:

message - the error message.

ClientException

public ClientException(Throwable cause)

Constructs a new ClientException with a cause. The user message is initialized to null, and the error code is initialized to zero (0).

Parameters:

cause - the cause of the exception.

ClientException

public ClientException(String message,
 Throwable cause)

Constructs a new ClientException with a message and cause. The user message is initialized to null, and the error code is initialized to zero (0).

Parameters:

message - the error message.

cause - the cause of the exception.

ClientException

public ClientException(int errorCode)

Constructs a new ClientException with an error code. The user message is initialized to null. Error codes are non-negative, so if errorCode is negative, it's absolute (positive) value is saved.

Parameters:

errorCode - the exception error code.

ClientException

public ClientException(String message,
 int errorCode)

Constructs a new ClientException with an error message and error code. The user message is initialized to null. Error codes are non-negative, so if errorCode is negative, it's absolute (positive) value is saved.

Parameters:

message - the error message.

errorCode - the exception error code.

ClientException

public ClientException(int errorCode,
 Throwable cause)

Constructs a new ClientException with an error code and cause. The user message is initialized to null. Error codes are non-negative, so if errorCode is negative, it's absolute (positive) value is saved.

Parameters:

errorCode - the exception error code.

cause - the cause of the exception.

ClientException

public ClientException(String message,
 int errorCode,
 Throwable cause)

Constructs a new ClientException with an error message, error code and cause. The user message is initialized to null. Error codes are non-negative, so if errorCode is negative, it's absolute (positive) value is saved.

Parameters:

message - the error message.

errorCode - the exception error code.

cause - the cause of the exception.

ClientException

public ClientException(String message,
 String userMessage)

Constructs a new ClientException with an error and user message. The error code is initialized to zero (0).

Parameters:

message - the error message.

userMessage - the user message.

ClientException

public ClientException(String message,
 String userMessage,
 Throwable cause)

Constructs a new ClientException with an error message, user message and cause. The error code is initialized to zero (0).

Parameters:

message - the error message.

userMessage - the user message.

cause - the cause of the exception.

ClientException

public ClientException(String message,
 String userMessage,
 int errorCode)

Constructs a new ClientException with an error message, user message and error code. Error codes are non-negative, so if errorCode is negative, it's absolute (positive) value is saved.

Parameters:

message - the error message.

userMessage - the user message.

errorCode - the exception error code.

ClientException

public ClientException(String message,
 String userMessage,
 int errorCode,
 Throwable cause)

Constructs a new ClientException with an error message, user message, error code and cause. Error codes are non-negative, so if errorCode is negative, it's absolute (positive) value is saved.

Parameters:

message - the error message.

userMessage - the user message.

errorCode - the exception error code.

cause - the cause of the exception.

Method Details

getUserMessage

public String getUserMessage()

Returns the user message of this ClientException.

Returns:

the user message or null if none specified.

getErrorCode

public int getErrorCode()

Returns the error code of this ClientException. Error codes are non-negative, so this method always returns a value greater than or equal to zero (0).

Returns:

the error code or zero (0) if none specified.

throwOnError

public static Message throwOnError(Message message)

Throws a ClientException if the status of the supplied message is an error. The ClientException includes the status, text and userMessage of the message. It returns the supplied message if the status is successful.

Parameters:

message - the message to be inspected.

Returns:

the supplied message if successful.

Throws:

ClientException - if message is null.