Package io.dropwizard.views.common

Interface ViewRenderer

All Known Implementing Classes:

FreemarkerViewRenderer, MustacheViewRenderer

public interface ViewRenderer

The rendering engine for a type of view.

Method Summary

Modifier and Type	Method	Description
void	configure(Map<String,String> options)	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.

Method Detail

isRenderable

boolean isRenderable(View view)

Returns true if the renderer can render the given View.

Parameters:

view - a view

Returns:

true if view can be rendered

render

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

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

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

jakarta.ws.rs.WebApplicationException - if there is an error rendering the template

configure

void configure(Map<String,String> options)

options for configuring the view renderer

Parameters:

options -

getConfigurationKey

String getConfigurationKey()

Returns:

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