org.testng

Class Reporter

java.lang.Object

org.testng.Reporter

public class Reporter
extends Object

This class is used for test methods to log messages that will be included in the HTML reports generated by TestNG.

Implementation details

The reporter keeps a combined output of strings (in m_output) and also a record of which method output which line. In order to do this, callers specify what the current method is with setCurrentTestResult() and the Reporter maintains a mapping of each test result with a list of integers. These integers are indices in the combined output (avoids duplicating the output).

Created on Nov 2, 2005

Author:

cbeust

Constructor Summary

Constructors

Constructor and Description
Reporter()

Method Summary

Modifier and Type	Method and Description
static void	clear() Erase the content of all the output generated so far.
static ITestResult	getCurrentTestResult()
static boolean	getEscapeHtml()
static List<String>	getOutput()
static List<String>	getOutput(ITestResult tr)
static void	log(String s) Log the passed string to the HTML reports.
static void	log(String s, boolean logToStandardOut) Log the passed string to the HTML reports.
static void	log(String s, int level) Log the passed string to the HTML reports if the current verbosity is equal to or greater than the one passed as a parameter.
static void	log(String s, int level, boolean logToStandardOut) Log the passed string to the HTML reports if the current verbosity is equal to or greater than the one passed as a parameter.
static void	setCurrentTestResult(ITestResult m)
static void	setEscapeHtml(boolean escapeHtml)

Methods inherited from class java.lang.Object

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

Constructor Detail

Reporter

public Reporter()

Method Detail

setCurrentTestResult

public static void setCurrentTestResult(ITestResult m)

getOutput

public static List<String> getOutput()

clear

public static void clear()

Erase the content of all the output generated so far.

getEscapeHtml

public static boolean getEscapeHtml()

Returns:

If true, use HTML entities for special HTML characters (<, >, &, ...).

setEscapeHtml

public static void setEscapeHtml(boolean escapeHtml)

Parameters:

escapeHtml - If true, use HTML entities for special HTML characters (<, >, &, ...).

log

public static void log(String s)

Log the passed string to the HTML reports.

Parameters:

s - The message to log

log

public static void log(String s,
                       int level,
                       boolean logToStandardOut)

Log the passed string to the HTML reports if the current verbosity is equal to or greater than the one passed as a parameter. If logToStandardOut is true, the string will also be printed on standard out.

Parameters:

s - The message to log

level - The verbosity of this message

logToStandardOut - Whether to print this string on standard out too

log

public static void log(String s,
                       boolean logToStandardOut)

Log the passed string to the HTML reports. If logToStandardOut is true, the string will also be printed on standard out.

Parameters:

s - The message to log

logToStandardOut - Whether to print this string on standard out too

log

public static void log(String s,
                       int level)

Log the passed string to the HTML reports if the current verbosity is equal to or greater than the one passed as a parameter.

Parameters:

s - The message to log

level - The verbosity of this message

getCurrentTestResult

public static ITestResult getCurrentTestResult()

Returns:

the current test result.

getOutput

public static List<String> getOutput(ITestResult tr)