Module io.jstach.opt.spring.example

Package io.jstach.opt.spring.example.hello

Class HelloController

java.lang.Object

io.jstach.opt.spring.example.hello.HelloController

@Controller
public class HelloController
extends Object

Example hello world controller using different ways to use JStachio for web development.

Author:

agentgt

Field Summary

Fields

Modifier and Type	Field	Description
Template<HelloModel>	view	Spring will inject this as the templates are component scanned as this projects module io.jstach.opt.spring.example has a config that will add @ Component to all generated code.

Constructor Summary

Constructors

Constructor	Description
HelloController()	Placate JDK 18 Javadoc

Method Summary

Modifier and Type	Method	Description
ResponseEntity<HelloModel>	entity()	Here we use a ResponseEntity which allows use to set status codes with our model to be rendered.
HelloModel	hello()	Here we use JStachio runtime to resolve the renderer (in this case we are calling them Views) via Springs Http Message Converter.
View	mvc()	Here we use JStacheInterfaces to make our model implement a Spring View to support the traditional servlet MVC approach.
TemplateModel	templateModel()	Here we use the generated code directly and return a TemplateModel which is analogous to ModelAndView.
void	wired(Writer writer)	Here we use the wired renderer that does not have filtering and thus cannot use JMustache for dynamic editing of templates.

Methods inherited from class java.lang.Object

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

Field Details

view

@Autowired(required=true)
public Template<HelloModel> view

Spring will inject this as the templates are component scanned as this projects module io.jstach.opt.spring.example has a config that will add @ Component to all generated code.

Constructor Details

HelloController

public HelloController()

Placate JDK 18 Javadoc

Method Details

hello

@GetMapping("/")
@ResponseBody
public HelloModel hello()

Here we use JStachio runtime to resolve the renderer (in this case we are calling them Views) via Springs Http Message Converter.

Returns:

the model that will be used to find the correct view and then rendered using that view

See Also:

• JStachioHttpMessageConverter

API Note

Notice that the method has to be annotated with @ResponseBody.

templateModel

@GetMapping("/templateModel")
@ResponseBody
public TemplateModel templateModel()

Here we use the generated code directly and return a TemplateModel which is analogous to ModelAndView.

Returns:

the template model pair that already has the template found.

See Also:

• JStachioHttpMessageConverter

API Note

Notice that the method has to be annotated with @ResponseBody.

entity

@GetMapping("/responseEntity")
public ResponseEntity<HelloModel> entity()

Here we use a ResponseEntity which allows use to set status codes with our model to be rendered.

Returns:

a response entity.

See Also:

• JStachioHttpMessageConverter

mvc

@GetMapping("/mvc")
public View mvc()

Here we use JStacheInterfaces to make our model implement a Spring View to support the traditional servlet MVC approach. The model will use the static jstachio singleton that will be the spring one.

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).

Returns:

the model that will be used as View

See Also:

• JStachioHttpMessageConverter

API Note

Notice that the return type is View.

wired

@GetMapping("/wired")
public void wired(Writer writer)
           throws IOException

Here we use the wired renderer that does not have filtering and thus cannot use JMustache for dynamic editing of templates.

Parameters:

writer - spring will inject the servlet output

Throws:

IOException - an error while writing to the output