Package net.sourceforge.pmd.testframework

Class TestDescriptor

java.lang.Object

net.sourceforge.pmd.testframework.TestDescriptor

public class TestDescriptor
extends Object

Stores the information required to run a complete test.

Constructor Summary

Constructors

Constructor	Description
TestDescriptor()
TestDescriptor(String code, String description, int numberOfProblemsExpected, Rule rule)
TestDescriptor(String code, String description, int numberOfProblemsExpected, Rule rule, LanguageVersion languageVersion)

Method Summary

Modifier and Type	Method	Description
String	getCode()
String	getDescription()
List<Integer>	getExpectedLineNumbers()
List<String>	getExpectedMessages()
LanguageVersion	getLanguageVersion()
int	getNumberInDocument()
int	getNumberOfProblemsExpected()
Properties	getProperties()
boolean	getReinitializeRule()
Rule	getRule()
String	getTestMethodName()
static boolean	inRegressionTestMode()	Checks whether we are testing for regression problems only.
boolean	isRegressionTest()
boolean	isUseAuxClasspath()
void	setExpectedLineNumbers(List<Integer> expectedLineNumbers)
void	setExpectedMessages(List<String> messages)
void	setNumberInDocument(int numberInDocument)
void	setProperties(Properties properties)
void	setRegressionTest(boolean isRegressionTest)
void	setReinitializeRule(boolean reinitializeRule)
void	setUseAuxClasspath(boolean useAuxClasspath)

Methods inherited from class java.lang.Object

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

Constructor Detail

TestDescriptor

public TestDescriptor()

TestDescriptor

public TestDescriptor(String code,
                      String description,
                      int numberOfProblemsExpected,
                      Rule rule)

TestDescriptor

public TestDescriptor(String code,
                      String description,
                      int numberOfProblemsExpected,
                      Rule rule,
                      LanguageVersion languageVersion)

Method Detail

getNumberInDocument

public int getNumberInDocument()

setNumberInDocument

public void setNumberInDocument(int numberInDocument)

setExpectedMessages

public void setExpectedMessages(List<String> messages)

getExpectedMessages

public List<String> getExpectedMessages()

setExpectedLineNumbers

public void setExpectedLineNumbers(List<Integer> expectedLineNumbers)

getExpectedLineNumbers

public List<Integer> getExpectedLineNumbers()

setProperties

public void setProperties(Properties properties)

getProperties

public Properties getProperties()

getCode

public String getCode()

getLanguageVersion

public LanguageVersion getLanguageVersion()

getDescription

public String getDescription()

getNumberOfProblemsExpected

public int getNumberOfProblemsExpected()

getRule

public Rule getRule()

getReinitializeRule

public boolean getReinitializeRule()

setReinitializeRule

public void setReinitializeRule(boolean reinitializeRule)

inRegressionTestMode

public static boolean inRegressionTestMode()

Checks whether we are testing for regression problems only. Return value is based on the system property "pmd.regress".

Returns:

false if system property "pmd.regress" is set to false, true otherwise

isRegressionTest

public boolean isRegressionTest()

setRegressionTest

public void setRegressionTest(boolean isRegressionTest)

setUseAuxClasspath

public void setUseAuxClasspath(boolean useAuxClasspath)

isUseAuxClasspath

public boolean isUseAuxClasspath()

getTestMethodName

public String getTestMethodName()