package bluej.debugger;

import threadchecker.OnThread;
import threadchecker.Tag;




| A class representing the running of a single test
| method.
|
| @author  Andrew Patterson
|
@OnThread(Tag.Any)
public abstract class DebuggerTestResult
{       



| Return the fully qualified name of the test method.
|
| @return  the name of the test method in the
|          form ClassName.methodName
|
public String getName()
   {
      return getQualifiedClassName() + "." + getMethodName();     
      }

    
   
   


| Get the name of the test method.
|
public abstract String getMethodName();

   
   


| Get the fully qualified class name which the test method belongs to
|
public abstract String getQualifiedClassName();

   
   


| Return the run time of the test in milliseconds
|
| @return  the total running time of the test in
|          milliseconds
|
abstract public int getRunTimeMs();
    
   
   


| Return whether this test method was a success.
|
| @return  true if this test was a success
|
abstract public boolean isSuccess();
    
   
   


| If !isSuccess then this returns true if the
| test result was an expected 'failure'.
|
| @return  true if this test resulted in a failure
|
abstract public boolean isFailure();
    
   
   


| If !isSuccess then this returns true if the
| test result was an unexpected 'error'.
|
| @return  true if this test resulted in an error
|
abstract public boolean isError();
    
   
   


| Return a stack trace for the test failure/error.
|
| This method can be called only when the test
| resulted in a failure or an error.
|
| @return  a String of the stack trace of the failure/error
|
abstract public String getTrace();
    
   
   


| Return an exception message for the test failure/error.
|
| This method can be called only when the test
| resulted in a failure or an error.
|
| @return  a String of the details of the exception thrown
|
abstract public String getExceptionMessage();
    
   
   


| Return the location of the failure/error point (ie. the point where
| the exception was thrown). May return null if the information is not
| available.
|
| @return  a SourceLocation with the details of the failure point
|
abstract public SourceLocation getExceptionLocation(); 
   }