Top Description Methods
org.testng

public Interface ISuite

extends IAttributes
Known Direct Implementers
org.testng.SuiteRunner
Imports
com.google.inject.Injector, java.util.Collection, .List, .Map, org.testng.internal.annotations.IAnnotationFinder, org.testng.xml.XmlSuite
Interface defining a Test Suite.
Author
Cedric Beust, Aug 6, 2004

Method Summary

Modifier and TypeMethod and Description
public void
addListener(ITestNGListener listener)

public List<IInvokedMethod>

Returns:

a list of all the methods that were invoked in this suite.
getAllInvokedMethods()

public List<ITestNGMethod>

Returns:

the total number of methods found in this suite. The presence of factories or data providers might cause the actual number of test methods run be bigger than this list.
getAllMethods()

public IAnnotationFinder

Returns:

the annotation finder used for the specified type (JDK5 or javadoc)
getAnnotationFinder()

public Collection<ITestNGMethod>

Returns:

All the methods that were not included in this test run.
getExcludedMethods()

public String
getGuiceStage()

public String

Returns:

The host where this suite was run, or null if it was run locally. The returned string has the form: host:port
getHost()

public Map<String, Collection<ITestNGMethod>>

Returns:

A map where the key is the group and the value is a list of methods used by this group.
getMethodsByGroups()

Retrieves the map of groups and their associated test methods.

public String

Returns:

the name of this suite.
getName()

public ITestObjectFactory

Returns:

The object factory used to create all test instances.
getObjectFactory()

public String

Returns:

The output directory used for the reports.
getOutputDirectory()

public String

Returns:

true if the tests must be run in parallel.
getParallel()

public String

Returns:

The value of this parameter, or null if none was specified.
getParameter(String
The name of the parameter
parameterName)

public Injector
getParentInjector()

public String
getParentModule()

public Map<String, ISuiteResult>

Returns:

The results for this suite.
getResults()

public SuiteRunState

Returns:

the share state of the current suite.
getSuiteState()

Retrieves the shared state for a suite.

public XmlSuite

Returns:

The representation of the current XML suite file.
getXmlSuite()

public void
run()

Triggers the start of running tests included in the suite.

public void
setParentInjector(Injector injector)

Inherited from org.testng.IAttributes:
getAttributegetAttributeNamesremoveAttributesetAttribute

Method Detail

addListenerback to summary
public void addListener(ITestNGListener listener)
getAllInvokedMethodsback to summary
public List<IInvokedMethod> getAllInvokedMethods()
Returns:List<IInvokedMethod>

a list of all the methods that were invoked in this suite.

getAllMethodsback to summary
public List<ITestNGMethod> getAllMethods()
Returns:List<ITestNGMethod>

the total number of methods found in this suite. The presence of factories or data providers might cause the actual number of test methods run be bigger than this list.

getAnnotationFinderback to summary
public IAnnotationFinder getAnnotationFinder()
Returns:IAnnotationFinder

the annotation finder used for the specified type (JDK5 or javadoc)

getExcludedMethodsback to summary
public Collection<ITestNGMethod> getExcludedMethods()
Returns:Collection<ITestNGMethod>

All the methods that were not included in this test run.

getGuiceStageback to summary
public String getGuiceStage()
getHostback to summary
public String getHost()
Returns:String

The host where this suite was run, or null if it was run locally. The returned string has the form: host:port

getMethodsByGroupsback to summary
public Map<String, Collection<ITestNGMethod>> getMethodsByGroups()

Retrieves the map of groups and their associated test methods.

Returns:Map<String, Collection<ITestNGMethod>>

A map where the key is the group and the value is a list of methods used by this group.

getNameback to summary
public String getName()
Returns:String

the name of this suite.

getObjectFactoryback to summary
public ITestObjectFactory getObjectFactory()
Returns:ITestObjectFactory

The object factory used to create all test instances.

getOutputDirectoryback to summary
public String getOutputDirectory()
Returns:String

The output directory used for the reports.

getParallelback to summary
public String getParallel()
Returns:String

true if the tests must be run in parallel.

getParameterback to summary
public String getParameter(String parameterName)
Parameters
parameterName:String

The name of the parameter

Returns:String

The value of this parameter, or null if none was specified.

getParentInjectorback to summary
public Injector getParentInjector()
getParentModuleback to summary
public String getParentModule()
getResultsback to summary
public Map<String, ISuiteResult> getResults()
Returns:Map<String, ISuiteResult>

The results for this suite.

getSuiteStateback to summary
public SuiteRunState getSuiteState()

Retrieves the shared state for a suite.

Returns:SuiteRunState

the share state of the current suite.

getXmlSuiteback to summary
public XmlSuite getXmlSuite()
Returns:XmlSuite

The representation of the current XML suite file.

runback to summary
public void run()

Triggers the start of running tests included in the suite.

setParentInjectorback to summary
public void setParentInjector(Injector injector)