jetif
Interface SuiteSpec

public interface SuiteSpec

A SuiteSpec is specification for a suite.

Version:

1.2

Author:

Vicky Wang

Method Summary

String	getClassName() Returns the name of suite class.
HandlerSpec[]	getHandlers() Returns the next handler spec from this suite spec.
String	getName() Returns the name of this suite.
Properties	getProperties() Returns properties from this suite spec.
String	getProxyClass() Returns the proxy class for remote suite.
String	getSource() Returns the source name of this spec.
boolean	hasMoreCases() Test if there are more cases available from this suite spec.
CaseSpec	nextCase() Returns the next case spec from this suite spec.
void	reset() Reset the pointer of cases This method is called when the user want to restart a suite.

Method Detail

getName

public String getName()

Returns the name of this suite.

getSource

public String getSource()

Returns the source name of this spec.

getClassName

public String getClassName()

Returns the name of suite class.

getProxyClass

public String getProxyClass()

Returns the proxy class for remote suite. This suite will be treated as remote suite if the proxy class is set.

Returns:

the proxy class name.

reset

public void reset()

Reset the pointer of cases This method is called when the user want to restart a suite. The framework is desired to reload specs for all test cases.

hasMoreCases

public boolean hasMoreCases()

Test if there are more cases available from this suite spec.

Returns:

true if there is at least one case spec in this suite spec after current position.

nextCase

public CaseSpec nextCase()
                  throws NoSuchElementException

Returns the next case spec from this suite spec.

Returns:

the next case spec from this suite spec.

Throws:

NoSuchElementException - if there are no more case specs in this suite spec.

getHandlers

public HandlerSpec[] getHandlers()

Returns the next handler spec from this suite spec. The null value is NOT allowed, an empty array should be returned if there is no custom handler for this suite.

Returns:

array of custom handlers defined for this suite.

getProperties

public Properties getProperties()

Returns properties from this suite spec. Can be null if there is no properties for this suite.

Returns:

a properties object.