io.micronaut.views.jte

Class JteViewsRenderer<T>

java.lang.Object

io.micronaut.views.jte.JteViewsRenderer<T>

Type Parameters:

T - type of input model.

All Implemented Interfaces:

io.micronaut.core.order.Ordered, ViewsRenderer<T>

Direct Known Subclasses:

HtmlJteViewsRenderer, PlainJteViewsRenderer

public abstract class JteViewsRenderer<T>
extends java.lang.Object
implements ViewsRenderer<T>

View renderer using JTE.

Since:

3.1.0

Author:

edward3h

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DEFAULT_EXTENSION

Fields inherited from interface io.micronaut.core.order.Ordered

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	JteViewsRenderer(ViewsConfiguration viewsConfiguration, JteViewsRendererConfiguration jteViewsRendererConfiguration, gg.jte.ContentType contentType, java.nio.file.Path classDirectory)

Method Summary

Modifier and Type	Method and Description
boolean	exists(java.lang.String viewName)
protected gg.jte.TemplateOutput	getOutput(java.io.Writer out) Used during render to construct a JTE TemplateOutput.
io.micronaut.core.io.Writable	render(java.lang.String viewName, T data, io.micronaut.http.HttpRequest<?> request)

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.micronaut.core.order.Ordered

getOrder

Field Detail

DEFAULT_EXTENSION

public static final java.lang.String DEFAULT_EXTENSION

See Also:

Constant Field Values

Constructor Detail

JteViewsRenderer

protected JteViewsRenderer(ViewsConfiguration viewsConfiguration,
                           JteViewsRendererConfiguration jteViewsRendererConfiguration,
                           gg.jte.ContentType contentType,
                           java.nio.file.Path classDirectory)

Parameters:

viewsConfiguration - Views configuration

jteViewsRendererConfiguration - JTE specific configuration

contentType - JTE content type of this renderer

classDirectory - When using dynamic templates, where to generate source and class files

Method Detail

render

@NonNull
public io.micronaut.core.io.Writable render(@NonNull
                                                     java.lang.String viewName,
                                                     @Nullable
                                                     T data,
                                                     @Nullable
                                                     io.micronaut.http.HttpRequest<?> request)

Specified by:

render in interface ViewsRenderer<T>

Parameters:

viewName - view name to be rendered

data - response body to render it with a view

request - HTTP request

Returns:

A writable where the view will be written to.

getOutput

@NonNull
protected gg.jte.TemplateOutput getOutput(java.io.Writer out)

Used during render to construct a JTE TemplateOutput. This is overridable to allow subclasses to specialize the output.

Parameters:

out - Writer to use as target.

Returns:

a TemplateOutput appropriate for the context

exists

public boolean exists(@NonNull
                      java.lang.String viewName)

Specified by:

exists in interface ViewsRenderer<T>

Parameters:

viewName - view name to be rendered

Returns:

true if a template can be found for the supplied view name.