package org.testng;

import java.util.Collection;
import java.util.List;
import java.util.Map;

import org.testng.internal.annotations.IAnnotationFinder;
import org.testng.xml.XmlSuite;

import com.google.inject.Injector;

Interface defining a Test Suite.
Author:
Cedric Beust, Aug 6, 2004/**
 * Interface defining a Test Suite.
 *
 * @author Cedric Beust, Aug 6, 2004
 */
public interface ISuite extends IAttributes {

  
Returns:
the name of this suite./** @return the name of this suite. */
  String getName();

  
Returns:
The results for this suite./** @return The results for this suite. */
  Map<String, ISuiteResult> getResults();

  
Returns:
The object factory used to create all test instances./** @return The object factory used to create all test instances. */
  IObjectFactory getObjectFactory();

  IObjectFactory2 getObjectFactory2();

  
Returns:
The output directory used for the reports./** @return The output directory used for the reports. */
  String getOutputDirectory();

  
Returns:
true if the tests must be run in parallel./** @return true if the tests must be run in parallel. */
  String getParallel();

  String getParentModule();

  String getGuiceStage();

  
Params:
parameterName – The name of the parameter
Returns:
The value of this parameter, or null if none was specified./**
   * @param parameterName The name of the parameter
   * @return The value of this parameter, or null if none was specified.
   */
  String getParameter(String parameterName);

  
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./**
   * Retrieves the map of groups and their associated test methods.
   *
   * @return A map where the key is the group and the value is a list of methods used by this group.
   */
  Map<String, Collection<ITestNGMethod>> getMethodsByGroups();

  
Returns:
a list of all the methods that were invoked in this suite./** @return a list of all the methods that were invoked in this suite. */
  List<IInvokedMethod> getAllInvokedMethods();

  
Returns:
All the methods that were not included in this test run./** @return All the methods that were not included in this test run. */
  Collection<ITestNGMethod> getExcludedMethods();

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

  
Returns:
The host where this suite was run, or null if it was run locally. The returned string
    has the form: host:port/**
   * @return The host where this suite was run, or null if it was run locally. The returned string
   *     has the form: host:port
   */
  String getHost();

  
Retrieves the shared state for a suite.
Returns:
the share state of the current suite./**
   * Retrieves the shared state for a suite.
   *
   * @return the share state of the current suite.
   */
  SuiteRunState getSuiteState();

  
Returns:
the annotation finder used for the specified type (JDK5 or javadoc)/** @return the annotation finder used for the specified type (JDK5 or javadoc) */
  IAnnotationFinder getAnnotationFinder();

  
Returns:
The representation of the current XML suite file./** @return The representation of the current XML suite file. */
  XmlSuite getXmlSuite();

  void addListener(ITestNGListener listener);

  Injector getParentInjector();

  void setParentInjector(Injector injector);

  
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./**
   * @return 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.
   */
  List<ITestNGMethod> getAllMethods();
}