XmlSuite (TestNG 6.8.7 API)

java.lang.Object
- org.testng.xml.XmlSuite

All Implemented Interfaces:

Serializable, Cloneable
```
public class XmlSuite
extends Object
implements Serializable, Cloneable
```
This class describes the tag <suite> in testng.xml.

Author:

Cedric Beust, Alexandru Popescu

See Also:
Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`CONTINUE`
`static Boolean`	`DEFAULT_ALLOW_RETURN_VALUES`
`static String`	`DEFAULT_CONFIG_FAILURE_POLICY` Whether to SKIP or CONTINUE to re-attempt failed configuration methods.
`static Integer`	`DEFAULT_DATA_PROVIDER_THREAD_COUNT` Thread count for the data provider pool
`static Boolean`	`DEFAULT_GROUP_BY_INSTANCES` By default, a method failing will cause all instances of that class to skip
`static Boolean`	`DEFAULT_JUNIT` JUnit compatibility flag.
`static Boolean`	`DEFAULT_MIXED` mixed mode flag.
`static String`	`DEFAULT_PARALLEL`
`static String`	`DEFAULT_PRESERVE_ORDER`
`static Boolean`	`DEFAULT_SKIP_FAILED_INVOCATION_COUNTS`
`static Integer`	`DEFAULT_THREAD_COUNT` The thread count.
`static Integer`	`DEFAULT_VERBOSE` The suite verbose flag.
`static String`	`PARALLEL_CLASSES`
`static String`	`PARALLEL_INSTANCES`
`static String`	`PARALLEL_METHODS`
`static Set<String>`	`PARALLEL_MODES`
`static String`	`PARALLEL_NONE`
`static String`	`PARALLEL_TESTS` Parallel modes
`static String`	`SKIP` Configuration failure policy options

Constructor Summary

Constructors
Constructor and Description

XmlSuite()

