org.testng.internal.annotations

Interface IBaseBeforeAfter

All Superinterfaces:

IAnnotation, IParameterizable, ITestOrConfiguration

All Known Subinterfaces:

IAfterClass, IAfterGroups, IAfterMethod, IAfterSuite, IAfterTest, IBaseBeforeAfterMethod, IBeforeClass, IBeforeGroups, IBeforeMethod, IBeforeSuite, IBeforeTest

All Known Implementing Classes:

BaseBeforeAfter, ConfigurationAnnotation

public interface IBaseBeforeAfter
extends ITestOrConfiguration

Base interface for IBeforeSuite, IAfterSuite, etc...

Method Summary

Modifier and Type	Method and Description
boolean	getAlwaysRun() For before methods (beforeSuite, beforeTest, beforeTestClass and beforeTestMethod, but not beforeGroups): If set to true, this configuration method will be run regardless of what groups it belongs to.
String[]	getDependsOnGroups() The list of groups this method depends on.
String[]	getDependsOnMethods() The list of methods this method depends on.
String	getDescription() The description for this method.
boolean	getEnabled() Whether methods on this class/method are enabled.
String[]	getGroups() The list of groups this class/method belongs to.
boolean	getInheritGroups()

Methods inherited from interface org.testng.annotations.ITestOrConfiguration

getTimeOut, setDependsOnGroups, setDependsOnMethods, setDescription, setGroups, setTimeOut

Methods inherited from interface org.testng.annotations.IParameterizable

setEnabled

Method Detail

getEnabled

boolean getEnabled()

Whether methods on this class/method are enabled.

Specified by:

getEnabled in interface IParameterizable

Returns:

true if enabled

getGroups

String[] getGroups()

The list of groups this class/method belongs to.

Specified by:

getGroups in interface ITestOrConfiguration

Returns:

The list of groups this class/method belongs to.

getDependsOnGroups

String[] getDependsOnGroups()

The list of groups this method depends on. Every method member of one of these groups is guaranteed to have been invoked before this method. Furthermore, if any of these methods was not a SUCCESS, this test method will not be run and will be flagged as a SKIP.

Specified by:

getDependsOnGroups in interface ITestOrConfiguration

Returns:

The list of groups this method depends on. Every method member of one of these groups is guaranteed to have been invoked before this method. Furthermore, if any of these methods was not a SUCCESS, this test method will not be run and will be flagged as a SKIP.

getDependsOnMethods

String[] getDependsOnMethods()

The list of methods this method depends on. There is no guarantee on the order on which the methods depended upon will be run, but you are guaranteed that all these methods will be run before the test method that contains this annotation is run. Furthermore, if any of these methods was not a SUCCESS, this test method will not be run and will be flagged as a SKIP.

If some of these methods have been overloaded, all the overloaded versions will be run.

Specified by:

getDependsOnMethods in interface ITestOrConfiguration

Returns:

The list of methods this method depends on. There is no guarantee on the order on which the methods depended upon will be run, but you are guaranteed that all these methods will be run before the test method that contains this annotation is run. Furthermore, if any of these methods was not a SUCCESS, this test method will not be run and will be flagged as a SKIP.

If some of these methods have been overloaded, all the overloaded versions will be run.

getAlwaysRun

boolean getAlwaysRun()

For before methods (beforeSuite, beforeTest, beforeTestClass and beforeTestMethod, but not beforeGroups): If set to true, this configuration method will be run regardless of what groups it belongs to.
For after methods (afterSuite, afterClass, ...): If set to true, this configuration method will be run even if one or more methods invoked previously failed or was skipped.

getInheritGroups

boolean getInheritGroups()

Returns:

true if this @Configuration method will belong to groups specified in the @Test annotation on the class (if any).

getDescription

String getDescription()

The description for this method. The string used will appear in the HTML report and also on standard output if verbose > 2.

Specified by:

getDescription in interface ITestOrConfiguration

Returns:

The description for this method, which will be shown in the reports.