sirius.tagliatelle.rendering

Class GlobalRenderContext

java.lang.Object

sirius.tagliatelle.rendering.GlobalRenderContext

public class GlobalRenderContext
extends Object

Represents the global context which is created to render a template.

See Also:

Tagliatelle.createRenderContext()

Field Summary

Fields

Modifier and Type	Field and Description
protected StringBuilder	buffer
protected Tagliatelle	engine
protected Function<String,String>	escaper
protected Map<String,String>	extraBlocks
protected sirius.tagliatelle.rendering.StackAllocator	stack
protected Map<String,Template>	templateCache

Constructor Summary

Constructors

Constructor and Description
GlobalRenderContext(Tagliatelle engine) Creates a new render context.

Method Summary

Modifier and Type	Method and Description
LocalRenderContext	createContext(Template template) Creates a local render context to invoke the given template.
String	emitToString(RenderCall callback) Emits everything which is invoked from within the callback into an unescaped string.
static String	escapeRAW(String input) Provides a raw escaper which doesn't alter the input at all.
static String	escapeXML(String input) Provides a XML escaper which processes XML control characters.
Function<String,String>	getEscaper() Returns the currently active escaper.
String	getExtraBlock(String name) Returns the contents for the given extra block, which were create during rendering.
List<Object>	getGlobals() Provides access to the environment (global variables).
protected void	outputEscaped(String string) Adds escaped output to the result buffer.
protected void	outputRaw(String string) Adds unescaped output to the result buffer.
protected void	release(LocalRenderContext renderContext) Releases the local render context to free up the allocated stack.
protected Optional<Template>	resolve(String templateName) Resolves the given template.
void	setEscaper(Function<String,String> escaper) Specifies the escaper to use.
void	storeExtraBlock(String name, String contents) Stores the rendering of an extra block.
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

templateCache

protected Map<String,Template> templateCache

stack

protected sirius.tagliatelle.rendering.StackAllocator stack

engine

protected Tagliatelle engine

buffer

protected StringBuilder buffer

extraBlocks

protected Map<String,String> extraBlocks

escaper

protected Function<String,String> escaper

Constructor Detail

GlobalRenderContext

public GlobalRenderContext(Tagliatelle engine)

Creates a new render context.

Use Tagliatelle.createRenderContext() to obtain an instance.

Parameters:

engine - the global engine instance.

Method Detail

resolve

protected Optional<Template> resolve(String templateName)
                              throws CompileException

Resolves the given template.

A local cache is maintained so that a previously resolved template is directly re-used and not resolved several times.

Parameters:

templateName - the name of the template to resolve

Returns:

the resolved template wrapped as optional or an empty optional, if no such template exists

Throws:

CompileException - in case the resolved template has compile errors

outputRaw

protected void outputRaw(String string)

Adds unescaped output to the result buffer.

Parameters:

string - the string to output

See Also:

LocalRenderContext.outputRaw(String)

outputEscaped

protected void outputEscaped(String string)

Adds escaped output to the result buffer.

Utilizes the current escaper to escape the given string.

Parameters:

string - the string to output

See Also:

(String)

setEscaper

public void setEscaper(@Nonnull
                       Function<String,String> escaper)

Specifies the escaper to use.

Parameters:

escaper - a mapping function to escape certain characters in strings being output using outputEscaped(String).

getEscaper

public Function<String,String> getEscaper()

Returns the currently active escaper.

Returns:

the currently active escaper

escapeRAW

public static String escapeRAW(String input)

Provides a raw escaper which doesn't alter the input at all.

Parameters:

input - the string to output

Returns:

the given string

escapeXML

public static String escapeXML(String input)

Provides a XML escaper which processes XML control characters.

Parameters:

input - the string to output

Returns:

the given string where XML control characters were replaced using ContentHelper.escapeXML(Object)

createContext

public LocalRenderContext createContext(Template template)

Creates a local render context to invoke the given template.

Parameters:

template - the template to invoke

Returns:

a local context with an appropriate (empty) local stack

release

protected void release(LocalRenderContext renderContext)

Releases the local render context to free up the allocated stack.

Note that createContext(Template) and release(LocalRenderContext) must be folded appropriately.

Parameters:

renderContext - the context to free up

toString

public String toString()

Overrides:

toString in class Object

getGlobals

public List<Object> getGlobals()

Provides access to the environment (global variables).

Returns:

the list of global variables

getExtraBlock

@Nonnull
public String getExtraBlock(String name)

Returns the contents for the given extra block, which were create during rendering.

Using <i:block> tags at the top level permits to output additional rendering results, next to the main string.

Parameters:

name - the name of the block

Returns:

the result generated while rendering the template or an empty string if no content is available.

emitToString

public String emitToString(RenderCall callback)

Emits everything which is invoked from within the callback into an unescaped string.

Parameters:

callback - the callback which will invoke emitters.

Returns:

the contents which were emitted within the callback

storeExtraBlock

public void storeExtraBlock(String name,
                            String contents)

Stores the rendering of an extra block.

Parameters:

name - the name of the block to store

contents - the contents to store