Constructors
Constructor and Description
`XmlSuite()`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addExcludedGroup(String g)`
`void`	`addIncludedGroup(String g)`
`void`	`addListener(String listener)`
`void`	`addTest(XmlTest test)`
`Object`	`clone()` Note that this is not a full clone: XmlTest children are not cloned by this method.
`boolean`	`equals(Object obj)`
`Boolean`	`getAllowReturnValues()`
`Map<String,String>`	`getAllParameters()`
`List<XmlSuite>`	`getChildSuites()`
`String`	`getConfigFailurePolicy()` Returns the configuration failure policy.
`int`	`getDataProviderThreadCount()`
`List<String>`	`getExcludedGroups()`
`String`	`getFileName()`
`Boolean`	`getGroupByInstances()`
`XmlGroups`	`getGroups()`
`List<String>`	`getIncludedGroups()`
`List<String>`	`getListeners()`
`List<XmlMethodSelector>`	`getMethodSelectors()` Returns the method selectors.
`String`	`getName()` Returns the name.
`ITestObjectFactory`	`getObjectFactory()`
`Collection<String>`	`getPackageNames()`
`List<XmlPackage>`	`getPackages()`
`String`	`getParallel()` Returns the parallel mode.
`String`	`getParameter(String name)` Returns the parameter defined in this suite only.
`Map<String,String>`	`getParameters()` Gets the parameters that apply to tests in this suite. Set of parameters for a suite is appended with parameters from parent suite.
`XmlSuite`	`getParentSuite()`
`String`	`getPreserveOrder()`
`List<String>`	`getSuiteFiles()` Returns the suite files.
`String`	`getTest()` Returns the test.
`List<XmlTest>`	`getTests()` Returns the tests.
`int`	`getThreadCount()`
`String`	`getTimeOut()` Returns the timeout.
`long`	`getTimeOut(long def)` Returns the timeout as a long value specifying the default value to be used if no timeout was specified.
`Integer`	`getVerbose()` Returns the verbose.
`List<XmlPackage>`	`getXmlPackages()` Returns the XML packages.
`int`	`hashCode()`
`Boolean`	`isJUnit()`
`static boolean`	`isParallel(String parallel)`
`void`	`onListenerElement(String className)`
`void`	`onMethodSelectorElement(String language, String name, String priority)`
`void`	`onPackagesElement(String name)`
`void`	`onParameterElement(String name, String value)`
`void`	`onSuiteFilesElement(String path)`
`void`	`setAllowReturnValues(Boolean allowReturnValues)`
`void`	`setConfigFailurePolicy(String configFailurePolicy)` Sets the configuration failure policy.
`void`	`setDataProviderThreadCount(int count)`
`void`	`setExcludedGroups(List<String> g)`
`void`	`setFileName(String fileName)`
`void`	`setGroupByInstances(boolean f)`
`void`	`setGroups(XmlGroups xmlGroups)`
`void`	`setIncludedGroups(List<String> g)`
`void`	`setJunit(Boolean j)`
`void`	`setJUnit(Boolean isJUnit)` Sets the JUnit compatibility flag.
`void`	`setListeners(List<String> listeners)`
`void`	`setMethodSelectors(List<XmlMethodSelector> methodSelectors)` Sets the method selectors.
`void`	`setMethodSelectors(XmlMethodSelectors xms)`
`void`	`setName(String name)` Sets the name.
`void`	`setObjectFactory(ITestObjectFactory objectFactory)`
`void`	`setPackages(List<XmlPackage> packages)`
`void`	`setParallel(String parallel)` Sets the parallel mode
`void`	`setParameters(Map<String,String> parameters)` Sets parameters.
`void`	`setParentSuite(XmlSuite parentSuite)`
`void`	`setPreserveOrder(String f)`
`void`	`setSkipFailedInvocationCounts(boolean skip)`
`void`	`setSuiteFiles(List<String> files)` Sets the suite files.
`void`	`setTests(List<XmlTest> tests)`
`void`	`setThreadCount(int threadCount)` Set the thread count.
`void`	`setTimeOut(String timeOut)` Sets the timeout.
`void`	`setVerbose(Integer verbose)` Set the verbose.
`void`	`setXmlMethodSelectors(XmlMethodSelectors xms)`
`void`	`setXmlPackages(List<XmlPackage> packages)` Sets the XML packages.
`Boolean`	`skipFailedInvocationCounts()`
`String`	`toString()`
`String`	`toXml()`

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - PARALLEL_TESTS
```
public static final String PARALLEL_TESTS
```
    Parallel modes
    
    See Also:
    Constant Field Values
  - PARALLEL_METHODS
```
public static final String PARALLEL_METHODS
```
    See Also:
    Constant Field Values
  - PARALLEL_CLASSES
```
public static final String PARALLEL_CLASSES
```
    See Also:
    Constant Field Values
  - PARALLEL_INSTANCES
```
public static final String PARALLEL_INSTANCES
```
    See Also:
    Constant Field Values
  - PARALLEL_NONE
```
public static final String PARALLEL_NONE
```
    See Also:
    Constant Field Values
  - PARALLEL_MODES
```
public static Set<String> PARALLEL_MODES
```
  - SKIP
```
public static final String SKIP
```
    Configuration failure policy options
    
    See Also:
    Constant Field Values
  - CONTINUE
```
public static final String CONTINUE
```
    See Also:
    Constant Field Values
  - DEFAULT_VERBOSE
```
public static Integer DEFAULT_VERBOSE
```
    The suite verbose flag. (0 to 10)
  - DEFAULT_PARALLEL
```
public static String DEFAULT_PARALLEL
```
  - DEFAULT_CONFIG_FAILURE_POLICY
```
public static String DEFAULT_CONFIG_FAILURE_POLICY
```
    Whether to SKIP or CONTINUE to re-attempt failed configuration methods.
  - DEFAULT_JUNIT
```
public static Boolean DEFAULT_JUNIT
```
    JUnit compatibility flag.
  - DEFAULT_MIXED
```
public static Boolean DEFAULT_MIXED
```
    mixed mode flag.
  - DEFAULT_SKIP_FAILED_INVOCATION_COUNTS
```
public static Boolean DEFAULT_SKIP_FAILED_INVOCATION_COUNTS
```
  - DEFAULT_THREAD_COUNT
```
public static Integer DEFAULT_THREAD_COUNT
```
    The thread count.
  - DEFAULT_DATA_PROVIDER_THREAD_COUNT
```
public static final Integer DEFAULT_DATA_PROVIDER_THREAD_COUNT
```
    Thread count for the data provider pool
  - DEFAULT_GROUP_BY_INSTANCES
```
public static final Boolean DEFAULT_GROUP_BY_INSTANCES
```
    By default, a method failing will cause all instances of that class to skip
  - DEFAULT_ALLOW_RETURN_VALUES
```
public static Boolean DEFAULT_ALLOW_RETURN_VALUES
```
  - DEFAULT_PRESERVE_ORDER
```
public static String DEFAULT_PRESERVE_ORDER
```
- Constructor Detail
  - XmlSuite
```
public XmlSuite()
```
- Method Detail
  - getFileName
```
public String getFileName()
```
    Returns:
    the fileName
  - setFileName
```
public void setFileName(String fileName)
```
    Parameters:
    fileName - the fileName to set
  - getParallel
```
public String getParallel()
```
    Returns the parallel mode.
    
    Returns:
    the parallel mode.
  - getObjectFactory
```
public ITestObjectFactory getObjectFactory()
```
  - setObjectFactory
```
public void setObjectFactory(ITestObjectFactory objectFactory)
```
  - setParallel
```
public void setParallel(String parallel)
```
    Sets the parallel mode
    
    Parameters:
    parallel - the parallel mode
  - setConfigFailurePolicy
```
public void setConfigFailurePolicy(String configFailurePolicy)
```
    Sets the configuration failure policy.
    
    Parameters:
    configFailurePolicy - the config failure policy
  - getConfigFailurePolicy
```
public String getConfigFailurePolicy()
```
    Returns the configuration failure policy.
    
    Returns:
    the configuration failure policy
  - getVerbose
```
public Integer getVerbose()
```
    Returns the verbose.
    
    Returns:
    the verbose.
  - setVerbose
```
public void setVerbose(Integer verbose)
```
    Set the verbose.
    
    Parameters:
    verbose - The verbose to set.
  - getName
```
public String getName()
```
    Returns the name.
    
    Returns:
    the name.
  - setName
```
public void setName(String name)
```
    Sets the name.
    
    Parameters:
    name - The name to set.
  - getTest
```
public String getTest()
```
    Returns the test.
    
    Returns:
    the test.
  - getTests
```
public List<XmlTest> getTests()
```
    Returns the tests.
    
    Returns:
    the tests.
  - setTests
```
public void setTests(List<XmlTest> tests)
```
  - getMethodSelectors
```
public List<XmlMethodSelector> getMethodSelectors()
```
    Returns the method selectors.
    
    Returns:
    the method selectors.
  - setMethodSelectors
```
public void setMethodSelectors(List<XmlMethodSelector> methodSelectors)
```
    Sets the method selectors.
    
    Parameters:
    methodSelectors - the method selectors.
  - setParameters
```
public void setParameters(Map<String,String> parameters)
```
    Sets parameters.
    
    Parameters:
    parameters - the parameters.
  - getParameters
```
public Map<String,String> getParameters()
```
    Gets the parameters that apply to tests in this suite.
    Set of parameters for a suite is appended with parameters from parent suite. Also, parameters from this suite override the same named parameters from parent suite.
  - getAllParameters
```
public Map<String,String> getAllParameters()
```
    Returns:
    The parameters defined in this suite and all its XmlTests.
  - getParameter
```
public String getParameter(String name)
```
    Returns the parameter defined in this suite only.
    
    Parameters:
    name - the parameter name.
    
    Returns:
    The parameter defined in this suite only.
  - getThreadCount
```
public int getThreadCount()
```
    Returns:
    The threadCount.
  - setThreadCount
```
public void setThreadCount(int threadCount)
```
    Set the thread count.
    
    Parameters:
    threadCount - The thread count to set.
  - isJUnit
```
public Boolean isJUnit()
```
    Returns:
    The JUnit compatibility flag.
  - setJUnit
```
public void setJUnit(Boolean isJUnit)
```
    Sets the JUnit compatibility flag.
    
    Parameters:
    isJUnit - the JUnit compatibility flag.
  - setJunit
```
public void setJunit(Boolean j)
```
  - skipFailedInvocationCounts
```
public Boolean skipFailedInvocationCounts()
```
  - setSkipFailedInvocationCounts
```
public void setSkipFailedInvocationCounts(boolean skip)
```
  - setXmlPackages
```
public void setXmlPackages(List<XmlPackage> packages)
```
    Sets the XML packages.
    
    Parameters:
    packages - the XML packages.
  - getXmlPackages
```
public List<XmlPackage> getXmlPackages()
```
    Returns the XML packages.
    
    Returns:
    the XML packages.
  - getPackages
```
public List<XmlPackage> getPackages()
```
  - setMethodSelectors
```
public void setMethodSelectors(XmlMethodSelectors xms)
```
  - setPackages
```
public void setPackages(List<XmlPackage> packages)
```
  - toXml
```
public String toXml()
```
    Returns:
    A String representation of this XML suite.
  - setXmlMethodSelectors
```
public void setXmlMethodSelectors(XmlMethodSelectors xms)
```
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - clone
```
public Object clone()
```
    Note that this is not a full clone: XmlTest children are not cloned by this method.
    
    Overrides:
    
    clone in class Object
  - setTimeOut
```
public void setTimeOut(String timeOut)
```
    Sets the timeout.
    
    Parameters:
    timeOut - the timeout.
  - getTimeOut
```
public String getTimeOut()
```
    Returns the timeout.
    
    Returns:
    the timeout.
  - getTimeOut
```
public long getTimeOut(long def)
```
    Returns the timeout as a long value specifying the default value to be used if no timeout was specified.
    
    Parameters:
    def - the the default value to be used if no timeout was specified.
    
    Returns:
    the timeout as a long value specifying the default value to be used if no timeout was specified.
  - setSuiteFiles
```
public void setSuiteFiles(List<String> files)
```
    Sets the suite files.
    
    Parameters:
    files - the suite files.
  - getSuiteFiles
```
public List<String> getSuiteFiles()
```
    Returns the suite files.
    
    Returns:
    the suite files.
  - setListeners
```
public void setListeners(List<String> listeners)
```
  - getListeners
```
public List<String> getListeners()
```
  - setDataProviderThreadCount
```
public void setDataProviderThreadCount(int count)
```
  - getDataProviderThreadCount
```
public int getDataProviderThreadCount()
```
  - setParentSuite
```
public void setParentSuite(XmlSuite parentSuite)
```
  - getParentSuite
```
public XmlSuite getParentSuite()
```
  - getChildSuites
```
public List<XmlSuite> getChildSuites()
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - setPreserveOrder
```
public void setPreserveOrder(String f)
```
  - getPreserveOrder
