testng 7.10.2 · org.testng.ITestNGMethod

Method Summary

Modifier and Type	Method and Description
public void	addFailedInvocationNumber(int The invocation number that failed number) The list of invocation numbers that failed, which is only applicable for methods that have a data provider.
public void	addMethodDependedUpon(String methodName)
public boolean	Returns: true if this ITestNGMethod can be invoked from within IClass. canRunFromClass(IClass The test class testClass)
public ITestNGMethod	clone()
public default Set<ITestNGMethod>	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. downstreamDependencies()
public Map<String, String>	Returns: the parameters found in the include tag, if any findMethodParameters(XmlTest - The `XmlTest` object. test)
public String[]	getAfterGroups()
public default CustomAttribute[]	Returns: - An array of `CustomAttribute` that represents the custom attributes associated with a test. getAttributes()
public String[]	getBeforeGroups()
public ConstructorOrMethod	getConstructorOrMethod()
public int	getCurrentInvocationCount()
public default IDataProviderMethod	Returns: - An `IDataProviderMethod` for a data provider powered test method and `null` otherwise. getDataProviderMethod()
public long	getDate()
public String	getDescription()
public boolean	getEnabled()
public default IParameterInfo	Returns: - A `IParameterInfo` object that represents details about the parameters associated with the factory method. getFactoryMethodParamsInfo()
public List<Integer>	getFailedInvocationNumbers()
public String[]	Returns: The groups this method belongs to, possibly added to the groups declared on the class. getGroups()
public String[]	Returns: The groups this method depends on, possibly added to the groups declared on the class. getGroupsDependedUpon()
public String	Returns: The id of the thread this method was run in. getId()
public Object	getInstance()
public long[]	Returns: The hashcode of instances getInstanceHashCodes() Needed for serialization.
public int	getInterceptedPriority()
public int	Returns: the number of times this method needs to be invoked. getInvocationCount()
public List<Integer>	Returns: The list of invocation numbers getInvocationNumbers() Which invocation numbers of this method should be used (only applicable if it uses a data provider).
public long	Returns: The time under which all invocationCount methods need to complete by. getInvocationTimeOut()
public String	Returns: the method name. getMethodName() Returns the method name.
public String[]	Returns: The methods this method depends on, possibly added to the methods declared on the class. getMethodsDependedUpon()
public String	Returns: If a group was not found. getMissingGroup()
public int	getParameterInvocationCount()
public default Class<?>[]	getParameterTypes()
public int	Returns: The priority value getPriority() The scheduling priority.
public String	Returns: qualified name for this method getQualifiedName() getRealClass().getName() + "." + getMethodName()
public Class<T>	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). getRealClass()
public IRetryAnalyzer	getRetryAnalyzer(ITestResult result)
public Class<? extends IRetryAnalyzer>	getRetryAnalyzerClass()
public int	Returns: the success percentage for this method (between 0 and 100). getSuccessPercentage()
public ITestClass	getTestClass()
public int	Returns: the number of threads to be used when invoking the method on parallel getThreadPoolSize()
public long	Returns: The timeout in milliseconds. getTimeOut()
public XmlTest	Returns: the XmlTest this method belongs to. getXmlTest()
public default boolean	hasAfterGroupsConfiguration()
public default boolean	hasBeforeGroupsConfiguration()
public boolean	hasMoreInvocation()
public boolean	ignoreMissingDependencies()
public void	incrementCurrentInvocationCount()
public boolean	Returns: true if this method was annotated with @Configuration and beforeClassMethod = false isAfterClassConfiguration()
public boolean	isAfterGroupsConfiguration()
public boolean	Returns: true if this method was annotated with @Configuration and beforeTestMethod = false isAfterMethodConfiguration()
public boolean	Returns: true if this method was annotated with @Configuration and afterSuite = true isAfterSuiteConfiguration()
public boolean	Returns: `true` if this method is an @AfterTest (@Configuration afterTest=true) isAfterTestConfiguration()
public boolean	Returns: true if this method is alwaysRun=true isAlwaysRun()
public boolean	Returns: true if this method was annotated with @Configuration and beforeClassMethod = true isBeforeClassConfiguration()
public boolean	isBeforeGroupsConfiguration()
public boolean	Returns: true if this method was annotated with @Configuration and beforeTestMethod = true isBeforeMethodConfiguration()
public boolean	Returns: true if this method was annotated with @Configuration and beforeSuite = true isBeforeSuiteConfiguration()
public boolean	Returns: `true` if this method is a @BeforeTest (@Configuration beforeTest=true) isBeforeTestConfiguration()
public default boolean	isDataDriven()
public default boolean	Returns: - `true` if the configuration failure arising out of this method should be ignored. isIgnoreFailure()
public boolean	Returns: true if this method was annotated with @Test isTest()
public void	setDate(long date)
public void	setDescription(String description)
public void	setId(String id)
public void	setIgnoreMissingDependencies(boolean ignore)
public void	setInterceptedPriority(int priority)
public void	setInvocationCount(int count)
public void	setInvocationNumbers(List<Integer> numbers)
public void	setMissingGroup(String group)
public void	setMoreInvocationChecker(Callable<Boolean> moreInvocationChecker)
public void	setParameterInvocationCount(int n)
public void	setPriority(int priority)
public void	setRetryAnalyzerClass(Class<? extends IRetryAnalyzer> clazz)
public void	setSkipFailedInvocations(boolean skip)
public void	setTestClass(ITestClass The test class having this method. cls) Sets the test class having this method.
public void	setThreadPoolSize(int threadPoolSize)
public void	setTimeOut(long timeOut)
public boolean	skipFailedInvocations()
public default Set<ITestNGMethod>	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. upstreamDependencies()

