Package org.testng.xml

Class Parser

java.lang.Object

org.testng.xml.Parser

public class Parser
extends java.lang.Object

Parser is a parser for a TestNG XML test suite file.

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	DEFAULT_FILENAME	The default file name for the TestNG test suite if none is specified (testng.xml).
static java.lang.String	DEPRECATED_TESTNG_DTD_URL	The URL to the deprecated TestNG DTD.
static java.lang.String	TESTNG_DTD	The name of the TestNG DTD.
static java.lang.String	TESTNG_DTD_URL	The URL to the TestNG DTD.

Constructor Summary

Constructors

Constructor	Description
Parser()	Creates a parser that will try to find the DEFAULT_FILENAME from the jar.
Parser(java.io.InputStream is)
Parser(java.lang.String fileName)	Constructs a Parser to use the inputStream as the source of the xml test suite to parse.

Method Summary

Modifier and Type	Method	Description
static boolean	canParse(java.lang.String fileName)
static boolean	hasFileScheme(java.lang.String uri)
java.util.Collection<XmlSuite>	parse()	Parses the TestNG test suite and returns the corresponding XmlSuite, and possibly, other XmlSuite that are pointed to by tags.
static java.util.Collection<XmlSuite>	parse(java.io.InputStream is, IPostProcessor processor)
static java.util.Collection<XmlSuite>	parse(java.lang.String suite, IPostProcessor processor)
java.util.List<XmlSuite>	parseToList()
void	setLoadClasses(boolean loadClasses)	If false, don't try to load the classes during the parsing.
void	setPostProcessor(IPostProcessor processor)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

TESTNG_DTD

public static final java.lang.String TESTNG_DTD

The name of the TestNG DTD.

See Also:

Constant Field Values

DEPRECATED_TESTNG_DTD_URL

public static final java.lang.String DEPRECATED_TESTNG_DTD_URL

The URL to the deprecated TestNG DTD.

See Also:

Constant Field Values

TESTNG_DTD_URL

public static final java.lang.String TESTNG_DTD_URL

The URL to the TestNG DTD.

See Also:

Constant Field Values

DEFAULT_FILENAME

public static final java.lang.String DEFAULT_FILENAME

The default file name for the TestNG test suite if none is specified (testng.xml).

See Also:

Constant Field Values

Constructor Detail

Parser

public Parser(java.lang.String fileName)

Constructs a Parser to use the inputStream as the source of the xml test suite to parse.

Parameters:

fileName - the filename corresponding to the inputStream or null if unknown.

Parser

public Parser()
       throws java.io.FileNotFoundException

Creates a parser that will try to find the DEFAULT_FILENAME from the jar.

Throws:

java.io.FileNotFoundException - if the DEFAULT_FILENAME resource is not found in the classpath.

Parser

public Parser(java.io.InputStream is)

Method Detail

setPostProcessor

public void setPostProcessor(IPostProcessor processor)

setLoadClasses

public void setLoadClasses(boolean loadClasses)

If false, don't try to load the classes during the parsing.

parse

public java.util.Collection<XmlSuite> parse()
                                     throws java.io.IOException

Parses the TestNG test suite and returns the corresponding XmlSuite, and possibly, other XmlSuite that are pointed to by tags.

Returns:

the parsed TestNG test suite.

Throws:

java.io.IOException - if an I/O error occurs while parsing the test suite file or if the default testng.xml file is not found.

hasFileScheme

public static boolean hasFileScheme(java.lang.String uri)

Parameters:

uri - - The uri to be verified.

Returns:

- true if the uri has "file:" as its scheme.

parseToList

public java.util.List<XmlSuite> parseToList()
                                     throws java.io.IOException

Throws:

java.io.IOException

parse

public static java.util.Collection<XmlSuite> parse(java.lang.String suite,
                                                   IPostProcessor processor)
                                            throws java.io.IOException

Throws:

java.io.IOException

parse

public static java.util.Collection<XmlSuite> parse(java.io.InputStream is,
                                                   IPostProcessor processor)
                                            throws java.io.IOException

Throws:

java.io.IOException

canParse

public static boolean canParse(java.lang.String fileName)