Package org.testng.remote.strprotocol

Class SuiteMessage

java.lang.Object

org.testng.remote.strprotocol.SuiteMessage

All Implemented Interfaces:

java.io.Serializable, IMessage, IStringMessage

public class SuiteMessage
extends java.lang.Object
implements IStringMessage

A IStringMessage implementation for suite running events.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
private java.util.Map<java.lang.String,java.lang.String>	m_descriptions
private java.util.List<java.lang.String>	m_excludedMethods
protected boolean	m_startSuite
protected java.lang.String	m_suiteName
protected int	m_testMethodCount
private static long	serialVersionUID

Constructor Summary

Constructors

Constructor	Description
SuiteMessage(java.lang.String suiteName, boolean startSuiteRun, int methodCount)
SuiteMessage(org.testng.ISuite suite, boolean startSuiteRun)

Method Summary

Modifier and Type	Method	Description
java.lang.String	getDescriptionForMethod(java.lang.String methodName)
java.util.List<java.lang.String>	getExcludedMethods()
java.lang.String	getMessageAsString()
java.lang.String	getSuiteName()
int	getTestMethodCount()
MessageType	getType()
boolean	isMessageOnStart()
void	setExcludedMethods(java.util.List<java.lang.String> methods)
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

serialVersionUID

private static final long serialVersionUID

See Also:

Constant Field Values

m_suiteName

@SerializedName("suiteName")
protected final java.lang.String m_suiteName

m_testMethodCount

@SerializedName("methodCount")
protected final int m_testMethodCount

m_startSuite

@SerializedName("startSuiteRun")
protected final boolean m_startSuite

m_excludedMethods

@SerializedName("excludedMethods")
private java.util.List<java.lang.String> m_excludedMethods

m_descriptions

private java.util.Map<java.lang.String,java.lang.String> m_descriptions

Constructor Detail

SuiteMessage

public SuiteMessage(java.lang.String suiteName,
                    boolean startSuiteRun,
                    int methodCount)

SuiteMessage

public SuiteMessage(org.testng.ISuite suite,
                    boolean startSuiteRun)

Method Detail

setExcludedMethods

public void setExcludedMethods(java.util.List<java.lang.String> methods)

getExcludedMethods

public java.util.List<java.lang.String> getExcludedMethods()

getDescriptionForMethod

public java.lang.String getDescriptionForMethod(java.lang.String methodName)

isMessageOnStart

public boolean isMessageOnStart()

getSuiteName

public java.lang.String getSuiteName()

getTestMethodCount

public int getTestMethodCount()

getMessageAsString

public java.lang.String getMessageAsString()

Specified by:

getMessageAsString in interface IStringMessage

getType

public MessageType getType()

Specified by:

getType in interface IMessage

Returns:

the message type

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object