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
final JStachio	jstachio	Although not needed You can also wire in JStachio directly
final Template<HelloModel>	view	(Optional) Spring will inject this template as the templates are either component scanned or loaded by the ServiceLoader into Spring's context.

Constructor Summary

Constructors

Constructor	Description
HelloController(JStachio jstachio, Template<HelloModel> view)	Placate JDK 18 Javadoc

Method Summary

Modifier and Type	Method	Description
View	context(Map<String,Object> model)	Here we show MVC model support which will be bound to "@context".
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 could use JStacheInterfaces to make our model implement JStachioModelView 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.
TemplateModel	wired()	Here we use the wired renderer.

Methods inherited from class java.lang.Object

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

Field Details

view

public final Template<HelloModel> view

(Optional) Spring will inject this template as the templates are either component scanned or loaded by the ServiceLoader into Spring's context. This is usually not needed as just returning the models is good enough.

jstachio

public final JStachio jstachio

Although not needed You can also wire in JStachio directly

Constructor Details

HelloController

public HelloController(JStachio jstachio,
 Template<HelloModel> view)

Placate JDK 18 Javadoc

Parameters:

jstachio - spring powered jstachio

view - wired in template

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 could use JStacheInterfaces to make our model implement JStachioModelView 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 and view that will be used as View (see HelloModelAndView).

See Also:

• JStachioHttpMessageConverter
• HelloModelAndView

API Note

Notice that the return type is View.

context

@GetMapping("/context")
public View context(Map<String,Object> model)

Here we show MVC model support which will be bound to "@context".

Parameters:

model - Spring provided model map to be filled

Returns:

the model and view

wired

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

Here we use the wired renderer.

Returns:

template model pair derived from Template.model(Object).