Package org.testng.internal

Class TestNgMethodUtils

java.lang.Object

org.testng.internal.TestNgMethodUtils

class TestNgMethodUtils
extends java.lang.Object

Collections of helper methods to help deal with TestNG configuration methods

Constructor Summary

Constructors

Modifier	Constructor	Description
private	TestNgMethodUtils()

Method Summary

Modifier and Type	Method	Description
(package private) static boolean	cannotRunMethodIndependently(ITestNGMethod tm)
private static boolean	containsConfigurationMethod(ITestNGMethod method, java.util.List<ITestNGMethod> methods)	A helper method which checks if a given method is a configuration method and is part of list of TestNG methods
(package private) static ITestNGMethod[]	filterAfterTestMethods(ITestClass testClass, Invoker.Predicate<ITestNGMethod,IClass> predicate)
(package private) static ITestNGMethod[]	filterBeforeTestMethods(ITestClass testClass, Invoker.Predicate<ITestNGMethod,IClass> predicate)
(package private) static ITestNGMethod[]	filterFirstTimeRunnableSetupConfigurationMethods(ITestNGMethod tm, ITestNGMethod[] methods)	The array of methods contains @BeforeMethods if isBefore if true, @AfterMethods otherwise.
(package private) static ITestNGMethod[]	filterLastTimeRunnableTeardownConfigurationMethods(ITestNGMethod tm, ITestNGMethod[] methods)
(package private) static ITestNGMethod[]	filterMethods(IClass testClass, ITestNGMethod[] methods, Invoker.Predicate<ITestNGMethod,IClass> predicate)
(package private) static java.lang.Object	getMethodInvocationToken(ITestNGMethod method, java.lang.Object instance)
private static boolean	isConfigMethodRunningFirstTime(ConfigurationMethod cm, ITestNGMethod tm)
private static boolean	isConfigMethodRunningLastTime(ConfigurationMethod cm, ITestNGMethod tm)
(package private) static boolean	isConfigurationMethod(ITestNGMethod method)	A helper method that checks to see if a method is a configuration method or not.
private static boolean	isConfigurationMethod(ITestNGMethod method, boolean includeGroupConfigs)	A helper method that checks to see if a method is a configuration method or not.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

TestNgMethodUtils

private TestNgMethodUtils()

Method Detail

isConfigurationMethod

static boolean isConfigurationMethod(ITestNGMethod method)

A helper method that checks to see if a method is a configuration method or not.

Parameters:

method - - A ITestNGMethod object which needs to be checked.

Returns:

- true if the method is a configuration method and false if its a test method.

isConfigurationMethod

private static boolean isConfigurationMethod(ITestNGMethod method,
                                             boolean includeGroupConfigs)

A helper method that checks to see if a method is a configuration method or not.

Parameters:

method - - A ITestNGMethod object which needs to be checked.

includeGroupConfigs - - true if before/after group configuration annotations are also to be taken into consideration.

Returns:

- true if the method is a configuration method and false if its a test method.

containsConfigurationMethod

private static boolean containsConfigurationMethod(ITestNGMethod method,
                                                   java.util.List<ITestNGMethod> methods)

A helper method which checks if a given method is a configuration method and is part of list of TestNG methods

Parameters:

method - - A ITestNGMethod object which needs to be checked.

methods - - A List of ITestNGMethod in which the check needs to be done.

Returns:

- true if the method is a configuration method and exists in the list of methods passed.

filterBeforeTestMethods

static ITestNGMethod[] filterBeforeTestMethods(ITestClass testClass,
                                               Invoker.Predicate<ITestNGMethod,IClass> predicate)

filterAfterTestMethods

static ITestNGMethod[] filterAfterTestMethods(ITestClass testClass,
                                              Invoker.Predicate<ITestNGMethod,IClass> predicate)

filterMethods

static ITestNGMethod[] filterMethods(IClass testClass,
                                     ITestNGMethod[] methods,
                                     Invoker.Predicate<ITestNGMethod,IClass> predicate)

Returns:

Only the ITestNGMethods applicable for this testClass

filterFirstTimeRunnableSetupConfigurationMethods

static ITestNGMethod[] filterFirstTimeRunnableSetupConfigurationMethods(ITestNGMethod tm,
                                                                        ITestNGMethod[] methods)

The array of methods contains @BeforeMethods if isBefore if true, @AfterMethods otherwise. This function removes all the methods that should not be run at this point because they are either firstTimeOnly or lastTimeOnly and we haven't reached the current invocationCount yet

filterLastTimeRunnableTeardownConfigurationMethods

static ITestNGMethod[] filterLastTimeRunnableTeardownConfigurationMethods(ITestNGMethod tm,
                                                                          ITestNGMethod[] methods)

cannotRunMethodIndependently

static boolean cannotRunMethodIndependently(ITestNGMethod tm)

Parameters:

tm - - The ITestNGMethod object which is to be tested.

Returns:

- true if the method depends on other methods and cannot be run independently.

getMethodInvocationToken

static java.lang.Object getMethodInvocationToken(ITestNGMethod method,
                                                 java.lang.Object instance)

isConfigMethodRunningFirstTime

private static boolean isConfigMethodRunningFirstTime(ConfigurationMethod cm,
                                                      ITestNGMethod tm)

isConfigMethodRunningLastTime

private static boolean isConfigMethodRunningLastTime(ConfigurationMethod cm,
                                                     ITestNGMethod tm)