Package org.testng

Interface ITestNGMethod

All Superinterfaces:
Cloneable
public interface ITestNGMethod extends Cloneable
Describes a TestNG annotated method and the instance on which it will be invoked.

This interface is not meant to be implemented by users.

  • Method Details

    • getRealClass

      Class getRealClass()
      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

      ITestClass getTestClass()

    • setTestClass

      void setTestClass(ITestClass cls)
      Sets the test class having this method. This is not necessarily the declaring class.
      Parameters:
      cls - The test class having this method.

    • getMethodName

      String getMethodName()
      Returns the method name. This is needed for serialization because methods are not Serializable.
      Returns:
      the method name.

    • getInstance

      Object getInstance()

    • getInstanceHashCodes

      long[] getInstanceHashCodes()
      Needed for serialization.
      Returns:
      The hashcode of instances

    • getGroups

      String[] getGroups()
      Returns:
      The groups this method belongs to, possibly added to the groups declared on the class.

    • getGroupsDependedUpon

      String[] getGroupsDependedUpon()
      Returns:
      The groups this method depends on, possibly added to the groups declared on the class.

    • getMissingGroup

      String getMissingGroup()
      Returns:
      If a group was not found.

    • setMissingGroup

      void setMissingGroup(String group)

    • getBeforeGroups

      String[] getBeforeGroups()

    • getAfterGroups

      String[] getAfterGroups()

    • getMethodsDependedUpon

      String[] getMethodsDependedUpon()
      Returns:
      The methods this method depends on, possibly added to the methods declared on the class.

    • downstreamDependencies

      default Set<ITestNGMethod> downstreamDependencies()
      Returns:
      - The set of methods that are dependent on the current method. This information can help in deciding what other TestNG methods will be skipped if the current method fails. If the current method is a configuration method, then an empty set is returned.

    • upstreamDependencies

      default Set<ITestNGMethod> upstreamDependencies()
      Returns:
      - The set of methods upon which the current method has a dependency. This information can help in deciding what all TestNG methods need to pass before the current method can be executed. If the current method is a configuration method, then an empty set is returned.

    • addMethodDependedUpon

      void addMethodDependedUpon(String methodName)

    • isTest

      boolean isTest()
      Returns:
      true if this method was annotated with @Test

    • isBeforeMethodConfiguration

      boolean isBeforeMethodConfiguration()
      Returns:
      true if this method was annotated with @Configuration and beforeTestMethod = true

    • isAfterMethodConfiguration

      boolean isAfterMethodConfiguration()
      Returns:
      true if this method was annotated with @Configuration and beforeTestMethod = false

    • isBeforeClassConfiguration

      boolean isBeforeClassConfiguration()
      Returns:
      true if this method was annotated with @Configuration and beforeClassMethod = true

    • isAfterClassConfiguration

      boolean isAfterClassConfiguration()
      Returns:
      true if this method was annotated with @Configuration and beforeClassMethod = false

    • isBeforeSuiteConfiguration

      boolean isBeforeSuiteConfiguration()
      Returns:
      true if this method was annotated with @Configuration and beforeSuite = true

    • isAfterSuiteConfiguration

      boolean isAfterSuiteConfiguration()
      Returns:
      true if this method was annotated with @Configuration and afterSuite = true

    • isBeforeTestConfiguration

      boolean isBeforeTestConfiguration()
      Returns:
      true if this method is a @BeforeTest (@Configuration beforeTest=true)

    • isAfterTestConfiguration

      boolean isAfterTestConfiguration()
      Returns:
      true if this method is an @AfterTest (@Configuration afterTest=true)

    • isBeforeGroupsConfiguration

      boolean isBeforeGroupsConfiguration()

    • isAfterGroupsConfiguration

      boolean isAfterGroupsConfiguration()

    • hasBeforeGroupsConfiguration

      default boolean hasBeforeGroupsConfiguration()

    • hasAfterGroupsConfiguration

      default boolean hasAfterGroupsConfiguration()

    • getTimeOut

      long getTimeOut()
      Returns:
      The timeout in milliseconds.

    • setTimeOut

      void setTimeOut(long timeOut)

    • getInvocationCount

      int getInvocationCount()
      Returns:
      the number of times this method needs to be invoked.

    • setInvocationCount

      void setInvocationCount(int count)

    • getSuccessPercentage

      int getSuccessPercentage()
      Returns:
      the success percentage for this method (between 0 and 100).

    • getId

      String getId()
      Returns:
      The id of the thread this method was run in.

    • setId

      void setId(String id)

    • getDate

      long getDate()

    • setDate

      void setDate(long date)

    • canRunFromClass

      boolean canRunFromClass(IClass testClass)
      Parameters:
      testClass - The test class
      Returns:
      true if this ITestNGMethod can be invoked from within IClass.

    • isAlwaysRun

      boolean isAlwaysRun()
      Returns:
      true if this method is alwaysRun=true

    • getThreadPoolSize

      int getThreadPoolSize()
      Returns:
      the number of threads to be used when invoking the method on parallel

    • setThreadPoolSize

      void setThreadPoolSize(int threadPoolSize)

    • getEnabled

      boolean getEnabled()

    • getDescription

      String getDescription()

    • setDescription

      void setDescription(String description)

    • incrementCurrentInvocationCount

      void incrementCurrentInvocationCount()

    • getCurrentInvocationCount

      int getCurrentInvocationCount()

    • setParameterInvocationCount

      void setParameterInvocationCount(int n)

    • getParameterInvocationCount

      int getParameterInvocationCount()

    • setMoreInvocationChecker

      void setMoreInvocationChecker(Callable<Boolean> moreInvocationChecker)

    • hasMoreInvocation

      boolean hasMoreInvocation()

    • clone

      ITestNGMethod clone()

    • getRetryAnalyzer

      IRetryAnalyzer getRetryAnalyzer(ITestResult result)

    • setRetryAnalyzerClass

      void setRetryAnalyzerClass(Class<? extends IRetryAnalyzer> clazz)

    • getRetryAnalyzerClass

      Class<? extends IRetryAnalyzer> getRetryAnalyzerClass()

    • skipFailedInvocations

      boolean skipFailedInvocations()

    • setSkipFailedInvocations

      void setSkipFailedInvocations(boolean skip)

    • getInvocationTimeOut

      long getInvocationTimeOut()
      Returns:
      The time under which all invocationCount methods need to complete by.

    • ignoreMissingDependencies

      boolean ignoreMissingDependencies()

    • setIgnoreMissingDependencies

      void setIgnoreMissingDependencies(boolean ignore)

    • getInvocationNumbers

      List<Integer> getInvocationNumbers()
      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 <include invocationNumbers="..."> tag.
      Returns:
      The list of invocation numbers

    • setInvocationNumbers

      void setInvocationNumbers(List<Integer> numbers)

    • addFailedInvocationNumber

      void addFailedInvocationNumber(int number)
      The list of invocation numbers that failed, which is only applicable for methods that have a data provider.
      Parameters:
      number - The invocation number that failed

    • getFailedInvocationNumbers

      List<Integer> getFailedInvocationNumbers()

    • getPriority

      int getPriority()
      The scheduling priority. Lower priorities get scheduled first.
      Returns:
      The priority value

    • setPriority

      void setPriority(int priority)

    • getInterceptedPriority

      int getInterceptedPriority()

    • setInterceptedPriority

      void setInterceptedPriority(int priority)

    • getXmlTest

      XmlTest getXmlTest()
      Returns:
      the XmlTest this method belongs to.

    • getConstructorOrMethod

      org.testng.internal.ConstructorOrMethod getConstructorOrMethod()

    • findMethodParameters

      Map<String,String> findMethodParameters(XmlTest test)
      Parameters:
      test - - The XmlTest object.
      Returns:
      the parameters found in the include tag, if any

    • getQualifiedName

      String getQualifiedName()
      getRealClass().getName() + "." + getMethodName()
      Returns:
      qualified name for this method

    • isDataDriven

      default boolean isDataDriven()

    • getFactoryMethodParamsInfo

      default org.testng.internal.IParameterInfo getFactoryMethodParamsInfo()
      Returns:
      - A IParameterInfo object that represents details about the parameters associated with the factory method.

    • getAttributes

      default CustomAttribute[] getAttributes()
      Returns:
      - An array of CustomAttribute that represents the custom attributes associated with a test.

    • getDataProviderMethod

      default IDataProviderMethod getDataProviderMethod()
      Returns:
      - An IDataProviderMethod for a data provider powered test method and null otherwise.

    • getParameterTypes

      default Class<?>[] getParameterTypes()

    • isIgnoreFailure

      default boolean isIgnoreFailure()
      Returns:
      - true if the configuration failure arising out of this method should be ignored.