org.revapi.reporter.text

Class TextReporter

java.lang.Object

org.revapi.reporter.text.TextReporter

All Implemented Interfaces:

AutoCloseable, org.revapi.configuration.Configurable, org.revapi.Reporter

public class TextReporter
extends Object
implements org.revapi.Reporter

Since:

0.1

Author:

Lukas Krejci

Constructor Summary

Constructors

Constructor and Description
TextReporter()

Method Summary

Modifier and Type	Method and Description
void	close()
protected freemarker.template.Configuration	createFreeMarkerConfiguration() Creates a new FreeMarker configuration.
String	getExtensionId()
Reader	getJSONSchema()
void	initialize(org.revapi.AnalysisContext analysis)
void	report(org.revapi.Report report)

Methods inherited from class java.lang.Object

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

Constructor Detail

TextReporter

public TextReporter()

Method Detail

getExtensionId

@Nullable
public String getExtensionId()

Specified by:

getExtensionId in interface org.revapi.configuration.Configurable

getJSONSchema

@Nullable
public Reader getJSONSchema()

Specified by:

getJSONSchema in interface org.revapi.configuration.Configurable

initialize

public void initialize(@Nonnull
                       org.revapi.AnalysisContext analysis)

Specified by:

initialize in interface org.revapi.configuration.Configurable

createFreeMarkerConfiguration

protected freemarker.template.Configuration createFreeMarkerConfiguration()

Creates a new FreeMarker configuration. By default, it is configured as follows:

• compatibility level is set to 2.3.23
• the object wrapper is configured to expose fields
• API builtins are enabled
• there are 2 template loaders - 1 for loading templates from /META-INF using a classloader and a second one to load templates from files.

Returns:

report

public void report(@Nonnull
                   org.revapi.Report report)

Specified by:

report in interface org.revapi.Reporter

close

public void close()
           throws IOException

Specified by:

close in interface AutoCloseable

Throws:

IOException