com.beust.testng
Interface ISuite

All Known Implementing Classes:
SuiteRunner

public interface ISuite

Interface defining a Test Suite.

Author:
Cedric Beust, Aug 6, 2004

Method Summary
 java.util.Collection<ITestNGMethod> getInvokedMethods()
          Retrieves the list of all the methods that were invoked during this run.
 java.util.Map<java.lang.String,java.util.Collection<ITestNGMethod>> getMethodsByGroups()
          Retrieves the map of groups and their associated test methods.
 java.lang.String getName()
           
 java.lang.String getOutputDirectory()
           
 java.lang.String getParameter(java.lang.String parameterName)
           
 java.util.Map<java.lang.String,ISuiteResult> getResults()
           
 boolean isParallel()
           
 void run()
          Triggers the start of running tests included in the suite.
 

Method Detail

getName

java.lang.String getName()
Returns:
the name of this suite.

getResults

java.util.Map<java.lang.String,ISuiteResult> getResults()
Returns:
The results for this suite.

getOutputDirectory

java.lang.String getOutputDirectory()
Returns:
The output directory used for the reports.

isParallel

boolean isParallel()
Returns:
true if the tests must be run in parallel.

getParameter

java.lang.String getParameter(java.lang.String parameterName)
Returns:
The value of this parameter, or null if none was specified.

getMethodsByGroups

java.util.Map<java.lang.String,java.util.Collection<ITestNGMethod>> getMethodsByGroups()
Retrieves the map of groups and their associated test methods.

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

getInvokedMethods

java.util.Collection<ITestNGMethod> getInvokedMethods()
Retrieves the list of all the methods that were invoked during this run.

Returns:
a collection of ITestNGMethods belonging to all tests included in the suite.

run

void run()
Triggers the start of running tests included in the suite.