```
public String getPreserveOrder()
```
  - getIncludedGroups
```
public List<String> getIncludedGroups()
```
    Returns:
    Returns the includedGroups. Note: do not modify the returned value, use addIncludedGroup(String).
  - addIncludedGroup
```
public void addIncludedGroup(String g)
```
  - setIncludedGroups
```
public void setIncludedGroups(List<String> g)
```
    Parameters:
    g -
  - setExcludedGroups
```
public void setExcludedGroups(List<String> g)
```
    Parameters:
    g - The excludedGrousps to set.
  - getExcludedGroups
```
public List<String> getExcludedGroups()
```
    Returns:
    Returns the excludedGroups. Note: do not modify the returned value, use addExcludedGroup(String).
  - addExcludedGroup
```
public void addExcludedGroup(String g)
```
  - getGroupByInstances
```
public Boolean getGroupByInstances()
```
  - setGroupByInstances
```
public void setGroupByInstances(boolean f)
```
  - addListener
```
public void addListener(String listener)
```
  - getAllowReturnValues
```
public Boolean getAllowReturnValues()
```
  - setAllowReturnValues
```
public void setAllowReturnValues(Boolean allowReturnValues)
```
  - setGroups
```
public void setGroups(XmlGroups xmlGroups)
```
  - onParameterElement
