ITestResult (testng 7.5.1 API)

All Superinterfaces:

Comparable<ITestResult>, IAttributes

All Known Implementing Classes:

TestResult
```
public interface ITestResult
extends IAttributes, Comparable<ITestResult>
```
This class describes the result of a test.

Since:

May 2, 2004

Version:

$Revision: 721 $, $Date: 2009-05-23 09:55:46 -0700 (Sat, 23 May 2009) $

Author:

Cedric Beust, May 2, 2004

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`CREATED`
`static int`	`FAILURE`
`static int`	`SKIP`
`static int`	`STARTED`
`static int`	`SUCCESS`
`static int`	`SUCCESS_PERCENTAGE_FAILURE`

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`long`	`getEndMillis()`
`Object[]`	`getFactoryParameters()`
`String`	`getHost()`
`Object`	`getInstance()`
`String`	`getInstanceName()`
`ITestNGMethod`	`getMethod()`
`String`	`getName()`
`Object[]`	`getParameters()`
`default List<ITestNGMethod>`	`getSkipCausedBy()`
`long`	`getStartMillis()`
`int`	`getStatus()`
`IClass`	`getTestClass()`
`ITestContext`	`getTestContext()`
`String`	`getTestName()`
`Throwable`	`getThrowable()`
`String`	`id()`
`boolean`	`isSuccess()`
`void`	`setEndMillis(long millis)`
`void`	`setParameters(Object[] parameters)`
`void`	`setStatus(int status)`
`void`	`setTestName(String name)`
`void`	`setThrowable(Throwable throwable)`
`void`	`setWasRetried(boolean wasRetried)`
`static boolean`	`wasFailureDueToTimeout(ITestResult result)`
`boolean`	`wasRetried()`

Methods inherited from interface org.testng.IAttributes
getAttribute, getAttributeNames, removeAttribute, setAttribute

Methods inherited from interface java.lang.Comparable
compareTo

- Field Detail
  - CREATED
```
static final int CREATED
```
    See Also:
    
    Constant Field Values
  - SUCCESS
```
static final int SUCCESS
```
    See Also:
    
    Constant Field Values
  - FAILURE
```
static final int FAILURE
```
    See Also:
    
    Constant Field Values
  - SKIP
```
static final int SKIP
```
    See Also:
    
    Constant Field Values
  - SUCCESS_PERCENTAGE_FAILURE
```
static final int SUCCESS_PERCENTAGE_FAILURE
```
    See Also:
    
    Constant Field Values
  - STARTED
```
static final int STARTED
```
    See Also:
    
    Constant Field Values
- Method Detail
  - getStatus
```
int getStatus()
```
    Returns:
    
    The status of this result, using one of the constants above.
  - setStatus
```
void setStatus(int status)
```
  - getMethod
```
ITestNGMethod getMethod()
```
    Returns:
    
    The test method this result represents.
  - getParameters
```
Object[] getParameters()
```
    Returns:
    
    The parameters this method was invoked with.
  - setParameters
```
void setParameters(Object[] parameters)
```
  - getTestClass
```
IClass getTestClass()
```
    Returns:
    
    The test class used this object is a result for.
  - getThrowable
```
Throwable getThrowable()
```
    Returns:
    
    The throwable that was thrown while running the method, or null if no exception was thrown.
  - setThrowable
```
void setThrowable(Throwable throwable)
```
  - getStartMillis
```
long getStartMillis()
```
    Returns:
    
    the start date for this test, in milliseconds.
  - getEndMillis
```
long getEndMillis()
```
    Returns:
    
    the end date for this test, in milliseconds.
  - setEndMillis
```
void setEndMillis(long millis)
```
  - getName
```
String getName()
```
    Returns:
    
    The name of this TestResult, typically identical to the name of the method.
  - isSuccess
```
boolean isSuccess()
```
    Returns:
    
    true if if this test run is a SUCCESS
  - getHost
```
String getHost()
```
    Returns:
    
    The host where this suite was run, or null if it was run locally. The returned string has the form: host:port
  - getInstance
```
Object getInstance()
```
    Returns:
    
    The instance on which this method was run.
  - getFactoryParameters
```
Object[] getFactoryParameters()
```
    Returns:
    
    - A parameter array that was passed to a factory method (or) an empty object array otherwise.
  - getTestName
```
String getTestName()
```
    Returns:
    
    The test name if this result's related instance implements ITest or use @Test(testName=...), null otherwise.
  - getInstanceName
```
String getInstanceName()
```
  - getTestContext
```
ITestContext getTestContext()
```
    Returns:
    
    the ITestContext for this test result.
  - setTestName
```
void setTestName(String name)
```
    Parameters:
    
    name - - The new name to be used as a test name
  - wasRetried
```
boolean wasRetried()
```
    Returns:
    
    - true if the test was retried again by an implementation of IRetryAnalyzer
  - setWasRetried
```
void setWasRetried(boolean wasRetried)
```
    Parameters:
    
    wasRetried - - true if the test was retried and false otherwise.
  - getSkipCausedBy
```
default List<ITestNGMethod> getSkipCausedBy()
```
    Returns:
    
    - The list of either upstream method(s) or configuration method(s) whose failure led to the current method being skipped. An empty list is returned when the current method is not a skipped method.
  - id
```
String id()
```
    Returns:
    
    - A unique id for the current JVM that represents a unique way of identifying a specific test method's result.
  - wasFailureDueToTimeout
```
static boolean wasFailureDueToTimeout(ITestResult result)
```
    Parameters:
    
    result - - The test result of a method
    
    Returns:
    
    - true if the test failure was due to a timeout.

Interface ITestResult

Field Summary

Method Summary

Methods inherited from interface org.testng.IAttributes

Methods inherited from interface java.lang.Comparable

Field Detail

CREATED

SUCCESS

FAILURE

SKIP

SUCCESS_PERCENTAGE_FAILURE

STARTED

Method Detail

getStatus

setStatus

getMethod

getParameters

setParameters

getTestClass

getThrowable

setThrowable

getStartMillis

getEndMillis

setEndMillis

getName

isSuccess

getHost

getInstance

getFactoryParameters

getTestName

getInstanceName

getTestContext

setTestName

wasRetried

setWasRetried

getSkipCausedBy

id

wasFailureDueToTimeout