Package gov.niem.tools.api.validation

Class Test

java.lang.Object

gov.niem.tools.api.validation.Test

public class Test
extends Object

Information about a validation test.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	Test.Severity	Kinds of test severity (error, warning, info).
static class	Test.TestBuilder

Field Summary

Fields

Modifier and Type	Field	Description
String	category
String	comments
String	component
String	description
String	exampleInvalid
String	exampleValid
String	exceptionLabels
String	exceptions
String	field
String	id
String	notes
boolean	ran
List<TestResult>	results
String	ruleNumber
String	ruleUrl
float	runtime	Test runtime in seconds.
String	scope
Test.Severity	severity
String	source
String	specId
String	specUrl
TestResult.Status	status

Constructor Summary

Constructors

Constructor	Description
Test()
Test(TestResult.Status status, String id, String description, Test.Severity severity, String category, String component, String field, String comments, String scope, String source, String specId, String specUrl, String ruleNumber, String ruleUrl, String exampleValid, String exampleInvalid, String exceptions, String exceptionLabels, String notes, boolean ran, float runtime, long start, List<TestResult> results)	Creates a new Test instance.
Test(String id)
Test(String id, String description)

Method Summary

Modifier and Type	Method	Description
static Test.TestBuilder	builder()
protected boolean	canEqual(Object other)
long	countErrors()
long	countInfo()
long	countPassed()
long	countWarnings()
void	endTest()	Marks the test as ran and calculates the runtime.
boolean	equals(Object o)
String	getCategory()
String	getComments()
String	getComponent()
String	getDescription()
String	getExampleInvalid()
String	getExampleValid()
String	getExceptionLabels()
String	getExceptions()
String	getField()
String	getId()
String	getNotes()
List<TestResult>	getResults()
String	getRuleNumber()
String	getRuleUrl()
float	getRuntime()	Test runtime in seconds.
String	getScope()
Test.Severity	getSeverity()
String	getSource()
String	getSpecId()
String	getSpecUrl()
long	getStart()
TestResult.Status	getStatus()
int	hashCode()
boolean	isRan()
void	setCategory(String category)
void	setComments(String comments)
void	setComponent(String component)
void	setDescription(String description)
void	setExampleInvalid(String exampleInvalid)
void	setExampleValid(String exampleValid)
void	setExceptionLabels(String exceptionLabels)
void	setExceptions(String exceptions)
void	setField(String field)
void	setId(String id)
void	setNotes(String notes)
void	setRan(boolean ran)
void	setResults(List<TestResult> results)
void	setRuleNumber(String ruleNumber)
void	setRuleUrl(String ruleUrl)
void	setRuntime(float runtime)	Test runtime in seconds.
void	setScope(String scope)
void	setSeverity(Test.Severity severity)
void	setSource(String source)
void	setSpecId(String specId)
void	setSpecUrl(String specUrl)
void	setStart(long start)
void	setStatus(TestResult.Status status)
void	startTest()	Starts the test and stores the current time for the test runtime calculation.
void	startTest(Test.Severity severity)	Starts the test and stores the current time for the test runtime calculation.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

status

public TestResult.Status status

id

public String id

description

public String description

severity

public Test.Severity severity

category

public String category

component

public String component

field

public String field

comments

public String comments

scope

public String scope

source

public String source

specId

public String specId

specUrl

public String specUrl

ruleNumber

public String ruleNumber

ruleUrl

public String ruleUrl

exampleValid

public String exampleValid

exampleInvalid

public String exampleInvalid

exceptions

public String exceptions

exceptionLabels

public String exceptionLabels

notes

public String notes

ran

public boolean ran

runtime

public float runtime

Test runtime in seconds.

results

public List<TestResult> results

Constructor Details

Test

public Test(String id)

Test

public Test(String id,
 String description)

Test

public Test()

Test

public Test(TestResult.Status status,
 String id,
 String description,
 Test.Severity severity,
 String category,
 String component,
 String field,
 String comments,
 String scope,
 String source,
 String specId,
 String specUrl,
 String ruleNumber,
 String ruleUrl,
 String exampleValid,
 String exampleInvalid,
 String exceptions,
 String exceptionLabels,
 String notes,
 boolean ran,
 float runtime,
 long start,
 List<TestResult> results)

Creates a new Test instance.

Parameters:

status -

id -

description -

severity -

category -

component -

field -

comments -

scope -

source -

specId -

specUrl -

ruleNumber -

ruleUrl -

exampleValid -

exampleInvalid -

exceptions -

exceptionLabels -

notes -

ran -

runtime - Test runtime in seconds.

start -

results -

Method Details

startTest

public void startTest()

Starts the test and stores the current time for the test runtime calculation.

startTest

public void startTest(Test.Severity severity)

Starts the test and stores the current time for the test runtime calculation.

endTest

public void endTest()

Marks the test as ran and calculates the runtime.

countWarnings

public long countWarnings()

countErrors

public long countErrors()

countInfo

public long countInfo()

countPassed

public long countPassed()

builder

public static Test.TestBuilder builder()

getStatus

public TestResult.Status getStatus()

getId

public String getId()

getDescription

public String getDescription()

getSeverity

public Test.Severity getSeverity()

getCategory

public String getCategory()

getComponent

public String getComponent()

getField

public String getField()

getComments

public String getComments()

getScope

public String getScope()

getSource

public String getSource()

getSpecId

public String getSpecId()

getSpecUrl

public String getSpecUrl()

getRuleNumber

public String getRuleNumber()

getRuleUrl

public String getRuleUrl()

getExampleValid

public String getExampleValid()

getExampleInvalid

public String getExampleInvalid()

getExceptions

public String getExceptions()

getExceptionLabels

public String getExceptionLabels()

getNotes

public String getNotes()

isRan

public boolean isRan()

getRuntime

public float getRuntime()

Test runtime in seconds.

getStart

public long getStart()

getResults

public List<TestResult> getResults()

setStatus

public void setStatus(TestResult.Status status)

setId

public void setId(String id)

setDescription

public void setDescription(String description)

setSeverity

public void setSeverity(Test.Severity severity)

setCategory

public void setCategory(String category)

setComponent

public void setComponent(String component)

setField

public void setField(String field)

setComments

public void setComments(String comments)

setScope

public void setScope(String scope)

setSource

public void setSource(String source)

setSpecId

public void setSpecId(String specId)

setSpecUrl

public void setSpecUrl(String specUrl)

setRuleNumber

public void setRuleNumber(String ruleNumber)

setRuleUrl

public void setRuleUrl(String ruleUrl)

setExampleValid

public void setExampleValid(String exampleValid)

setExampleInvalid

public void setExampleInvalid(String exampleInvalid)

setExceptions

public void setExceptions(String exceptions)

setExceptionLabels

public void setExceptionLabels(String exceptionLabels)

setNotes

public void setNotes(String notes)

setRan

public void setRan(boolean ran)

setRuntime

public void setRuntime(float runtime)

Test runtime in seconds.

setStart

public void setStart(long start)

setResults

public void setResults(List<TestResult> results)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

canEqual

protected boolean canEqual(Object other)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object