org.jboss.logging.processor.apt.report

Class ReportWriter

java.lang.Object

org.jboss.logging.processor.apt.report.ReportWriter

All Implemented Interfaces:

Closeable, AutoCloseable

public abstract class ReportWriter
extends Object
implements Closeable

Writes reports based on a MessageInterface. These reports could be used for documented messages from logging or message bundle interfaces.

Author:

James R. Perkins

Field Summary

Fields

Modifier and Type	Field and Description
protected BufferedWriter	writer The backing writer to use.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ReportWriter(BufferedWriter writer)

Method Summary

Modifier and Type	Method and Description
void	close()
protected String	getLogLevel(MessageMethod method) Gets the log level from the @Message annotation.
protected Collection<MessageMethod>	getSortedMessageMethods(MessageInterface messageInterface) Returns a sorted collection of the message methods on the interface.
static ReportWriter	of(ReportType reportType, BufferedWriter writer) Creates a new report writer based on the report type.
abstract void	write(MessageInterface messageInterface) Writes the message interface to the reports ouput.
void	writeEnd() Writes any ending information for the report.
void	writeStart(Optional<String> title) Writes a header for the report.

Methods inherited from class java.lang.Object

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

Field Detail

writer

protected final BufferedWriter writer

The backing writer to use.

Constructor Detail

ReportWriter

protected ReportWriter(BufferedWriter writer)

Method Detail

of

public static ReportWriter of(ReportType reportType,
                              BufferedWriter writer)

Creates a new report writer based on the report type.

Parameters:

reportType - the report type to create the writer for

writer - the used to write the contents to

Returns:

the report writer to use

Throws:

IllegalStateException - if there was an error creating the report writer

IllegalArgumentException - if the reportType is invalid

write

public abstract void write(MessageInterface messageInterface)
                    throws IOException

Writes the message interface to the reports ouput.

Parameters:

messageInterface - the message interface to write

Throws:

IOException - if a write failure occurs

writeStart

public void writeStart(Optional<String> title)
                throws IOException

Writes a header for the report.

Parameters:

title - the optional title for the report

Throws:

IOException - if a write failure occurs

writeEnd

public void writeEnd()
              throws IOException

Writes any ending information for the report.

Throws:

IOException - if a write failure occurs

close

public void close()
           throws IOException

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Throws:

IOException

getLogLevel

protected String getLogLevel(MessageMethod method)

Gets the log level from the @Message annotation.

Parameters:

method - the method to get the log level from

Returns:

the log level or an empty string

getSortedMessageMethods

protected Collection<MessageMethod> getSortedMessageMethods(MessageInterface messageInterface)

Returns a sorted collection of the message methods on the interface. The methods are sorted by the message id.

Parameters:

messageInterface - the message interface to get the methods for

Returns:

a sorted collection of message methods