BaseTestMethod (TestNG 6.14.3 API)

java.lang.Object
- org.testng.internal.BaseTestMethod

All Implemented Interfaces:

Cloneable, ITestNGMethod

Direct Known Subclasses:

ConfigurationMethod, FactoryMethod, JUnitTestMethod, TestNGMethod
```
public abstract class BaseTestMethod
extends Object
implements ITestNGMethod
```
Superclass to represent both @Test and @Configuration methods.

Field Summary

Fields
Modifier and Type	Field and Description
`static Comparator<?>`	`DATE_COMPARATOR` Compares two ITestNGMethod by date.
`protected String[]`	`m_afterGroups`
`protected IAnnotationFinder`	`m_annotationFinder`
`protected String[]`	`m_beforeGroups`
`protected AtomicInteger`	`m_currentInvocationCount`
`protected long`	`m_date`
`protected String[]`	`m_groups`
`protected String[]`	`m_groupsDependedUpon`
`protected String`	`m_id`
`protected ConstructorOrMethod`	`m_method`
`protected Class<?>`	`m_methodClass`
`protected String[]`	`m_methodsDependedUpon`
`protected ITestClass`	`m_testClass` The test class on which the test method was found.

Constructor Summary

Constructors
Constructor and Description
`BaseTestMethod(String methodName, ConstructorOrMethod com, IAnnotationFinder annotationFinder, Object instance)`
`BaseTestMethod(String methodName, Method method, IAnnotationFinder annotationFinder, Object instance)` Constructs a `BaseTestMethod` TODO cquezel JavaDoc.

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addFailedInvocationNumber(int number)` The list of invocation numbers that failed, which is only applicable for methods that have a data provider.
`void`	`addMethodDependedUpon(String method)`
`boolean`	`canRunFromClass(IClass testClass)` Returns if this ITestNGMethod can be invoked from within IClass.
`abstract ITestNGMethod`	`clone()`
`boolean`	`equals(Object obj)` Compares two BaseTestMethod using the test class then the associated Java Method.
`Map<String,String>`	`findMethodParameters(XmlTest test)`
`String[]`	`getAfterGroups()`
`protected IAnnotationFinder`	`getAnnotationFinder()`
`String[]`	`getBeforeGroups()` Before and After groups
`ConstructorOrMethod`	`getConstructorOrMethod()`
`int`	`getCurrentInvocationCount()`
`long`	`getDate()`
`String`	`getDescription()`
`boolean`	`getEnabled()`
`List<Integer>`	`getFailedInvocationNumbers()`
`String[]`	`getGroups()`
`String[]`	`getGroupsDependedUpon()`
`protected IClass`	`getIClass()`
`String`	`getId()`
`Object`	`getInstance()`
`long[]`	`getInstanceHashCodes()` Needed for serialization.
`Object[]`	`getInstances()`
`int`	`getInvocationCount()`
`List<Integer>`	`getInvocationNumbers()` Which invocation numbers of this method should be used (only applicable if it uses a data provider).
`long`	`getInvocationTimeOut()` The time under which all invocationCount methods need to complete by.
`Method`	`getMethod()`
`String`	`getMethodName()` Returns the method name.
`String[]`	`getMethodsDependedUpon()`
`String`	`getMissingGroup()` If a group was not found.
`int`	`getParameterInvocationCount()`
`int`	`getPriority()` The scheduling priority.
`String`	`getQualifiedName()` getRealClass().getName() + "." + getMethodName()
`Class<?>`	`getRealClass()`
`IRetryAnalyzer`	`getRetryAnalyzer()`
`protected String`	`getSignature()`
`String`	`getSimpleName()`
`protected String[]`	`getStringArray(String[] methodArray, String[] classArray)`
`int`	`getSuccessPercentage()` Default value for successPercentage.
`ITestClass`	`getTestClass()`
`int`	`getThreadPoolSize()`
`long`	`getTimeOut()`
`int`	`getTotalInvocationCount()`
`XmlTest`	`getXmlTest()`
`int`	`hashCode()` This implementation returns the associated Java Method's hash code.
`boolean`	`hasMoreInvocation()`
`boolean`	`ignoreMissingDependencies()`
`void`	`incrementCurrentInvocationCount()`
`protected void`	`initBeforeAfterGroups(Class<? extends ITestOrConfiguration> annotationClass, String[] groups)`
`protected void`	`initGroups(Class<? extends ITestOrConfiguration> annotationClass)`
`boolean`	`isAfterClassConfiguration()`
`boolean`	`isAfterGroupsConfiguration()`
`boolean`	`isAfterMethodConfiguration()`
`boolean`	`isAfterSuiteConfiguration()`
`boolean`	`isAfterTestConfiguration()`
`boolean`	`isAlwaysRun()`
`boolean`	`isBeforeClassConfiguration()`
`boolean`	`isBeforeGroupsConfiguration()`
`boolean`	`isBeforeMethodConfiguration()`
`boolean`	`isBeforeSuiteConfiguration()`
`boolean`	`isBeforeTestConfiguration()`
`boolean`	`isTest()`
`protected void`	`setAlwaysRun(boolean alwaysRun)` TODO cquezel JavaDoc.
`void`	`setDate(long date)`
`void`	`setDescription(String description)`
`void`	`setEnabled(boolean enabled)`
`protected void`	`setGroups(String[] groups)`
`protected void`	`setGroupsDependedUpon(String[] groups, Collection<String> xmlGroupDependencies)`
`void`	`setId(String id)`
`void`	`setIgnoreMissingDependencies(boolean i)`
`void`	`setInvocationCount(int counter)` No-op.
`void`	`setInvocationNumbers(List<Integer> numbers)`
`void`	`setInvocationTimeOut(long timeOut)`
`protected void`	`setMethodsDependedUpon(String[] methods)`
`void`	`setMissingGroup(String group)`
`void`	`setMoreInvocationChecker(Callable<Boolean> moreInvocationChecker)`
`void`	`setParameterInvocationCount(int n)`
`void`	`setPriority(int priority)`
`void`	`setRetryAnalyzer(IRetryAnalyzer retryAnalyzer)`
`void`	`setSkipFailedInvocations(boolean s)`
`void`	`setTestClass(ITestClass tc)` Sets the test class having this method.
`void`	`setThreadPoolSize(int threadPoolSize)` No-op.
`void`	`setTimeOut(long timeOut)`
`void`	`setXmlTest(XmlTest xmlTest)`
`boolean`	`skipFailedInvocations()`
`String`	`toString()`

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - m_testClass
```
protected ITestClass m_testClass
```
    The test class on which the test method was found. Note that this is not necessarily the declaring class.
  - m_methodClass
```
protected final Class<?> m_methodClass
```
  - m_method
```
protected final ConstructorOrMethod m_method
```
  - m_id
```
protected String m_id
```
  - m_date
```
protected long m_date
```
  - m_annotationFinder
```
protected final IAnnotationFinder m_annotationFinder
```
  - m_groups
```
protected String[] m_groups
```
  - m_groupsDependedUpon
```
protected String[] m_groupsDependedUpon
```
  - m_methodsDependedUpon
```
protected String[] m_methodsDependedUpon
```
  - m_beforeGroups
```
protected String[] m_beforeGroups
```
  - m_afterGroups
```
protected String[] m_afterGroups
```
  - m_currentInvocationCount
```
protected AtomicInteger m_currentInvocationCount
```
  - DATE_COMPARATOR
```
public static final Comparator<?> DATE_COMPARATOR
```
    Compares two ITestNGMethod by date.
- Constructor Detail
  - BaseTestMethod
```
public BaseTestMethod(String methodName,
                      Method method,
                      IAnnotationFinder annotationFinder,
                      Object instance)
