Package 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
AViewRenderer
which renders Freemarker (.ftl, .ftlh or .ftlx
) templates.
-
-
Constructor Summary
Constructors Constructor Description FreemarkerViewRenderer()
Deprecated.UseFreemarkerViewRenderer(Version)
instead.FreemarkerViewRenderer(freemarker.template.Version incompatibleImprovementsVersion)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
configure(Map<String,String> baseConfig)
options for configuring the view rendererString
getConfigurationKey()
boolean
isRenderable(View view)
Returnstrue
if the renderer can render the givenView
.void
render(View view, Locale locale, OutputStream output)
-
-
-
Constructor Detail
-
FreemarkerViewRenderer
@Deprecated public FreemarkerViewRenderer()
Deprecated.UseFreemarkerViewRenderer(Version)
instead.
-
FreemarkerViewRenderer
public FreemarkerViewRenderer(freemarker.template.Version incompatibleImprovementsVersion)
- Parameters:
incompatibleImprovementsVersion
- FreeMarker version number for backward compatible bug fixes and improvements. SeeConfiguration(Version)
for more information.
-
-
Method Detail
-
isRenderable
public boolean isRenderable(View view)
Description copied from interface:ViewRenderer
Returnstrue
if the renderer can render the givenView
.- Specified by:
isRenderable
in interfaceViewRenderer
- Parameters:
view
- a view- Returns:
true
ifview
can be rendered
-
render
public void render(View view, Locale locale, OutputStream output) throws IOException
Description copied from interface:ViewRenderer
- Specified by:
render
in interfaceViewRenderer
- Parameters:
view
- a viewlocale
- the locale in which the view should be renderedoutput
- the output stream- Throws:
IOException
- if there is an error writing tooutput
-
configure
public void configure(Map<String,String> baseConfig)
Description copied from interface:ViewRenderer
options for configuring the view renderer- Specified by:
configure
in interfaceViewRenderer
-
getConfigurationKey
public String getConfigurationKey()
- Specified by:
getConfigurationKey
in interfaceViewRenderer
- Returns:
- the key to use in the view configurations, i.e. 'freemarker' or 'mustache'.
-
-