com.sun.faban.driver
Class ExpectedException

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

All Implemented Interfaces:

Serializable

public class ExpectedException
extends RuntimeException

An ExpectedException, signifies an exception condition which is expected. Such conditions are only logged at the FINER level in order not to clutter up the logs too much. The operation throwing the exception is still considered as a failed operation and will count towards those failed operation count.

Author:

Akara Sucharitakul

See Also:

Serialized Form

Constructor Summary

ExpectedException()
Constructs a new expected exception with null as its detail message.

ExpectedException(String message)
Constructs a new expected exception with the specified detail message.

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

ExpectedException(Throwable cause)
Constructs a new expected 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

ExpectedException

public ExpectedException()

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

ExpectedException

public ExpectedException(String message)

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

ExpectedException

public ExpectedException(String message,
                         Throwable cause)

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

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

ExpectedException

public ExpectedException(Throwable cause)

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