io.dropwizard.views.freemarker

Class FreemarkerViewRenderer

java.lang.Object

io.dropwizard.views.freemarker.FreemarkerViewRenderer

All Implemented Interfaces:

ViewRenderer

public class FreemarkerViewRenderer
extends Object
implements ViewRenderer

A ViewRenderer which renders Freemarker (.ftl, .ftlh or .ftlx) templates.

Constructor Summary

Constructors

Constructor and Description
FreemarkerViewRenderer() Deprecated. Use FreemarkerViewRenderer(Version) instead.
FreemarkerViewRenderer(freemarker.template.Version incompatibleImprovementsVersion)

Method Summary

Modifier and Type	Method and Description
void	configure(Map<String,String> baseConfig) options for configuring the view renderer
String	getConfigurationKey()
boolean	isRenderable(View view) Returns true if the renderer can render the given View.
void	render(View view, Locale locale, OutputStream output) Renders the given View for the given Locale to the given OutputStream.

Methods inherited from class java.lang.Object

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

Constructor Detail

FreemarkerViewRenderer

public FreemarkerViewRenderer()

Deprecated. Use FreemarkerViewRenderer(Version) instead.

FreemarkerViewRenderer

public FreemarkerViewRenderer(freemarker.template.Version incompatibleImprovementsVersion)

Parameters:

incompatibleImprovementsVersion - FreeMarker version number for backward compatible bug fixes and improvements. See Configuration(Version) for more information.

Method Detail

isRenderable

public boolean isRenderable(View view)

Description copied from interface: ViewRenderer

Returns true if the renderer can render the given View.

Specified by:

isRenderable in interface ViewRenderer

Parameters:

view - a view

Returns:

true if view can be rendered

render

public void render(View view,
                   Locale locale,
                   OutputStream output)
            throws IOException

Description copied from interface: ViewRenderer

Renders the given View for the given Locale to the given OutputStream.

Specified by:

render in interface ViewRenderer

Parameters:

view - a view

locale - the locale in which the view should be rendered

output - the output stream

Throws:

IOException - if there is an error writing to output

configure

public void configure(Map<String,String> baseConfig)

Description copied from interface: ViewRenderer

options for configuring the view renderer

Specified by:

configure in interface ViewRenderer

getConfigurationKey

public String getConfigurationKey()

Specified by:

getConfigurationKey in interface ViewRenderer

Returns:

the key to use in the view configurations, i.e. 'freemarker' or 'mustache'.