com.philemonworks.selfdiagnose.report
Class ReportMap

java.lang.Object
  com.philemonworks.selfdiagnose.DiagnosticTask
      com.philemonworks.selfdiagnose.PatternMatchingTask
          com.philemonworks.selfdiagnose.check.CheckValueMatches
              com.philemonworks.selfdiagnose.report.ReportMap

All Implemented Interfaces:

Serializable

public class ReportMap
extends CheckValueMatches

ReportProperties can dump the key value pairs of a Map object <reportmap value="${myMap}" comment="my.map"/>

Author:

ernestmicklei

See Also:

Serialized Form

Field Summary

Fields inherited from class com.philemonworks.selfdiagnose.check.CheckValueMatches

PARAMETER_VALUE

Fields inherited from class com.philemonworks.selfdiagnose.PatternMatchingTask

PARAMETER_PATTERN, pattern

Fields inherited from class com.philemonworks.selfdiagnose.DiagnosticTask

comment, PARAMETER_COMMENT, PARAMETER_REPORT, PARAMETER_VARIABLE, reportResults, requestor, variableName

Constructor Summary

ReportMap()

Method Summary

DiagnosticTaskResult	createResult() This method is redefined such that the run method will get a composed result for its argument.
String	getDescription()
void	run(ExecutionContext ctx, DiagnosticTaskResult result) Run the task.

Methods inherited from class com.philemonworks.selfdiagnose.check.CheckValueMatches

getAccessKind, getAccessName, getValue, initializeFromAttributes, setAccessKind, setAccessName, setValue

Methods inherited from class com.philemonworks.selfdiagnose.PatternMatchingTask

checkValueAgainstPattern, getPattern, setPattern

Methods inherited from class com.philemonworks.selfdiagnose.DiagnosticTask

getComment, getDefaultReportTemplate, getRequestor, getTaskName, getVariableName, hasComment, isReportResults, run, run, setComment, setReportResults, setRequestor, setUp, setVariableName

Methods inherited from class java.lang.Object

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

Constructor Detail

ReportMap

public ReportMap()

Method Detail

getDescription

public String getDescription()

Overrides:

getDescription in class CheckValueMatches

Returns:

String the description

run

public void run(ExecutionContext ctx,
                DiagnosticTaskResult result)
         throws DiagnoseException

Description copied from class: DiagnosticTask

Run the task. If an error is detected then raise a DiagnoseException. Otherwise use the result object to the report any messages when a run is completed.

Overrides:

run in class CheckValueMatches

Parameters:

ctx - ExecutionContext

result - DiagnosticTaskResult

Throws:

DiagnoseException

createResult

public DiagnosticTaskResult createResult()

This method is redefined such that the run method will get a composed result for its argument.

Overrides:

createResult in class DiagnosticTask

Returns:

CompositeDiagnosticTaskResult