```
public void onParameterElement(String name,
                      String value)
```
  - onListenerElement
```
public void onListenerElement(String className)
```
  - onSuiteFilesElement
```
public void onSuiteFilesElement(String path)
```
  - onPackagesElement
```
public void onPackagesElement(String name)
```
  - onMethodSelectorElement
```
public void onMethodSelectorElement(String language,
                           String name,
                           String priority)
```
  - getGroups
```
public XmlGroups getGroups()
```
  - addTest
```
public void addTest(XmlTest test)
```
  - getPackageNames
```
public Collection<String> getPackageNames()
```
  - isParallel
```
public static boolean isParallel(String parallel)
```

Class XmlSuite

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

PARALLEL_TESTS

PARALLEL_METHODS

PARALLEL_CLASSES

PARALLEL_INSTANCES

PARALLEL_NONE

PARALLEL_MODES

SKIP

CONTINUE

DEFAULT_VERBOSE

DEFAULT_PARALLEL

DEFAULT_CONFIG_FAILURE_POLICY

DEFAULT_JUNIT

DEFAULT_MIXED

DEFAULT_SKIP_FAILED_INVOCATION_COUNTS

DEFAULT_THREAD_COUNT

DEFAULT_DATA_PROVIDER_THREAD_COUNT

DEFAULT_GROUP_BY_INSTANCES

DEFAULT_ALLOW_RETURN_VALUES

DEFAULT_PRESERVE_ORDER

Constructor Detail

XmlSuite

Method Detail

getFileName

setFileName

getParallel

getObjectFactory

setObjectFactory

setParallel

setConfigFailurePolicy

getConfigFailurePolicy

getVerbose

setVerbose

getName

setName

getTest

getTests

setTests

getMethodSelectors

setMethodSelectors

setParameters

getParameters

getAllParameters

getParameter

getThreadCount

setThreadCount

isJUnit

setJUnit

setJunit

skipFailedInvocationCounts

setSkipFailedInvocationCounts

setXmlPackages

getXmlPackages

getPackages

setMethodSelectors

setPackages

toXml

setXmlMethodSelectors

toString

clone

setTimeOut

getTimeOut

getTimeOut

setSuiteFiles

getSuiteFiles

setListeners

getListeners

setDataProviderThreadCount

getDataProviderThreadCount

setParentSuite

getParentSuite

getChildSuites

hashCode

equals

setPreserveOrder