IBM Rational Functional Tester
Version 8.1.1000
IBM Rational Functional Tester API Reference

Project Version 2.3

com.rational.test.ft
Class RationalTestError

java.lang.Object   extended by java.lang.Throwable       extended by java.lang.Error           extended by com.rational.test.ft.RationalTestError
All Implemented Interfaces:
IRationalThrowable, java.io.Serializable
Direct Known Subclasses:
ManualModeError, RationalTestScriptError, UserStoppedScriptError

public class RationalTestError
extends java.lang.Error
implements IRationalThrowable

The base class for all test Errors. Such Errors are not common. When they occur, they indicate a failure of the script. You should not catch these Errors. Instead, allow them to terminate the script execution.

Since:
RFT1.0
See Also:
Serialized Form

Constructor Summary
RationalTestError()
           
RationalTestError(java.lang.String msg)
           
RationalTestError(java.lang.String msg, java.lang.String stackTrace)
           
 
Method Summary
 IRationalThrowable fillinCombinedStackTrace()
          Combines the current stack (in the current thread) with the stack trace from this exception.
 java.lang.String getClassName()
          Returns the class name.
 java.lang.String getContextDescription()
          Gets a description of the context of the exception within a script.
 java.lang.String getStackTraceString()
          Gets a String representation of the stack at the point when the current exception was constructed.
 void printStackTrace()
          Prints a String representation of the stack to System.err.
 void printStackTrace(java.io.PrintStream s)
          Prints the stack trace stream to a PrintStream object.
 void printStackTrace(java.io.PrintWriter s)
          Prints the stack trace stream to a PrintWriter object.
 void setContextDescription(java.lang.String s)
          Sets the exception context description.
 void setStackTraceString(java.lang.String s)
          Sets a String representation of the stack at the point when the current exception was constructed.
 void throwIt()
          Throws this throwable exception.
 
Methods inherited from class java.lang.Throwable
fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, initCause, setStackTrace, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

RationalTestError

public RationalTestError()

RationalTestError

public RationalTestError(java.lang.String msg)

RationalTestError

public RationalTestError(java.lang.String msg,                          java.lang.String stackTrace)
Method Detail

getClassName

public java.lang.String getClassName()
Returns the class name.

Specified by:
getClassName in interface IRationalThrowable
Since:
RFT1.0

getStackTraceString

public java.lang.String getStackTraceString()
Gets a String representation of the stack at the point when the current exception was constructed.

Specified by:
getStackTraceString in interface IRationalThrowable
Since:
RFT1.0 8

setStackTraceString

public void setStackTraceString(java.lang.String s)
Sets a String representation of the stack at the point when the current exception was constructed.

Specified by:
setStackTraceString in interface IRationalThrowable

printStackTrace

public void printStackTrace()
Prints a String representation of the stack to System.err.

Overrides:
printStackTrace in class java.lang.Throwable
Since:
RFT1.0

printStackTrace

public void printStackTrace(java.io.PrintStream s)
Prints the stack trace stream to a PrintStream object.

Overrides:
printStackTrace in class java.lang.Throwable
Parameters:
s - the stack trace stream
Since:
RFT1.0

printStackTrace

public void printStackTrace(java.io.PrintWriter s)
Prints the stack trace stream to a PrintWriter object.

Overrides:
printStackTrace in class java.lang.Throwable
Parameters:
s - the stack trace stream
Since:
RFT1.0

getContextDescription

public java.lang.String getContextDescription()
Gets a description of the context of the exception within a script. (This may be null.)

Specified by:
getContextDescription in interface IRationalThrowable
Since:
RFT1.0

setContextDescription

public void setContextDescription(java.lang.String s)
Sets the exception context description.

Specified by:
setContextDescription in interface IRationalThrowable
Since:
RFT1.0

throwIt

public void throwIt()
Throws this throwable exception.

Specified by:
throwIt in interface IRationalThrowable
Since:
RFT1.0

fillinCombinedStackTrace

public IRationalThrowable fillinCombinedStackTrace()
Combines the current stack (in the current thread) with the stack trace from this exception. The combined stack is persisted as a String.

Specified by:
fillinCombinedStackTrace in interface IRationalThrowable
Since:
RFT1.0