Top Description Inners Fields Constructors Methods
org.testng.xml

public Class XmlSuite

extends Object
implements Cloneable
Class Inheritance
All Implemented Interfaces
java.lang.Cloneable
Imports
java.util.Collection, .Collections, .List, .Locale, .Map, .Set, .UUID, org.testng.ITestObjectFactory, org.testng.collections.Lists, .Maps, org.testng.internal.RuntimeBehavior, .Utils, org.testng.util.Strings
This class describes the tag <suite> in testng.xml.

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static enum
XmlSuite.FailurePolicy

Configuration failure policy options.

public static enum
XmlSuite.ParallelMode

Parallel modes.

Field Summary

Modifier and TypeField and Description
public static final Boolean
DEFAULT_ALLOW_RETURN_VALUES

public static final XmlSuite.FailurePolicy
DEFAULT_CONFIG_FAILURE_POLICY

Whether to SKIP or CONTINUE to re-attempt failed configuration methods.

public static final Integer
DEFAULT_DATA_PROVIDER_THREAD_COUNT

Thread count for the data provider pool.

public static final Boolean
DEFAULT_GROUP_BY_INSTANCES

By default, a method failing will cause all instances of that class to skip.

public static final Boolean
DEFAULT_MIXED

Mixed mode flag.

public static final XmlSuite.ParallelMode
DEFAULT_PARALLEL

public static final Boolean
DEFAULT_PRESERVE_ORDER

public static final Boolean
DEFAULT_SKIP_FAILED_INVOCATION_COUNTS

private static final String
DEFAULT_SUITE_NAME

The default suite name TODO CQ is this OK as a default name.

public static final Integer
DEFAULT_THREAD_COUNT

The thread count.

public static final Integer
DEFAULT_VERBOSE

The suite verbose flag (0 to 10).

private Boolean
m_allowReturnValues

private final List<XmlSuite>
m_childSuites

List of child XML suites specified using <suite-file> tags.

private XmlSuite.FailurePolicy
m_configFailurePolicy

private int
m_dataProviderThreadCount

private String
m_fileName

Name of the XML file.

private Boolean
m_groupByInstances

private String
m_guiceStage

private List<String>
m_listeners

private List<XmlMethodSelector>
m_methodSelectors

Suite level method selectors.

private String
m_name

The suite name (defaults to DEFAULT_SUITE_NAME).

private Class<? extends ITestObjectFactory>
m_objectFactoryClass

private XmlSuite.ParallelMode
m_parallel

private Map<String, String>
m_parameters

Suite level parameters.

private String
m_parentModule

private XmlSuite
m_parentSuite

Parent XML suite if this suite was specified in another suite using <suite-file> tag.

private Boolean
m_preserveOrder

private Boolean
m_skipFailedInvocationCounts

private List<String>
m_suiteFiles

private String
m_test

private List<XmlTest>
m_tests

Tests in suite.

private int
m_threadCount

private String
m_timeOut

Time out for methods/tests.

private Integer
m_verbose

private XmlGroups
m_xmlGroups

private XmlMethodSelectors
m_xmlMethodSelectors

private List<XmlPackage>
m_xmlPackages

The packages containing test classes.

private boolean
parsed

private boolean
shareThreadPoolForDataProviders

public final UUID
SUITE_ID

Represents a unique id for this suite.

private boolean
useGlobalThreadPool

Constructor Summary

AccessConstructor and Description
public
XmlSuite()

Method Summary

Modifier and TypeMethod and Description
public void
addExcludedGroup(String g)

public void
addIncludedGroup(String g)

public void
addListener(String listener)

public void
addTest(XmlTest test)

public Object
clone()

Overrides java.lang.Object.clone.

Creates and returns a copy of this object.
public boolean
equals(Object
the reference object with which to compare.
obj)

Overrides java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.
pack-priv static boolean
f()

Used to debug equals() bugs.

public Boolean
getAllowReturnValues()

public Map<String, String>

Returns:

The parameters defined in this suite and all its XmlTests.
getAllParameters()

public List<XmlSuite>
getChildSuites()

public XmlSuite.FailurePolicy

Returns:

The configuration failure policy.
getConfigFailurePolicy()

Returns the configuration failure policy.

public int
getDataProviderThreadCount()

public List<String>

Returns:

Returns the excludedGroups.

Note

do not modify the returned value, use addExcludedGroup(String).

getExcludedGroups()

public String

Returns:

The fileName.
getFileName()

public Boolean
getGroupByInstances()

public XmlGroups
getGroups()

public String
getGuiceStage()

public List<String>

Returns:

Returns the includedGroups.

Note

do not modify the returned value, use addIncludedGroup(String).

getIncludedGroups()

public List<String>
getListeners()

public List<String>

Returns:

- The list of listener names that are local to the current <suite>.
getLocalListeners()

public List<XmlMethodSelector>

Returns:

The method selectors.
getMethodSelectors()

Returns the method selectors.

