Module io.jstach.jstachio

Package io.jstach.jstachio

@NonNullByDefault package io.jstach.jstachio

JStachio Core Runtime API. JStachio makes it easier to render models without direct access to the generated code.

The other interfaces and classes in this package are used by generated code that is of type JStacheType.JSTACHIO.

The notable other interfaces that this package provides are:

• Appender
• Escaper
• Formatter

When a template outputs an escaped variable the callstack is as follows:

 formatter --> escaper --> appendable
 

When a template outputs an unescaped variable the callstack is as follows:

 formatter --> appender --> appendable
 

When a template outputs anything else (e.g. HTML markup) it writes directly to the appendable.

See Also:

• io.jstach.jstachio.spi
• io.jstach.jstache

Related Packages

Package	Description
io.jstach.jstachio.context	JStachio extended Mustache context support for context stack as well as Map and JSON tree like models.
io.jstach.jstachio.escapers	Builtin Escapers.
io.jstach.jstachio.formatters	Builtin Formatters.
io.jstach.jstachio.output	Output utility classes particularly for leveraging pre-encoding efficiently and shared integration logic for plugging into web application frameworks.
io.jstach.jstachio.spi	JStachio Service Provider extension points API.

Class	Description
Appender	A singleton like decorator for appendables that has additional methods for dealing with native types used to output variables that have been formatted.
Escaper	An Escaper is an Appender used to escape content such as HTML.
Formatter	Formats and then sends the results to the downstream appender.
Formatter.Formattable	Implement to allow formatting of custom objects you want to output.
JStachio	Render models by using reflection or static catalog to lookup generated templates as well as apply filtering and fallback mechanisms.
Output<E extends Exception>	A low level abstraction and implementation detail analogous to Appendable and DataOutput.
Output.CloseableEncodedOutput<E extends Exception>	An encoded output that can be closed.
Output.EncodedOutput<E extends Exception>	A specialized Output designed for pre-encoded templates that have already encoded byte arrays to be used directly.
Output.StringOutput	String Builder based output.
Renderer<T>	Renders models of type T by writing to an Appendable.
Template<T>	A JStachio Template is a renderer that has template meta data.
Template.EncodedTemplate<T>	EXPERIMENTAL support of pre-encoded templates that have the static parts of the template already encoded into bytes.
TemplateConfig	A Container for optional template collaborators for ease of wiring generated Templates.
TemplateInfo	Template meta data like its location, formatters, escapers and or its contents.
TemplateInfo.TemplateSource	Symbols representing where the template was retrieved from.
TemplateModel	A template and model combined with convenience methods.