com.tplan.robot.remoteclient

Class RemoteClientRuntimeException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

com.tplan.robot.remoteclient.RemoteClientRuntimeException

All Implemented Interfaces:

Serializable

public class RemoteClientRuntimeException
extends RuntimeException

Exception to be thrown by desktop clients on standard error situations. When such an exception is thrown, users are typically shown just the exception message. Any other exceptions are considered to be unexpected or internal and they are usually reported to the user in a different manner and with the full stack trace. Desktop clients should take advantage of this class to report standard error situations, such as trying to connect to a server which is not responding, missing password etc.

See Also:

Serialized Form

T-Plan Robot Enterprise, (C) 2009-2022 T-Plan Limited. All rights reserved.

Constructor Summary

Constructors

Constructor and Description
RemoteClientRuntimeException() Constructs a new exception with null as its detail message.
RemoteClientRuntimeException(String message) Constructs a new exception with the specified detail message.
RemoteClientRuntimeException(String message, String htmlMessage) 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).
RemoteClientRuntimeException(String message, Throwable cause) Constructs a new exception with the specified detail message and cause.
RemoteClientRuntimeException(Throwable cause) Constructs a new exception with the specified cause and a detail message of (cause==null ? null : cause.toString()) (which typically contains the class and detail message of cause).

Method Summary

Modifier and Type	Method and Description
String	getHtmlMessage() Get the HTML error message.
void	setHtmlMessage(String htmlMessage) Set the HTML version of the exception message.

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

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

RemoteClientRuntimeException

public RemoteClientRuntimeException()

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

RemoteClientRuntimeException

public RemoteClientRuntimeException(String message)

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.

RemoteClientRuntimeException

public RemoteClientRuntimeException(String message,
                                    String htmlMessage)

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.

htmlMessage - the message in HTML format.

RemoteClientRuntimeException

public RemoteClientRuntimeException(String message,
                                    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).

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.)

RemoteClientRuntimeException

public RemoteClientRuntimeException(Throwable cause)

Constructs a new exception with the specified cause and a detail message of (cause==null ? null : cause.toString()) (which typically contains the class and detail message of cause). This constructor is useful for exceptions that are little more than wrappers for other throwables (for example, PrivilegedActionException).

Parameters:

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.)

Method Detail

getHtmlMessage

public String getHtmlMessage()

Get the HTML error message. It is a chunk of HTML code without the document and body tags.

Returns:

the HTML version of the exception message.

setHtmlMessage

public void setHtmlMessage(String htmlMessage)

Set the HTML version of the exception message. It should be a chunk of HTML code without the document and body tags.

Parameters:

htmlMessage - the HTML version of the exception message.