```
    Constructs a BaseTestMethod TODO cquezel JavaDoc.
    
    Parameters:
    
    method -
    
    annotationFinder -
    
    instance -
  - BaseTestMethod
```
public BaseTestMethod(String methodName,
                      ConstructorOrMethod com,
                      IAnnotationFinder annotationFinder,
                      Object instance)
```
- Method Detail
  - isAlwaysRun
```
public boolean isAlwaysRun()
```
    Specified by:
    
    isAlwaysRun in interface ITestNGMethod
    
    Returns:
    
    true if this method is alwaysRun=true
  - setAlwaysRun
```
protected void setAlwaysRun(boolean alwaysRun)
```
    TODO cquezel JavaDoc.
    
    Parameters:
    
    alwaysRun -
  - getRealClass
```
public Class<?> getRealClass()
```
    Specified by:
    
    getRealClass in interface ITestNGMethod
    
    Returns:
    
    The real class on which this method was declared (can be different from getMethod().getDeclaringClass() if the test method was defined in a superclass).
  - getTestClass
```
public ITestClass getTestClass()
```
    Specified by:
    
    getTestClass in interface ITestNGMethod
  - setTestClass
```
public void setTestClass(ITestClass tc)
```
    Sets the test class having this method. This is not necessarily the declaring class.
    
    Specified by:
    
    setTestClass in interface ITestNGMethod
    
    Parameters:
    
    tc - The test class having this method.
  - getMethod
```
public Method getMethod()
```
    Specified by:
    
    getMethod in interface ITestNGMethod
    
    Returns:
    
    the corresponding Java test method.
  - getMethodName
```
public String getMethodName()
```
    Returns the method name. This is needed for serialization because methods are not Serializable.
    
    Specified by:
    
    getMethodName in interface ITestNGMethod
    
    Returns:
    
    the method name.
  - getInstances
```
public Object[] getInstances()
```
    Specified by:
    
    getInstances in interface ITestNGMethod
    
    Returns:
    
    All the instances the methods will be invoked upon. This will typically be an array of one object in the absence of an @Factory annotation.
  - getInstance
```
public Object getInstance()
```
    Specified by:
    
    getInstance in interface ITestNGMethod
  - getInstanceHashCodes
```
public long[] getInstanceHashCodes()
```
    Needed for serialization.
    
    Specified by:
    
    getInstanceHashCodes in interface ITestNGMethod
  - getGroups
```
public String[] getGroups()
```
    Specified by:
    
    getGroups in interface ITestNGMethod
    
    Returns:
    
    the addition of groups defined on the class and on this method.
  - getGroupsDependedUpon
```
public String[] getGroupsDependedUpon()
```
    Specified by:
    
    getGroupsDependedUpon in interface ITestNGMethod
    
    Returns:
    
    The groups this method depends on, possibly added to the groups declared on the class.
  - getMethodsDependedUpon
```
public String[] getMethodsDependedUpon()
```
    Specified by:
    
    getMethodsDependedUpon in interface ITestNGMethod
    
    Returns:
    
    The methods this method depends on, possibly added to the methods declared on the class.
  - isTest
```
public boolean isTest()
```
    Specified by:
    
    isTest in interface ITestNGMethod
    
    Returns:
    
    true if this method was annotated with @Test
  - isBeforeSuiteConfiguration
```
public boolean isBeforeSuiteConfiguration()
```
    Specified by:
    
    isBeforeSuiteConfiguration in interface ITestNGMethod
    
    Returns:
    
    true if this method was annotated with @Configuration and beforeSuite = true
  - isAfterSuiteConfiguration
```
public boolean isAfterSuiteConfiguration()
```
    Specified by:
    
    isAfterSuiteConfiguration in interface ITestNGMethod
    
    Returns:
    
    true if this method was annotated with @Configuration and afterSuite = true
  - isBeforeTestConfiguration
```
public boolean isBeforeTestConfiguration()
```
    Specified by:
    
    isBeforeTestConfiguration in interface ITestNGMethod
    
    Returns:
    
    true if this method is a @BeforeTest (@Configuration beforeTest=true)
  - isAfterTestConfiguration
```
public boolean isAfterTestConfiguration()
```
    Specified by:
    
    isAfterTestConfiguration in interface ITestNGMethod
    
    Returns:
    
    true if this method is an @AfterTest (@Configuration afterTest=true)
  - isBeforeGroupsConfiguration
```
public boolean isBeforeGroupsConfiguration()
```
    Specified by:
    
    isBeforeGroupsConfiguration in interface ITestNGMethod
  - isAfterGroupsConfiguration
```
public boolean isAfterGroupsConfiguration()
```
    Specified by:
    
    isAfterGroupsConfiguration in interface ITestNGMethod
  - isBeforeClassConfiguration
```
public boolean isBeforeClassConfiguration()
```
    Specified by:
    
    isBeforeClassConfiguration in interface ITestNGMethod
    
    Returns:
    
    true if this method was annotated with @Configuration and beforeClassMethod = true
  - isAfterClassConfiguration
```
public boolean isAfterClassConfiguration()
```
    Specified by:
    
    isAfterClassConfiguration in interface ITestNGMethod
    
    Returns:
    
    true if this method was annotated with @Configuration and beforeClassMethod = false
  - isBeforeMethodConfiguration
```
public boolean isBeforeMethodConfiguration()
```
    Specified by:
    
    isBeforeMethodConfiguration in interface ITestNGMethod
    
    Returns:
    
    true if this method was annotated with @Configuration and beforeTestMethod = true
  - isAfterMethodConfiguration
```
public boolean isAfterMethodConfiguration()
```
    Specified by:
    
    isAfterMethodConfiguration in interface ITestNGMethod
    
    Returns:
    
    true if this method was annotated with @Configuration and beforeTestMethod = false
  - getTimeOut
```
public long getTimeOut()
```
    Specified by:
    
    getTimeOut in interface ITestNGMethod
    
    Returns:
    
    The timeout in milliseconds.
  - setTimeOut
```
public void setTimeOut(long timeOut)
```
    Specified by:
    
    setTimeOut in interface ITestNGMethod
  - getInvocationCount
```
public int getInvocationCount()
```
    Specified by:
    
    getInvocationCount in interface ITestNGMethod
    
    Returns:
    
    the number of times this method needs to be invoked.
  - setInvocationCount
```
public void setInvocationCount(int counter)
```
    No-op.
    
    Specified by:
    
    setInvocationCount in interface ITestNGMethod
  - getTotalInvocationCount
```
public int getTotalInvocationCount()
```
    Specified by:
    
    getTotalInvocationCount in interface ITestNGMethod
    
    Returns:
    
    0
  - getSuccessPercentage
```
public int getSuccessPercentage()
```
    Default value for successPercentage.
    
    Specified by:
    
    getSuccessPercentage in interface ITestNGMethod
    
    Returns:
    
    the success percentage for this method (between 0 and 100).
  - getId
```
public String getId()
```
    Specified by:
    
    getId in interface ITestNGMethod
    
    Returns:
    
    The id of the thread this method was run in.
  - setId
```
public void setId(String id)
```
    Specified by:
    
    setId in interface ITestNGMethod
  - getDate
```
public long getDate()
```
    Specified by:
    
    getDate in interface ITestNGMethod
    
    Returns:
    
    Returns the date.
  - setDate
```
public void setDate(long date)
```
    Specified by:
    
    setDate in interface ITestNGMethod
    
    Parameters:
    
    date - The date to set.
  - canRunFromClass
```
public boolean canRunFromClass(IClass testClass)
```
    Returns if this ITestNGMethod can be invoked from within IClass.
    
    Specified by:
    
    canRunFromClass in interface ITestNGMethod
  - equals
```
public boolean equals(Object obj)
```
    Compares two BaseTestMethod using the test class then the associated Java Method.
    
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    This implementation returns the associated Java Method's hash code.
    
    Overrides:
    
    hashCode in class Object
    
    Returns:
    
    the associated Java Method's hash code.
  - initGroups
```
protected void initGroups(Class<? extends ITestOrConfiguration> annotationClass)
```
  - initBeforeAfterGroups
```
protected void initBeforeAfterGroups(Class<? extends ITestOrConfiguration> annotationClass,
                                     String[] groups)
