testng 7.10.2 · org.testng.annotations.BeforeMethod

Method Summary

Modifier and Type	Method and Description
public boolean	Returns: the value (default false) alwaysRun() 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.
public String[]	Returns: the value dependsOnGroups() The list of groups this method depends on.
public String[]	Returns: the value dependsOnMethods() The list of methods this method depends on.
public String	Returns: the value (default empty) description() The description for this method.
public boolean	Returns: the value (default true) enabled() Whether methods on this class/method are enabled.
public boolean	Returns: the value (default false) firstTimeOnly() If true and the @Test method about to be run has an invocationCount > 1, this BeforeMethod will only be invoked once (before the first test invocation).
public String[]	Returns: the value groups() The list of groups this class/method belongs to.
public boolean	Returns: - `true` if the configuration failure arising out of this method should be ignored. Enabling this will override the "configfailurepolicy" set at the suite level ONLY for this method. ignoreFailure()
public boolean	Returns: the value (default true) inheritGroups() If true, this @Configuration method will belong to groups specified in the @Test annotation on the class (if any).
public String[]	Returns: the value onlyForGroups() Causes this method to be invoked only if the test method belongs to a listed group.
public long	Returns: the value (default 0) timeOut() The maximum number of milliseconds this method should take.

Inherited from java.lang.annotation.Annotation:: annotationType equals hashCode toString

Method Detail

alwaysRun	back to summary
public boolean alwaysRun() 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. Returns:boolean the value (default false)

alwaysRun

back to summary

public boolean alwaysRun()

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.

Returns:boolean: the value (default false)

dependsOnGroups	back to summary
public String[] dependsOnGroups() 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. Returns:String[] the value

dependsOnGroups

back to summary

public String[] dependsOnGroups()

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.

Returns:String[]: the value

dependsOnMethods	back to summary
public String[] dependsOnMethods() 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. Returns:String[] the value

dependsOnMethods

back to summary

public String[] dependsOnMethods()

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.

Returns:String[]: the value

description	back to summary
public String description() The description for this method. The string used will appear in the HTML report and also on standard output if verbose >= 2. Returns:String the value (default empty)

description

back to summary

public String description()

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

Returns:String: the value (default empty)

enabled	back to summary
public boolean enabled() Whether methods on this class/method are enabled. Returns:boolean the value (default true)

enabled

back to summary

public boolean enabled()

Whether methods on this class/method are enabled.

Returns:boolean: the value (default true)

firstTimeOnly	back to summary
public boolean firstTimeOnly() If true and the @Test method about to be run has an invocationCount > 1, this BeforeMethod will only be invoked once (before the first test invocation). Returns:boolean the value (default false)

firstTimeOnly

back to summary

public boolean firstTimeOnly()

If true and the @Test method about to be run has an invocationCount > 1, this BeforeMethod will only be invoked once (before the first test invocation).

Returns:boolean: the value (default false)

groups back to summary

groups	back to summary
public String[] groups() The list of groups this class/method belongs to. Note that even if the test method being invoked belongs to a different group, all @BeforeMethod methods will be invoked before it as long as they belong to groups that were selected to run at all. See `onlyForGroups()` to select test method groups which this method will be invoked before. Returns:String[] the value

public String[] groups()

The list of groups this class/method belongs to. Note that even if the test method being invoked belongs to a different group, all @BeforeMethod methods will be invoked before it as long as they belong to groups that were selected to run at all. See onlyForGroups() to select test method groups which this method will be invoked before.

Returns:String[]: the value

ignoreFailure	back to summary
public boolean ignoreFailure() Returns:boolean - `true` if the configuration failure arising out of this method should be ignored. Enabling this will override the "configfailurepolicy" set at the suite level ONLY for this method.

inheritGroups	back to summary
public boolean inheritGroups() If true, this @Configuration method will belong to groups specified in the @Test annotation on the class (if any). Returns:boolean the value (default true)

inheritGroups

back to summary

public boolean inheritGroups()

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

Returns:boolean: the value (default true)

onlyForGroups	back to summary
public String[] onlyForGroups() Causes this method to be invoked only if the test method belongs to a listed group. It can be used if different setups are needed for different groups. Omitting this or setting it to an empty list will cause this method to run before every test method, regardless of which group it belongs to. Otherwise, this method is only invoked if the test method being invoked belongs to one of the groups listed here. Returns:String[] the value

onlyForGroups

back to summary

public String[] onlyForGroups()

Causes this method to be invoked only if the test method belongs to a listed group. It can be used if different setups are needed for different groups. Omitting this or setting it to an empty list will cause this method to run before every test method, regardless of which group it belongs to. Otherwise, this method is only invoked if the test method being invoked belongs to one of the groups listed here.

Returns:String[]: the value

timeOut	back to summary
public long timeOut() The maximum number of milliseconds this method should take. If it hasn't returned after this time, this method will fail and it will cause test methods depending on it to be skipped. Returns:long the value (default 0)

timeOut

back to summary

public long timeOut()

The maximum number of milliseconds this method should take. If it hasn't returned after this time, this method will fail and it will cause test methods depending on it to be skipped.

Returns:long: the value (default 0)

public @Interface BeforeMethod

Method Summary

Method Detail