Class ReportFileGenerator

java.lang.Object

org.jboss.logging.processor.apt.AbstractGenerator

org.jboss.logging.processor.apt.ReportFileGenerator

@SupportedOptions({"org.jboss.logging.tools.report.type","org.jboss.logging.tools.report.path","org.jboss.logging.tools.report.title"})
public class ReportFileGenerator
extends AbstractGenerator

Generates reports for logging interfaces and message bundles.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private static class	ReportFileGenerator.MessageMethodSortComparator

Field Summary

Fields

Modifier and Type	Field	Description
(package private) static final String	REPORT_PATH
(package private) static final String	REPORT_TITLE
(package private) static final String	REPORT_TYPE
private final String	reportPath
private final String	reportTitle
private final ReportType	reportType

Fields inherited from class AbstractGenerator

processingEnv

Constructor Summary

Constructors

Constructor	Description
ReportFileGenerator(ProcessingEnvironment processingEnv)

Method Summary

Modifier and Type	Method	Description
private BufferedWriter	createWriter(String packageName, String fileName)
private static Collection<MessageMethod>	getSortedMessageMethods(MessageInterface messageInterface)	Returns a sorted collection of the message methods on the interface.
void	processTypeElement(TypeElement annotation, TypeElement element, MessageInterface messageInterface)	Processes a type element.

Methods inherited from class AbstractGenerator

getName, getSupportedOptions, logger

Methods inherited from class Object

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

Field Details

REPORT_TYPE

static final String REPORT_TYPE

See Also:

• Constant Field Values

REPORT_PATH

static final String REPORT_PATH

See Also:

• Constant Field Values

REPORT_TITLE

static final String REPORT_TITLE

See Also:

• Constant Field Values

reportType

private final ReportType reportType

reportPath

private final String reportPath

reportTitle

private final String reportTitle

Constructor Details

ReportFileGenerator

ReportFileGenerator(ProcessingEnvironment processingEnv)

Method Details

processTypeElement

public void processTypeElement(TypeElement annotation,
 TypeElement element,
 MessageInterface messageInterface)

Description copied from class: AbstractGenerator

Processes a type element.

Specified by:

processTypeElement in class AbstractGenerator

Parameters:

annotation - the annotation who trigger the processing

element - the element that contains the methods.

messageInterface - the message interface to implement.

createWriter

private BufferedWriter createWriter(String packageName,
 String fileName)
                             throws IOException

Throws:

IOException

getSortedMessageMethods

private static 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