Method Detail

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

addFailedInvocationNumber

back to summary

public void addFailedInvocationNumber(int number)

The list of invocation numbers that failed, which is only applicable for methods that have a data provider.

Parameters

number:int: The invocation number that failed

addMethodDependedUpon	back to summary
public void addMethodDependedUpon(String methodName)

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

clone	back to summary
public ITestNGMethod clone()

downstreamDependencies	back to summary
public default Set<ITestNGMethod> downstreamDependencies() Returns:Set<ITestNGMethod> - 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.

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

getAfterGroups	back to summary
public String[] getAfterGroups()

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

getBeforeGroups	back to summary
public String[] getBeforeGroups()

getConstructorOrMethod	back to summary
public ConstructorOrMethod getConstructorOrMethod()

getCurrentInvocationCount	back to summary
public int getCurrentInvocationCount()

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

getDate	back to summary
public long getDate()

getDescription	back to summary
public String getDescription()

getEnabled	back to summary
public boolean getEnabled()

getFactoryMethodParamsInfo	back to summary
public default IParameterInfo getFactoryMethodParamsInfo() Returns:IParameterInfo - A `IParameterInfo` object that represents details about the parameters associated with the factory method.

getFailedInvocationNumbers	back to summary
public List<Integer> getFailedInvocationNumbers()

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

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

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

getInstance	back to summary
public Object getInstance()

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

getInstanceHashCodes

back to summary

public long[] getInstanceHashCodes()

Needed for serialization.

Returns:long[]: The hashcode of instances

getInterceptedPriority	back to summary
public int getInterceptedPriority()

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

getInvocationNumbers back to summary

getInvocationNumbers	back to summary
public 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:List<Integer> The list of invocation numbers

public 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:List<Integer>: The list of invocation numbers

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

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

getMethodName

back to summary

public String getMethodName()

Returns the method name. This is needed for serialization because methods are not Serializable.

Returns:String: the method name.

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

getMissingGroup	back to summary
public String getMissingGroup() Returns:String If a group was not found.

getParameterInvocationCount	back to summary
public int getParameterInvocationCount()

getParameterTypes	back to summary
public default Class<?>[] getParameterTypes()

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

