javarequirementstracer
Class JavaRequirementsTracerBean

java.lang.Object
  javarequirementstracer.JavaRequirementsTracerBean

public final class JavaRequirementsTracerBean
extends java.lang.Object

Class for generating a traceablity report. It scans for Requirements annotations.

Author:

Ronald Koster

See Also:

init()

Constructor Summary

JavaRequirementsTracerBean()

Method Summary

java.lang.String	getExpectedLabelsFilename()
java.lang.String	getParamsFilename()
java.lang.String	getReportFilename()
void	init() Prepare a scan for current options.
void	run() Create a report using current options.
java.util.SortedMap<java.lang.String,java.util.SortedSet<java.lang.String>>	scanRequirements() Does actual tracing (ie.
java.util.SortedSet<java.lang.String>	scanUntraceable()
void	setBuildNumber(java.lang.String buildNumber) Injector.
void	setClassLoader(java.lang.ClassLoader classLoader) Injector.
void	setParamsFilename(java.lang.String paramsFilename) Injector, see init().
void	write(java.util.SortedMap<java.lang.String,java.util.SortedSet<java.lang.String>> codeNamesToLabels, java.util.SortedSet<java.lang.String> untraceableTypes) Write scanned traceability map to the report file indicated by #setReportFileName(String).

Methods inherited from class java.lang.Object

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

Constructor Detail

JavaRequirementsTracerBean

public JavaRequirementsTracerBean()

Method Detail

getParamsFilename

public java.lang.String getParamsFilename()

Returns:

See init().

setParamsFilename

public void setParamsFilename(java.lang.String paramsFilename)

Injector, see init().

getExpectedLabelsFilename

public java.lang.String getExpectedLabelsFilename()

Returns:

See init().

getReportFilename

public java.lang.String getReportFilename()

Returns:

See init().

setClassLoader

public void setClassLoader(java.lang.ClassLoader classLoader)

Injector. ClassLoader to be used for loading this class and the classes to be scanned. Default (null) system ClassLoader is used. Needed for javarequirementstracer.mojo.JrtMojo mainly/only.

setBuildNumber

public void setBuildNumber(java.lang.String buildNumber)

Injector. Optional buildnumber to be used for the reporting.

Parameters:

buildNumber - the buildnumber.

init

public void init()

Prepare a scan for current options.

Throws:

UncheckedException - Wrapper around FileNotFoundException IOException, in case loading the properties from setParamsFilename(String) or #setExpectedLabelsFilename(String) throws such an exception.

run

public void run()

Create a report using current options.

Throws:

UncheckedException - Idem as at init().

scanRequirements

public java.util.SortedMap<java.lang.String,java.util.SortedSet<java.lang.String>> scanRequirements()

Does actual tracing (ie. scanning for Requirements annotations).

Returns:

A map mapping codeElementNames (aka. codeNames) to the requirements labels (aka. labels) they implement according to their annotations.

Throws:

java.lang.IllegalStateException - If init() has not been invoked yet.

scanUntraceable

public java.util.SortedSet<java.lang.String> scanUntraceable()

Returns:

All public or protected types (classes/interfaces) not annotated with Requirements, nor with SuppressTraceabilityWarnings, nor having a supertype annotated with Requirements. NB. Having a supertype annotated with SuppressTraceabilityWarnings will not exclude it from the untraceable report. This is because many Use Case specific service implementations may implement a general technical (thus annotated with SuppressTraceabilityWarnings) interface.

Throws:

java.lang.IllegalStateException - Idem as at scanRequirements().

write

public void write(java.util.SortedMap<java.lang.String,java.util.SortedSet<java.lang.String>> codeNamesToLabels,
                  java.util.SortedSet<java.lang.String> untraceableTypes)

Write scanned traceability map to the report file indicated by #setReportFileName(String). Also reports:

• Which requirement labels were not found.
• All unknown requirement labels found (usually typos).
• All untraceable public or protected types (classes/interfaces), as retuned by scanUntraceable(). (usually the to do list)

Parameters:

codeNamesToLabels - As returned by scanRequirements().

untraceableTypes - As retuned by scanUntraceable().

Throws:

java.lang.RuntimeException - Wrapper around IOException, in case writing to the report file throws such an exception.