org.testng.annotations

Annotation Type BeforeMethod

@Retention(value=RUNTIME)
 @Target(value=METHOD)
 @Documented
public @interface BeforeMethod

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
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.
java.lang.String[]	dependsOnGroups The list of groups this method depends on.
java.lang.String[]	dependsOnMethods The list of methods this method depends on.
java.lang.String	description The description for this method.
boolean	enabled Whether methods on this class/method are enabled.
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).
java.lang.String[]	groups The list of groups this class/method belongs to.
boolean	inheritGroups If true, this @Configuration method will belong to groups specified in the @Test annotation on the class (if any).
long	timeOut The maximum number of milliseconds this method should take.

Element Detail

enabled

public abstract boolean enabled

Whether methods on this class/method are enabled.

Default:

true

groups

public abstract java.lang.String[] groups

The list of groups this class/method belongs to.

Default:

{}

dependsOnGroups

public abstract java.lang.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.

Default:

{}

dependsOnMethods

public abstract java.lang.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.

Default:

{}

alwaysRun

public abstract 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.

Default:

false

inheritGroups

public abstract boolean inheritGroups

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

Default:

true

description

public abstract java.lang.String description

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

Default:

""

firstTimeOnly

public abstract 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).

Default:

false

timeOut

public abstract 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.

Default:

0L