getPriority

back to summary

public int getPriority()

The scheduling priority. Lower priorities get scheduled first.

Returns:int: The priority value

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

getQualifiedName

back to summary

public String getQualifiedName()

getRealClass().getName() + "." + getMethodName()

Returns:String: qualified name for this method

getRealClass	back to summary
public Class<T> getRealClass() Returns:Class<T> The real class on which this method was declared (can be different from getMethod().getDeclaringClass() if the test method was defined in a superclass).

getRetryAnalyzer	back to summary
public IRetryAnalyzer getRetryAnalyzer(ITestResult result)

getRetryAnalyzerClass	back to summary
public Class<? extends IRetryAnalyzer> getRetryAnalyzerClass()

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

getTestClass	back to summary
public ITestClass getTestClass()

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

getTimeOut	back to summary
public long getTimeOut() Returns:long The timeout in milliseconds.

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

hasAfterGroupsConfiguration	back to summary
public default boolean hasAfterGroupsConfiguration()

hasBeforeGroupsConfiguration	back to summary
public default boolean hasBeforeGroupsConfiguration()

hasMoreInvocation	back to summary
public boolean hasMoreInvocation()

ignoreMissingDependencies	back to summary
public boolean ignoreMissingDependencies()

incrementCurrentInvocationCount	back to summary
public void incrementCurrentInvocationCount()

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

isAfterGroupsConfiguration	back to summary
public boolean isAfterGroupsConfiguration()

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

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

isAfterTestConfiguration	back to summary
public boolean isAfterTestConfiguration() Returns:boolean `true` if this method is an @AfterTest (@Configuration afterTest=true)

isAlwaysRun	back to summary
public boolean isAlwaysRun() Returns:boolean true if this method is alwaysRun=true

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

isBeforeGroupsConfiguration	back to summary
public boolean isBeforeGroupsConfiguration()

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

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

isBeforeTestConfiguration	back to summary
public boolean isBeforeTestConfiguration() Returns:boolean `true` if this method is a @BeforeTest (@Configuration beforeTest=true)

isDataDriven	back to summary
public default boolean isDataDriven()

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

isTest	back to summary
public boolean isTest() Returns:boolean true if this method was annotated with @Test

setDate	back to summary
public void setDate(long date)

setDescription	back to summary
public void setDescription(String description)

setId	back to summary
public void setId(String id)

setIgnoreMissingDependencies	back to summary
public void setIgnoreMissingDependencies(boolean ignore)

setInterceptedPriority	back to summary
public void setInterceptedPriority(int priority)

setInvocationCount	back to summary
public void setInvocationCount(int count)

setInvocationNumbers	back to summary
public void setInvocationNumbers(List<Integer> numbers)

setMissingGroup	back to summary
public void setMissingGroup(String group)

setMoreInvocationChecker	back to summary
public void setMoreInvocationChecker(Callable<Boolean> moreInvocationChecker)

setParameterInvocationCount	back to summary
public void setParameterInvocationCount(int n)

setPriority	back to summary
public void setPriority(int priority)

setRetryAnalyzerClass	back to summary
public void setRetryAnalyzerClass(Class<? extends IRetryAnalyzer> clazz)

setSkipFailedInvocations	back to summary
public void setSkipFailedInvocations(boolean skip)

setTestClass

back to summary

public void setTestClass(ITestClass cls)

Sets the test class having this method. This is not necessarily the declaring class.

Parameters

cls:ITestClass: The test class having this method.

setThreadPoolSize	back to summary
public void setThreadPoolSize(int threadPoolSize)

setTimeOut	back to summary
public void setTimeOut(long timeOut)

skipFailedInvocations	back to summary
public boolean skipFailedInvocations()

upstreamDependencies	back to summary
public default Set<ITestNGMethod> upstreamDependencies() Returns:Set<ITestNGMethod> - 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.

public Interface ITestNGMethod

Method Summary

Method Detail