Package uk.ac.starlink.ttools.taplint
Interface OutputReporter
- All Superinterfaces:
Reporter
- All Known Implementing Classes:
JsonOutputReporter
,TextOutputReporter
Interface for application-level logging of validation messages.
This extends the Reporter interface to add support for multiple stages.
The design (a single-level hierarchy of reporting stages) is not
particularly elegant or general, and may be revised at some point,
but it serves the current purposes of the TapLint tool.
- Since:
- 24 May 2016
- Author:
- Mark Taylor
-
Method Summary
Modifier and TypeMethodDescriptionvoid
end()
Signals end of reporting.void
Ends the current section.Returns the section code for the most recently-started section.void
Signals beginning of reporting.void
startSection
(String scode, String message) Begins a reporting section.void
Writes to the output stream a summary of messages which were suppressed in a given stage because the maximum repeat count was exceeded.
-
Method Details
-
start
Signals beginning of reporting.- Parameters:
announcements
- header information about validator operation; plain text, one line per element
-
end
void end()Signals end of reporting. -
startSection
Begins a reporting section.- Parameters:
scode
- short fixed-length (3-char?) identifier for the section about to startmessage
- terse (one-line) free-text description of the stage
-
getSectionCode
String getSectionCode()Returns the section code for the most recently-started section.- Returns:
- current section code
-
summariseUnreportedMessages
Writes to the output stream a summary of messages which were suppressed in a given stage because the maximum repeat count was exceeded.- Parameters:
scode
- section code to summarise; if null, no stage filtering is done
-
endSection
void endSection()Ends the current section.
-