Module io.jstach.jstachio

Package io.jstach.jstachio.spi

Class AbstractJStachio

java.lang.Object

io.jstach.jstachio.spi.AbstractJStachio

All Implemented Interfaces:

JStachio, Renderer<Object>, JStachioExtensions.Provider

Direct Known Subclasses:

SpringJStachio

public abstract class AbstractJStachio
extends Object
implements JStachio, JStachioExtensions.Provider

An abstract jstachio that just needs a JStachioExtensions container.

To extend just override JStachioExtensions.Provider.extensions().

Author:

agentgt

See Also:

• JStachioExtensions

Constructor Summary

Constructors

Constructor	Description
AbstractJStachio()	Do nothing constructor

Method Summary

Modifier and Type	Method	Description
String	execute(Object model)	Finds a template by using the models class if possible and then applies filtering and then finally render the model to a String.
void	execute(Object model, Appendable appendable)	Finds a template by using the models class if possible and then applies filtering and then finally render the model by writing to the appendable.
StringBuilder	execute(Object model, StringBuilder sb)	Finds a template by using the models class if possible and then applies filtering and then finally render the model by writing to the StringBuilder.
boolean	supportsType(Class<?> modelType)	Determines if this jstachio can render the model type (the class annotated by JStache).

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.jstach.jstachio.spi.JStachioExtensions.Provider

extensions

Constructor Details

AbstractJStachio

public AbstractJStachio()

Do nothing constructor

Method Details

execute

public void execute(Object model,
 Appendable appendable)
             throws IOException

Description copied from interface: JStachio

Finds a template by using the models class if possible and then applies filtering and then finally render the model by writing to the appendable.

Renders the passed in model.

Specified by:

execute in interface JStachio

Specified by:

execute in interface Renderer<Object>

Parameters:

model - a model assumed never to be null.

appendable - the appendable to write to.

Throws:

IOException - if there is an error writing to the appendable

execute

public StringBuilder execute(Object model,
 StringBuilder sb)

Description copied from interface: JStachio

Finds a template by using the models class if possible and then applies filtering and then finally render the model by writing to the StringBuilder.

A convenience method that does not throw IOException when using StringBuilder.

Specified by:

execute in interface JStachio

Specified by:

execute in interface Renderer<Object>

Parameters:

model - a model assumed never to be null.

sb - should never be null.

Returns:

the passed in StringBuilder.

execute

public String execute(Object model)

Description copied from interface: JStachio

Finds a template by using the models class if possible and then applies filtering and then finally render the model to a String.

Convenience method that directly renders the model as a String.

Specified by:

execute in interface JStachio

Specified by:

execute in interface Renderer<Object>

Parameters:

model - never null.

Returns:

the rendered model.

supportsType

public boolean supportsType(Class<?> modelType)

Description copied from interface: JStachio

Determines if this jstachio can render the model type (the class annotated by JStache).

Specified by:

supportsType in interface JStachio

Parameters:

modelType - the models class (the one annotated with JStache and not the Templates class)

Returns:

true if this jstachio can render instances of modelType