public String

Returns:

The name.
getName()

Returns the name.

public Class<? extends ITestObjectFactory>
getObjectFactoryClass()

public Collection<String>
getPackageNames()

public List<XmlPackage>
getPackages()

public XmlSuite.ParallelMode

Returns:

The parallel mode.
getParallel()

Returns the parallel mode.

public String

Returns:

The parameter defined in this suite only.
getParameter(String
The parameter name.
name)

Returns the parameter defined in this suite only.

public Map<String, String>

Returns:

the parameters that apply to tests in this suite.
The set of parameters for a suite is appended with parameters from the parent suite. Also, parameters from this suite override the same named parameters from the parent suite.
getParameters()

public String
getParentModule()

public XmlSuite
getParentSuite()

public Boolean
getPreserveOrder()

public List<String>

Returns:

The suite files.
getSuiteFiles()

Returns the suite files.

public String

Returns:

The test.
getTest()

Returns the test.

public List<XmlTest>

Returns:

The tests.
getTests()

Returns the tests.

public int

Returns:

The threadCount.
getThreadCount()

public String

Returns:

The timeout.
getTimeOut()

Returns the timeout.

public long

Returns:

The timeout as a long value specifying the default value to be used if no timeout was specified.
getTimeOut(long
The default value to be used if no timeout was specified.
def)

Returns the timeout as a long value specifying the default value to be used if no timeout was specified.

public Integer

Returns:

The verbose.
getVerbose()

Returns the verbose.

public XmlMethodSelectors
getXmlMethodSelectors()

public List<XmlPackage>

Returns:

The XML packages.
getXmlPackages()

Returns the XML packages.

public int
hashCode()

Overrides java.lang.Object.hashCode.

Returns a hash code value for this object.
private void
initGroupsRun()

public boolean

Returns:

- true if the current XmlSuite has already been parsed.
isParsed()

public boolean
isShareThreadPoolForDataProviders()

public void
onListenerElement(String className)

public void
onMethodSelectorElement(String language, String name, String priority)

public void
onPackagesElement(String name)

public void
onParameterElement(String name, String value)

public void
onSuiteFilesElement(String path)

public void
setAllowReturnValues(Boolean allowReturnValues)

public void
setConfigFailurePolicy(XmlSuite.FailurePolicy
The config failure policy.
configFailurePolicy)

Sets the configuration failure policy.

public void
setDataProviderThreadCount(int count)

public void
setExcludedGroups(List<String>
The excludedGrousps to set.
g)

public void
setFileName(String
The fileName to set.
fileName)

public void
setGroupByInstances(boolean f)

public void
setGroups(XmlGroups xmlGroups)

public void
setGuiceStage(String guiceStage)

public void
setIncludedGroups(List<String>
- The list of groups to include.
g)

public void
setListeners(List<String> listeners)

public void
setMethodSelectors(List<XmlMethodSelector>
The method selectors.
methodSelectors)

Sets the method selectors.

public void
setMethodSelectors(XmlMethodSelectors xms)

public void
setName(String
The name to set.
name)

Sets the name.

public void
setObjectFactoryClass(Class<? extends ITestObjectFactory> objectFactoryClass)

public void
setPackages(List<XmlPackage> packages)

public void
setParallel(XmlSuite.ParallelMode
The parallel mode.
parallel)

Sets the parallel mode.

public void
setParameters(Map<String, String>
The parameters.
parameters)

Sets parameters.

public void
setParentModule(String parentModule)

public void
setParentSuite(XmlSuite parentSuite)

public void
setParsed(boolean parsed)

public void
setPreserveOrder(Boolean f)

public void
setShareThreadPoolForDataProviders(boolean shareThreadPoolForDataProviders)

public void
setSkipFailedInvocationCounts(boolean skip)

public void
setSuiteFiles(List<String>
The suite files.
files)

Sets the suite files.

public void
setTests(List<XmlTest> tests)

public void
setThreadCount(int
The thread count to set.
threadCount)

Set the thread count.

public void
setTimeOut(String
The timeout.
timeOut)

Sets the timeout.

public void
setVerbose(Integer
The verbose to set.
verbose)

Set the verbose.

public void
setXmlMethodSelectors(XmlMethodSelectors xms)

public void
setXmlPackages(List<XmlPackage>
The XML packages.
packages)

Sets the XML packages.

public XmlSuite

Returns:

- A shallow copied version of XmlSuite.
shallowCopy()

This method returns a shallow cloned version.

public void
shouldUseGlobalThreadPool(boolean flag)

public Boolean
skipFailedInvocationCounts()

public String
toString()

Overrides java.lang.Object.toString.

Returns a string representation of the object.
public String

Returns:

A String representation of this XML suite.
toXml()

private void
updateParameters()

Updates the list of parameters that apply to this XML suite.

public boolean
useGlobalThreadPool()

Inherited from java.lang.Object:
finalizegetClassnotifynotifyAllwaitwaitwait