com.sun.faban.driver
Class FatalException

java.lang.Object
  java.lang.Throwable
      java.lang.Exception
          java.lang.RuntimeException
              com.sun.faban.driver.FatalException

All Implemented Interfaces:

Serializable

public class FatalException
extends RuntimeException

A FatalException, when thrown from any driver code signifies that the run has encountered a fatal error. The driver framework will clean up and terminate the run as a result. Note that the FatalException is a RuntimeException and need not be declared in the method signature.

Author:

Akara Sucharitakul

See Also:

Serialized Form

Constructor Summary

FatalException()
Constructs a new fatal exception with null as its detail message.

FatalException(String message)
Constructs a new fatal exception with the specified detail message.

FatalException(String message, Throwable cause)
Constructs a new fatal exception with the specified detail message and cause.

FatalException(Throwable cause)
Constructs a new fatal 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

void	setLogged() Sets the flag indicating this exception has already been logged.
boolean	wasLogged() Checks whether this exception has already been logged.

Methods inherited from class java.lang.Throwable

fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, 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

FatalException

public FatalException()

Constructs a new fatal 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).

FatalException

public FatalException(String message)

Constructs a new fatal 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.

FatalException

public FatalException(String message,
                      Throwable cause)

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

Note that the detail message associated with cause is not automatically incorporated in this fatal 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.)

FatalException

public FatalException(Throwable cause)

Constructs a new fatal 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 fatal exceptions that are little more than wrappers for other throwables.

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

setLogged

public void setLogged()

Sets the flag indicating this exception has already been logged. This is used to avoid duplicate logging.

wasLogged

public boolean wasLogged()

Checks whether this exception has already been logged.

Returns:

true if this exception was already logged, false otherwise.