sirius.tagliatelle.rendering

Class LocalRenderContext

java.lang.Object

sirius.tagliatelle.rendering.LocalRenderContext

public class LocalRenderContext
extends Object

Represents a render context local to a single template.

If one template invokes another, they share a common GlobalRenderContext but have their own LocalRenderContext.

Also a local context knows its parent and can therefore output the render stack which is kind of a stacktrace for templates.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	LocalRenderContext(Template template, GlobalRenderContext globalContext, sirius.tagliatelle.rendering.StackAllocator.View locals) Creates a new context.

Method Summary

Modifier and Type	Method and Description
LocalRenderContext	createChildContext(Template template) Creates a child context to invoke the given template.
LocalRenderContext	createClosureContext() Creates a closure context which can be put on the render stack as child, to provide access to the variables of the enclosed context and to maintain a valid renderstack.
LocalRenderContext	createInlineContext(Template template) Creates an inline context which uses the same locals as this context but references another template.
boolean	emitBlock(String name) Emits the block with the given name.
Object	getGlobal(int index) Reads the global variable at the given index.
GlobalRenderContext	getGlobalContext() Provides access to the underlying global context.
Object	getLocal(int index) Reads the local variable at the given index.
protected sirius.tagliatelle.rendering.StackAllocator.View	getLocals() Contains the locals used by this context.
void	outputEscaped(String content) Adds escaped output to the result buffer.
void	outputRaw(String content) Adds unescaped output to the result buffer.
void	release() Releases this context.
Optional<Template>	resolve(String templateName) Resolves the given template.
void	setBlocks(LocalRenderContext context, Map<String,Emitter> blocks) Specifies the blocks made available by the caller.
void	setLocal(int index, Object variable) Assigns the given value to the given local variable.
String	toString()
void	updatePosition(parsii.tokenizer.Position newPosition) Updates the output position.

Methods inherited from class java.lang.Object

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

Constructor Detail

LocalRenderContext

protected LocalRenderContext(Template template,
                             GlobalRenderContext globalContext,
                             sirius.tagliatelle.rendering.StackAllocator.View locals)

Creates a new context.

Use one of the helper methods to create a purpose built context.

Parameters:

template - the template for which the context was created.

globalContext - the global and shared context for the render process

locals - the local / stack variables. These can also be shared, if a closure (block included in another template) is created.

Method Detail

createChildContext

public LocalRenderContext createChildContext(Template template)

Creates a child context to invoke the given template.

Parameters:

template - the template which will be invoked

Returns:

a newly created child context for the given template

createClosureContext

public LocalRenderContext createClosureContext()

Creates a closure context which can be put on the render stack as child, to provide access to the variables of the enclosed context and to maintain a valid renderstack.

Returns:

a new closure context which can be used as child of this context but references the template an locals of the enclosed context

createInlineContext

public LocalRenderContext createInlineContext(Template template)

Creates an inline context which uses the same locals as this context but references another template.

This is just created to maintain a proper render stack in case of an error.

Parameters:

template - the original template from which the inlined content was created

Returns:

a new child context which can be put on the render stack

release

public void release()

Releases this context.

outputRaw

public void outputRaw(String content)
               throws IOException

Adds unescaped output to the result buffer.

Parameters:

content - the string to output

Throws:

IOException - in case of an IO error

See Also:

outputRaw(String)

outputEscaped

public void outputEscaped(String content)
                   throws IOException

Adds escaped output to the result buffer.

Utilizes the current GlobalRenderContext.escaper to escape the given string.

Parameters:

content - the string to output

Throws:

IOException - in case of an IO error

See Also:

(String)

setLocal

public void setLocal(int index,
                     Object variable)

Assigns the given value to the given local variable.

Parameters:

index - the index of the local to assign

variable - the value to assign

getGlobal

public Object getGlobal(int index)

Reads the global variable at the given index.

Parameters:

index - the index in the environment list to read

Returns:

the value of the global variable

getLocal

public Object getLocal(int index)

Reads the local variable at the given index.

Parameters:

index - the local index to read

Returns:

the value of the local variable

getLocals

protected sirius.tagliatelle.rendering.StackAllocator.View getLocals()

Contains the locals used by this context.

Returns:

the block of locals used by this context

resolve

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

Resolves the given template.

A local cache is maintained by the GlobalRenderContext 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

emitBlock

public boolean emitBlock(String name)
                  throws RenderException

Emits the block with the given name.

Parameters:

name - the name of the block to emit

Returns:

true if a block was found and emitted, false otherwise

Throws:

RenderException - in case of an error when emitting the block

setBlocks

public void setBlocks(LocalRenderContext context,
                      Map<String,Emitter> blocks)

Specifies the blocks made available by the caller.

Parameters:

context - the context being enclosed along with the blocks to be restored later to access local variables

blocks - the blocks passed to the template being rendered

toString

public String toString()

Overrides:

toString in class Object

updatePosition

public void updatePosition(parsii.tokenizer.Position newPosition)

Updates the output position.

Parameters:

newPosition - the position within the template being rendered.

getGlobalContext

public GlobalRenderContext getGlobalContext()

Provides access to the underlying global context.

Returns:

the global context