Module io.jstach.opt.spring.webmvc

Package io.jstach.opt.spring.webmvc

Interface JStachioModelView

All Superinterfaces:

View

All Known Implementing Classes:

HelloModelAndView

public interface JStachioModelView
extends View

Another way to use JStachio with Spring MVC is to have models implement Springs View interface. You can enforce that your models implement this interface with JStacheInterfaces. Alternatively one can call of(Object) on the model and return the result.

This view will by default use the static jstachio singleton and if configured correctly that will be the spring version.

This approach has pros and cons. It makes your models slightly coupled to Spring MVC but allows you to return different views if say you had to redirect on some inputs (RedirectView).

Author:

agentgt

Field Summary

Fields

Modifier and Type	Field	Description
static final int	DEFAULT_BUFFER_LIMIT	The default buffer limit before bailing on trying to set Content-Length.
static final MediaType	DEFAULT_MEDIA_TYPE	The default media type is "text/html; charset=UTF-8".

Fields inherited from interface org.springframework.web.servlet.View

PATH_VARIABLES, RESPONSE_STATUS_ATTRIBUTE, SELECTED_CONTENT_TYPE

Method Summary

Modifier and Type	Method	Description
default Output.CloseableEncodedOutput<IOException>	createOutput(Charset charset, jakarta.servlet.http.HttpServletResponse response)	Creates the output from the servlet response to use for rendering.
default String	getContentType()
default MediaType	getMediaType()	The media type for this view.
default ContextJStachio	jstachio()	Returns the jstachio singleton by default.
default Object	model()	The model to be rendered by jstachio().
static JStachioModelView	of(Object model)	Creates a spring view from a model with content type: "text/html; charset=UTF-8".
static JStachioModelView	of(Object model, String contentType)	Creates a spring view from a model.
static JStachioModelView	of(Object model, MediaType mediaType)	Creates a spring view from a model.
static JStachioModelView	of(Object model, MediaType mediaType, JStachio jstachio)	Creates a spring view from a model.
default void	render(Map<String,?> model, jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response)

Field Details

DEFAULT_MEDIA_TYPE

static final MediaType DEFAULT_MEDIA_TYPE

The default media type is "text/html; charset=UTF-8".

DEFAULT_BUFFER_LIMIT

static final int DEFAULT_BUFFER_LIMIT

The default buffer limit before bailing on trying to set Content-Length. The default is "65536".

See Also:

• Constant Field Values

Method Details

render

default void render(Map<String,?> model,
 jakarta.servlet.http.HttpServletRequest request,
 jakarta.servlet.http.HttpServletResponse response)
             throws Exception

Specified by:

render in interface View

Throws:

Exception

createOutput

default Output.CloseableEncodedOutput<IOException> createOutput(Charset charset,
 jakarta.servlet.http.HttpServletResponse response)

Creates the output from the servlet response to use for rendering.

Parameters:

charset - charset resolved from getMediaType()

response - servlet response

Returns:

output that should be closed when finished

jstachio

default ContextJStachio jstachio()

Returns the jstachio singleton by default.

Returns:

stachio singleton by default.

See Also:

• JStachio.setStatic(java.util.function.Supplier)

model

default Object model()

The model to be rendered by jstachio().

Returns:

model defaulting to this instance.

getContentType

default String getContentType()

Specified by:

getContentType in interface View

getMediaType

default MediaType getMediaType()

The media type for this view. The default is "text/html; charset=UTF-8".

Returns:

the media type

of

static JStachioModelView of(Object model)

Creates a spring view from a model with content type: "text/html; charset=UTF-8".

Parameters:

model - an instance of a class annotated with JStache.

Returns:

view ready for rendering

of

static JStachioModelView of(Object model,
 String contentType)

Creates a spring view from a model.

Parameters:

model - an instance of a class annotated with JStache.

contentType - See getContentType()

Returns:

view ready for rendering

of

static JStachioModelView of(Object model,
 MediaType mediaType)

Creates a spring view from a model.

Parameters:

model - an instance of a class annotated with JStache.

mediaType - the mediaType

Returns:

view ready for rendering

of

static JStachioModelView of(Object model,
 MediaType mediaType,
 JStachio jstachio)

Creates a spring view from a model.

Parameters:

model - an instance of a class annotated with JStache.

mediaType - the mediaType

jstachio - jstachio to use.

Returns:

view ready for rendering