Class ReportWriter
java.lang.Object
org.jboss.logging.processor.apt.report.ReportWriter
- All Implemented Interfaces:
Closeable
,AutoCloseable
Writes reports based on a
MessageInterface
. These reports could be used for documented messages from logging
or message bundle interfaces.- Author:
- James R. Perkins
-
Method Summary
Modifier and TypeMethodDescriptionstatic ReportWriter
of
(ReportType reportType, MessageInterface messageInterface, BufferedWriter writer) Creates a new report writer based on the report type.abstract void
writeDetail
(MessageMethod messageMethod) Writes a detail line for the report.abstract void
Writes the footer for the report.abstract void
writeHeader
(String title) Writes the header for the report.
-
Method Details
-
of
public static ReportWriter of(ReportType reportType, MessageInterface messageInterface, BufferedWriter writer) Creates a new report writer based on the report type.- Parameters:
reportType
- the report type to create the writer forwriter
- the used to write the contents to- Returns:
- the report writer to use
- Throws:
IllegalStateException
- if there was an error creating the report writerIllegalArgumentException
- if thereportType
is invalid
-
writeHeader
Writes the header for the report.- Parameters:
title
- the title of the header- Throws:
IOException
- if an I/O error occurs
-
writeDetail
Writes a detail line for the report.- Parameters:
messageMethod
- the method to write the details for- Throws:
IOException
- if an I/O error occurs
-