```
  - getAnnotationFinder
```
protected IAnnotationFinder getAnnotationFinder()
```
  - getIClass
```
protected IClass getIClass()
```
  - getSimpleName
```
public String getSimpleName()
```
  - getSignature
```
protected String getSignature()
```
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - getStringArray
```
protected String[] getStringArray(String[] methodArray,
                                  String[] classArray)
```
  - setGroups
```
protected void setGroups(String[] groups)
```
  - setGroupsDependedUpon
```
protected void setGroupsDependedUpon(String[] groups,
                                     Collection<String> xmlGroupDependencies)
```
  - setMethodsDependedUpon
```
protected void setMethodsDependedUpon(String[] methods)
```
  - addMethodDependedUpon
```
public void addMethodDependedUpon(String method)
```
    Specified by:
    
    addMethodDependedUpon in interface ITestNGMethod
  - getMissingGroup
```
public String getMissingGroup()
```
    If a group was not found.
    
    Specified by:
    
    getMissingGroup in interface ITestNGMethod
  - setMissingGroup
```
public void setMissingGroup(String group)
```
    Specified by:
    
    setMissingGroup in interface ITestNGMethod
  - getThreadPoolSize
```
public int getThreadPoolSize()
```
    Specified by:
    
    getThreadPoolSize in interface ITestNGMethod
    
    Returns:
    
    the number of threads to be used when invoking the method on parallel
  - setThreadPoolSize
```
public void setThreadPoolSize(int threadPoolSize)
```
    No-op.
    
    Specified by:
    
    setThreadPoolSize in interface ITestNGMethod
  - setDescription
```
public void setDescription(String description)
```
    Specified by:
    
    setDescription in interface ITestNGMethod
  - getDescription
```
public String getDescription()
```
    Specified by:
    
    getDescription in interface ITestNGMethod
  - setEnabled
```
public void setEnabled(boolean enabled)
```
  - getEnabled
```
public boolean getEnabled()
```
    Specified by:
    
    getEnabled in interface ITestNGMethod
  - getBeforeGroups
```
public String[] getBeforeGroups()
```
    Before and After groups
    
    Specified by:
    
    getBeforeGroups in interface ITestNGMethod
  - getAfterGroups
```
public String[] getAfterGroups()
```
    Specified by:
    
    getAfterGroups in interface ITestNGMethod
  - incrementCurrentInvocationCount
```
public void incrementCurrentInvocationCount()
```
    Specified by:
    
    incrementCurrentInvocationCount in interface ITestNGMethod
  - getCurrentInvocationCount
```
public int getCurrentInvocationCount()
```
    Specified by:
    
    getCurrentInvocationCount in interface ITestNGMethod
  - setParameterInvocationCount
```
public void setParameterInvocationCount(int n)
```
    Specified by:
    
    setParameterInvocationCount in interface ITestNGMethod
  - getParameterInvocationCount
```
public int getParameterInvocationCount()
```
    Specified by:
    
    getParameterInvocationCount in interface ITestNGMethod
  - setMoreInvocationChecker
```
public void setMoreInvocationChecker(Callable<Boolean> moreInvocationChecker)
```
    Specified by:
    
    setMoreInvocationChecker in interface ITestNGMethod
  - hasMoreInvocation
```
public boolean hasMoreInvocation()
```
    Specified by:
    
    hasMoreInvocation in interface ITestNGMethod
  - clone
```
public abstract ITestNGMethod clone()
```
    Specified by:
    
    clone in interface ITestNGMethod
    
    Overrides:
    
    clone in class Object
  - getRetryAnalyzer
```
public IRetryAnalyzer getRetryAnalyzer()
```
    Specified by:
    
    getRetryAnalyzer in interface ITestNGMethod
  - setRetryAnalyzer
```
public void setRetryAnalyzer(IRetryAnalyzer retryAnalyzer)
```
    Specified by:
    
    setRetryAnalyzer in interface ITestNGMethod
  - skipFailedInvocations
```
public boolean skipFailedInvocations()
```
    Specified by:
    
    skipFailedInvocations in interface ITestNGMethod
  - setSkipFailedInvocations
```
public void setSkipFailedInvocations(boolean s)
```
    Specified by:
    
    setSkipFailedInvocations in interface ITestNGMethod
  - setInvocationTimeOut
```
public void setInvocationTimeOut(long timeOut)
```
  - getInvocationTimeOut
```
public long getInvocationTimeOut()
```
    Description copied from interface: ITestNGMethod
    
    The time under which all invocationCount methods need to complete by.
    
    Specified by:
    
    getInvocationTimeOut in interface ITestNGMethod
  - ignoreMissingDependencies
```
public boolean ignoreMissingDependencies()
```
    Specified by:
    
    ignoreMissingDependencies in interface ITestNGMethod
  - setIgnoreMissingDependencies
```
public void setIgnoreMissingDependencies(boolean i)
```
    Specified by:
    
    setIgnoreMissingDependencies in interface ITestNGMethod
  - getInvocationNumbers
```
public List<Integer> getInvocationNumbers()
```
    Description copied from interface: ITestNGMethod
    
    Which invocation numbers of this method should be used (only applicable if it uses a data provider). If this value is an empty list, use all the values returned from the data provider. These values are read from the XML file in the tag.
    
    Specified by:
    
    getInvocationNumbers in interface ITestNGMethod
  - setInvocationNumbers
```
public void setInvocationNumbers(List<Integer> numbers)
```
    Specified by:
    
    setInvocationNumbers in interface ITestNGMethod
  - getFailedInvocationNumbers
```
public List<Integer> getFailedInvocationNumbers()
```
    Specified by:
    
    getFailedInvocationNumbers in interface ITestNGMethod
  - addFailedInvocationNumber
```
public void addFailedInvocationNumber(int number)
```
    Description copied from interface: ITestNGMethod
    
    The list of invocation numbers that failed, which is only applicable for methods that have a data provider.
    
    Specified by:
    
    addFailedInvocationNumber in interface ITestNGMethod
  - getPriority
```
public int getPriority()
```
    Description copied from interface: ITestNGMethod
    
    The scheduling priority. Lower priorities get scheduled first.
    
    Specified by:
    
    getPriority in interface ITestNGMethod
  - setPriority
```
public void setPriority(int priority)
```
    Specified by:
    
    setPriority in interface ITestNGMethod
  - getXmlTest
```
public XmlTest getXmlTest()
```
    Specified by:
    
    getXmlTest in interface ITestNGMethod
    
    Returns:
    
    the XmlTest this method belongs to.
  - setXmlTest
```
public void setXmlTest(XmlTest xmlTest)
```
  - getConstructorOrMethod
```
public ConstructorOrMethod getConstructorOrMethod()
```
    Specified by:
    
    getConstructorOrMethod in interface ITestNGMethod
  - findMethodParameters
```
public Map<String,String> findMethodParameters(XmlTest test)
```
    Specified by:
    
    findMethodParameters in interface ITestNGMethod
    
    Returns:
    
    the parameters found in the include tag, if any
  - getQualifiedName
```
public String getQualifiedName()
```
    Description copied from interface: ITestNGMethod
    
    getRealClass().getName() + "." + getMethodName()
    
    Specified by:
    
    getQualifiedName in interface ITestNGMethod
    
    Returns:
    
    qualified name for this method

Class BaseTestMethod

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

m_testClass

m_methodClass

m_method

m_id

m_date

m_annotationFinder

m_groups

m_groupsDependedUpon

m_methodsDependedUpon

m_beforeGroups

m_afterGroups

m_currentInvocationCount

DATE_COMPARATOR

Constructor Detail

BaseTestMethod

BaseTestMethod

Method Detail

isAlwaysRun

setAlwaysRun

getRealClass

getTestClass

setTestClass

getMethod

getMethodName

getInstances

getInstance

getInstanceHashCodes

getGroups

getGroupsDependedUpon

getMethodsDependedUpon

isTest

isBeforeSuiteConfiguration

isAfterSuiteConfiguration

isBeforeTestConfiguration

isAfterTestConfiguration

isBeforeGroupsConfiguration

isAfterGroupsConfiguration

isBeforeClassConfiguration

isAfterClassConfiguration

isBeforeMethodConfiguration

isAfterMethodConfiguration

getTimeOut

setTimeOut

getInvocationCount

setInvocationCount

getTotalInvocationCount

getSuccessPercentage

getId

setId

getDate

setDate

canRunFromClass

equals

hashCode

initGroups

initBeforeAfterGroups

getAnnotationFinder

getIClass

getSimpleName

getSignature

toString

getStringArray

setGroups

setGroupsDependedUpon

setMethodsDependedUpon

addMethodDependedUpon

getMissingGroup

setMissingGroup

getThreadPoolSize

setThreadPoolSize

setDescription

getDescription

setEnabled

getEnabled