Package gov.nist.secauto.decima.core.assessment.result

Class BasicTestResult

java.lang.Object

gov.nist.secauto.decima.core.assessment.result.BasicTestResult

All Implemented Interfaces:

TestResult

public class BasicTestResult
extends Object
implements TestResult

Describes a Context within a content instance where a DerivedRequirement was tested and found to be evaluated to some status. This class supports a list of result values that are generated during the assessment evaluation that further provide context. These values are used in the formatting of result messages based on the format string of the DerivedRequirement.

Constructor Summary

Constructors

Constructor	Description
BasicTestResult(String testId, TestStatus result, Context context)	Construct a new test result.

Method Summary

Modifier and Type	Method	Description
void	addResultValue(String value)	Adds a new result value to the ordered collection of result values.
void	addResultValues(Collection<String> values)	Adds a number of new result value to the end of the ordered collection of result values.
Context	getContext()	This is the location context of the test result within the tested content instance.
List<String>	getResultValues()	A set of values passed back from a test result that can be used to format a message pertaining to the result of the assessment.
TestStatus	getStatus()	The outcome of the test.
String	getTestId()
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

BasicTestResult

public BasicTestResult(String testId,
                       TestStatus result,
                       Context context)

Construct a new test result.

Parameters:

testId - the identifier for the test performed

result - the result of the test performed

context - the document context associated with the test result

Method Detail

getTestId

public String getTestId()

Specified by:

getTestId in interface TestResult

getStatus

public TestStatus getStatus()

Description copied from interface: TestResult

The outcome of the test.

Specified by:

getStatus in interface TestResult

Returns:

the status

addResultValue

public void addResultValue(String value)

Adds a new result value to the ordered collection of result values. This value must be non-null.

Parameters:

value - the new result value to add

addResultValues

public void addResultValues(Collection<String> values)

Adds a number of new result value to the end of the ordered collection of result values. This value must be non-null.

Parameters:

values - the new result values to add

getResultValues

public List<String> getResultValues()

Description copied from interface: TestResult

A set of values passed back from a test result that can be used to format a message pertaining to the result of the assessment.

Specified by:

getResultValues in interface TestResult

Returns:

a list of zero or more values

See Also:

DerivedRequirement.getMessageText(String...)

getContext

public Context getContext()

Description copied from interface: TestResult

This is the location context of the test result within the tested content instance. Must be non-null. My trivially return the document root.

Specified by:

getContext in interface TestResult

Returns:

a context sub-class

toString

public String toString()

Overrides:

toString in class Object