Module io.jstach.opt.spring.example

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

Class HelloModelView

java.lang.Object

io.jstach.opt.spring.example.hello.HelloModelView

All Implemented Interfaces:

Renderer<io.jstach.opt.spring.example.hello.HelloModel>, JStachioFilter.FilterChain, TemplateProvider, Template<io.jstach.opt.spring.example.hello.HelloModel>, TemplateInfo

@Component
public class HelloModelView
extends Object
implements Template<io.jstach.opt.spring.example.hello.HelloModel>, TemplateInfo, TemplateProvider, JStachioFilter.FilterChain

Generated Renderer.

Nested Class Summary

Nested classes/interfaces inherited from interface io.jstach.jstachio.TemplateInfo

TemplateInfo.TemplateSource

Constructor Summary

Constructors

Constructor	Description
HelloModelView()	Renderer constructor for reflection (use of() instead).
HelloModelView(TemplateConfig templateConfig)	Renderer constructor using config.
HelloModelView(Function<Object,String> formatter, Function<String,String> escaper)	Renderer constructor for manual wiring.

Method Summary

Modifier and Type	Method	Description
void	execute(io.jstach.opt.spring.example.hello.HelloModel model, Appendable a)	Renders the passed in model.
void	execute(io.jstach.opt.spring.example.hello.HelloModel model, Appendable a, Formatter formatter, Escaper escaper)	Renders the passed in model.
Class<?>	modelClass()	Model class.
static HelloModelView	of()	Convience static factory that will reuse the same singleton instance.
static <A extends Appendable> void	render(io.jstach.opt.spring.example.hello.HelloModel data, A unescapedWriter, Formatter formatter, Appender<? super A> escaper, Appender<A> appender)	Renders the passed in model.
boolean	supportsType(Class<?> type)	Checks to see if a template supports the model class.
Appender<Appendable>	templateAppender()	Appender.
Class<?>	templateContentType()	The template content type is the class annotated with JStacheContentType which also describes the escaper to be used.
Escaper	templateEscaper()	The escaper to be used on the template.
Formatter	templateFormatter()	The base formatter to be used on the template.
String	templateName()	The logical name of the template which maybe different than TemplateInfo.templatePath().
String	templatePath()	If the template is a classpath resource file this will return the location that was originally resolved via config resolution.
String	templateString()	The raw contents of the template.

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.jstach.jstachio.Renderer

execute, execute

Methods inherited from interface io.jstach.jstachio.Template

execute

Methods inherited from interface io.jstach.jstachio.TemplateInfo

description, lastLoaded, normalizePath, templateSource

Methods inherited from interface io.jstach.jstachio.spi.TemplateProvider

provideTemplates

Constructor Details

HelloModelView

public HelloModelView(Function<Object,String> formatter,
 Function<String,String> escaper)

Renderer constructor for manual wiring.

Parameters:

formatter - formatter if null the static formatter will be used.

escaper - escaper if null the static escaper will be used

HelloModelView

public HelloModelView()

Renderer constructor for reflection (use of() instead). For programmatic consider using of() for a shared singleton.

HelloModelView

public HelloModelView(TemplateConfig templateConfig)

Renderer constructor using config.

Parameters:

templateConfig - config that has collaborators

Method Details

execute

public void execute(io.jstach.opt.spring.example.hello.HelloModel model,
 Appendable a)
             throws IOException

Description copied from interface: Template

Renders the passed in model.

Specified by:

execute in interface Renderer<io.jstach.opt.spring.example.hello.HelloModel>

Specified by:

execute in interface Template<io.jstach.opt.spring.example.hello.HelloModel>

Parameters:

model - a model assumed never to be null.

a - the appendable to write to.

Throws:

IOException - if there is an error writing to the appendable

execute

public void execute(io.jstach.opt.spring.example.hello.HelloModel model,
 Appendable a,
 Formatter formatter,
 Escaper escaper)
             throws IOException

Description copied from interface: Template

Renders the passed in model.

Specified by:

execute in interface Template<io.jstach.opt.spring.example.hello.HelloModel>

Parameters:

model - a model assumed never to be null.

a - appendable to write to.

formatter - formats variables before they are passed to the escaper

escaper - used to write escaped variables

Throws:

IOException - if an error occurs while writing to the appendable

supportsType

public boolean supportsType(Class<?> type)

Description copied from interface: TemplateInfo

Checks to see if a template supports the model class.

Specified by:

supportsType in interface TemplateInfo

Parameters:

type - the class of the model.

Returns:

if this renderer supports the class.

templatePath

public String templatePath()

Description copied from interface: TemplateInfo

If the template is a classpath resource file this will return the location that was originally resolved via config resolution.

Specified by:

templatePath in interface TemplateInfo

Returns:

the location of the template or empty if the template is inlined.

See Also:

• TemplateInfo.normalizePath()

templateName

public String templateName()

Description copied from interface: TemplateInfo

The logical name of the template which maybe different than TemplateInfo.templatePath().

Specified by:

templateName in interface TemplateInfo

Returns:

logical name of template. Never null.

templateString

public String templateString()

Description copied from interface: TemplateInfo

The raw contents of the template. Useful if the template is inline. To determine if the template is actually inline use TemplateInfo.templateSource().

Specified by:

templateString in interface TemplateInfo

Returns:

the raw contents of the template never null.

See Also:

• TemplateInfo.TemplateSource

templateContentType

public Class<?> templateContentType()

Description copied from interface: TemplateInfo

The template content type is the class annotated with JStacheContentType which also describes the escaper to be used.

Specified by:

templateContentType in interface TemplateInfo

Returns:

the template content type.

templateEscaper

public Escaper templateEscaper()

Description copied from interface: TemplateInfo

The escaper to be used on the template. See Escaper.of(Function).

Specified by:

templateEscaper in interface TemplateInfo

Returns:

the escaper.

See Also:

• Escaper

templateFormatter

public Formatter templateFormatter()

Description copied from interface: TemplateInfo

The base formatter to be used on the template. See Formatter.of(Function).

Specified by:

templateFormatter in interface TemplateInfo

Returns:

the formatter.

See Also:

• Formatter

templateAppender

public Appender<Appendable> templateAppender()

Appender.

Returns:

appender for writing unescaped variables.

modelClass

public Class<?> modelClass()

Model class.

Specified by:

modelClass in interface Template<io.jstach.opt.spring.example.hello.HelloModel>

Returns:

class used as model (annotated with JStache).

of

public static HelloModelView of()

Convience static factory that will reuse the same singleton instance.

Returns:

renderer same as calling no-arg constructor but is cached with singleton instance

render

public static <A extends Appendable> void render(io.jstach.opt.spring.example.hello.HelloModel data,
 A unescapedWriter,
 Formatter formatter,
 Appender<? super A> escaper,
 Appender<A> appender)
                                          throws IOException

Renders the passed in model.

Type Parameters:

A - appendable type.

Parameters:

data - model

unescapedWriter - appendable to write to.

formatter - formats variables before they are passed to the escaper.

escaper - used to write escaped variables.

appender - used to write unescaped variables.

Throws:

IOException - if an error occurs while writing to the appendable