org.testng.ITestClass Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of testng Show documentation
Show all versions of testng Show documentation
Testing framework for Java
package org.testng;
import java.io.Serializable;
/**
* This class represents a test class:
*
* - The test methods
*
- The configuration methods (test and method)
*
- The class file
*
*
* Note that the methods returned by instances of this class
* are expected to be correct at runtime. In other words,
* they might differ from what the ITestMethodFinder returned
* since ITestClass will take into account the groups being
* included and excluded.
*
* @author Cedric Beust
*/
public interface ITestClass extends IClass, Serializable {
/**
* Returns all the instances the methods will be invoked upon.
* This will typically be an array of one object in the absence
* of a @Factory annotation.
*
* @param reuse flag if a new set of instances must be returned
* (if set to false)
* @return All the instances the methods will be invoked upon.
*
* {@inheritDoc}
*/
@Override
Object[] getInstances(boolean reuse);
/**
* TODO cquezel JavaDoc.
*
* {@inheritDoc}
*/
@Override
long[] getInstanceHashCodes();
/**
* @return The number of instances used in this class. This method
* is needed for serialization since we don't know ahead of time if the
* instances of the test classes will be serializable.
*/
@Override
int getInstanceCount();
/**
* Returns all the applicable test methods.
* @return All the applicable test methods.
*/
ITestNGMethod[] getTestMethods();
/**
* Returns all the methods that should be invoked
* before a test method is invoked.
* @return All the methods that should be invoked
* before a test method is invoked.
*/
ITestNGMethod[] getBeforeTestMethods();
/**
* Returns all the methods that should be invoked
* after a test method completes.
* @return All the methods that should be invoked
* after a test method completes.
*/
ITestNGMethod[] getAfterTestMethods();
/**
* Return all the methods that should be invoked
* after the test class has been created and before
* any of its test methods is invoked.
* @return All the methods that should be invoked
* after the test class has been created and before
* any of its test methods is invoked.
*/
ITestNGMethod[] getBeforeClassMethods();
/**
* Returns all the methods that should be invoked
* after all the tests have been run on this class.
* @return All the methods that should be invoked
* after all the tests have been run on this class.
*/
ITestNGMethod[] getAfterClassMethods();
/**
* Returns All the methods that should be invoked
* before the suite is run.
* @return All the methods that should be invoked
* before the suite is run.
*/
ITestNGMethod[] getBeforeSuiteMethods();
/**
* Returns all the methods that should be invoked
* after the suite has run.
* @return All the methods that should be invoked
* after the suite has run.
*/
ITestNGMethod[] getAfterSuiteMethods();
/**
* Returns all @Configuration methods that should be invoked before any others in the
* current test.
* @return all @Configuration methods that should be invoked before any others in the current test.
*/
ITestNGMethod[] getBeforeTestConfigurationMethods();
/**
* Returns all @Configuration methods that should be invoked last before any others
* in the current test.
* @return all @Configuration methods that should be invoked last before any others
* in the current test.
*/
ITestNGMethod[] getAfterTestConfigurationMethods();
/**
* Returns all @Configuration methods that should be invoked before certain groups.
* @return all @Configuration methods that should be invoked before certain groups.
*/
ITestNGMethod[] getBeforeGroupsMethods();
/**
* Returns all @Configuration methods that should be invoked after certain groups.
* @return all @Configuration methods that should be invoked after certain groups.
*/
ITestNGMethod[] getAfterGroupsMethods();
}