sirius.tagliatelle

Class Template

java.lang.Object

sirius.tagliatelle.Template

public class Template
extends Object

Represents a compiled template which can be rendered.

Field Summary

Fields

Modifier and Type	Field and Description
protected List<TemplateArgument>	arguments
protected Emitter	emitter
protected String	name
protected Map<String,String>	pragmas
protected Resource	resource

Constructor Summary

Constructors

Constructor and Description
Template(String name, Resource resource) Creates a new template with the given name (full path) and resource.

Method Summary

Modifier and Type	Method and Description
void	addArgument(TemplateArgument arg) Adds an argument to the template.
void	addPragma(String name, String value) Adds a pragma which was detected while compiling.
List<TemplateArgument>	getArguments() Returns the list of arguments expected by the template.
double	getAverageRenderTime() Returns the average time it took to render the template.
LocalDateTime	getCompilationTime() Returns the compilation timestamp as LocalDateTime.
long	getCompilationTimestamp() Returns the timestamp when the template was last recompiled.
String	getComplexity() Returns the complexity of the template.
String	getEffectiveFileName() Contains the effective file name (without the .pasta suffix).
Emitter	getEmitter() Returns the emitter which represents the body of the template.
String	getName() Returns the name of the template.
int	getNumInvocations() Returns how many times the template was rendered since its compilation.
sirius.kernel.commons.Value	getPragma(String name) Reads the pragma with the given name.
Resource	getResource() Returns the resource which was used as input for the template.
LocalDateTime	getResourceLastChanged() Returns the timestamp when the underlying resource was last changed as LocalDateTime.
String	getShortName() Represents a short an readable name of the template used in error messages.
int	getStackDepth() Returns the stack depth required by this template.
boolean	isConstant() Determines if the contents of this template are completely constant.
void	render(GlobalRenderContext ctx, Object... args) Returns the template using the given context and arguments.
String	renderToString(Object... args) Invokes the template and renders it into a string using the given arguments.
void	renderWithContext(LocalRenderContext ctx) Renders the template with the given local context.
String	renderWithParams(sirius.kernel.commons.Context context) Invokes the template and renders it into a string using the given arguments.
void	setEmitter(Emitter emitter) Sets the body of the template.
void	setStackDepth(int stackDepth) Sets the stack depth / number of local variables.
String	toString()
void	transferArguments(Map<String,Object> args, LocalRenderContext renderContext) Reads all arguments from the given map into the given render context.

Methods inherited from class java.lang.Object

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

Field Detail

name

protected String name

resource

protected Resource resource

emitter

protected Emitter emitter

arguments

protected List<TemplateArgument> arguments

pragmas

protected Map<String,String> pragmas

Constructor Detail

Template

public Template(String name,
                @Nullable
                Resource resource)

Creates a new template with the given name (full path) and resource.

Parameters:

name - the name of the template

resource - the resource which is used as input for the compiler

Method Detail

getEffectiveFileName

public String getEffectiveFileName()

Contains the effective file name (without the .pasta suffix).

Returns:

the effective file name

addArgument

public void addArgument(TemplateArgument arg)

Adds an argument to the template.

Parameters:

arg - the argument to add

addPragma

public void addPragma(String name,
                      String value)

Adds a pragma which was detected while compiling.

Parameters:

name - the name of the pragma

value - the value of the pragma

getPragma

public sirius.kernel.commons.Value getPragma(String name)

Reads the pragma with the given name.

Parameters:

name - the name of the pragma to read

Returns:

the value of the given pragma wrapped as Value or an empty value if no such pragma exists

renderToString

public String renderToString(Object... args)
                      throws RenderException

Invokes the template and renders it into a string using the given arguments.

Parameters:

args - the arguments to supply

Returns:

the result of the emitters contained in the template

Throws:

RenderException - in case of an error when creating the output

renderWithParams

public String renderWithParams(sirius.kernel.commons.Context context)
                        throws RenderException

Invokes the template and renders it into a string using the given arguments.

Parameters:

context - the arguments to supply

Returns:

the result of the emitters contained in the template

Throws:

RenderException - in case of an error when creating the output

transferArguments

public void transferArguments(Map<String,Object> args,
                              LocalRenderContext renderContext)
                       throws RenderException

Reads all arguments from the given map into the given render context.

Also, all given values are verified and default values are used, where required.

Parameters:

args - the arguments to use

renderContext - the context to fill

Throws:

RenderException - in case of invalid or missing arguments

render

public void render(GlobalRenderContext ctx,
                   Object... args)
            throws RenderException

Returns the template using the given context and arguments.

Parameters:

ctx - the context used to render the template

args - the arguments being supplied to the template

Throws:

RenderException - in case of an error when creating the output

renderWithContext

public void renderWithContext(LocalRenderContext ctx)
                       throws RenderException

Renders the template with the given local context.

Parameters:

ctx - the local render context

Throws:

RenderException - in case of an error when creating the output

isConstant

public boolean isConstant()

Determines if the contents of this template are completely constant.

Returns:

true if the contents are completely constant, false otherwise

getCompilationTimestamp

public long getCompilationTimestamp()

Returns the timestamp when the template was last recompiled.

Returns:

the timestamp (System.currentTimeMillis() when the template was last compiled

getArguments

public List<TemplateArgument> getArguments()

Returns the list of arguments expected by the template.

Returns:

the list of arguments of the template

getName

public String getName()

Returns the name of the template.

Returns:

the name of the template

getResource

public Resource getResource()

Returns the resource which was used as input for the template.

Returns:

the underlying resource of the template

getCompilationTime

public LocalDateTime getCompilationTime()

Returns the compilation timestamp as LocalDateTime.

Returns:

the timestamp when the template was compiled

getResourceLastChanged

public LocalDateTime getResourceLastChanged()

Returns the timestamp when the underlying resource was last changed as LocalDateTime.

Returns:

the timestamp when the underlying resource was last changed

getNumInvocations

public int getNumInvocations()

Returns how many times the template was rendered since its compilation.

Returns:

the number of invokations of this template

getAverageRenderTime

public double getAverageRenderTime()

Returns the average time it took to render the template.

Returns:

the average rendering time in milliseconds

getComplexity

public String getComplexity()

Returns the complexity of the template.

The complexity is simply the number of emitters and number of expressions in a template.

Returns:

the complexity as string

toString

public String toString()

Overrides:

toString in class Object

getEmitter

public Emitter getEmitter()

Returns the emitter which represents the body of the template.

Returns:

the body emitter of the template

setStackDepth

public void setStackDepth(int stackDepth)

Sets the stack depth / number of local variables.

Parameters:

stackDepth - the number of local variables / arguments required at runtime

getStackDepth

public int getStackDepth()

Returns the stack depth required by this template.

Returns:

the number of arguments / local variables of this template

setEmitter

public void setEmitter(Emitter emitter)

Sets the body of the template.

Parameters:

emitter - the emitter which represents the body of this template

getShortName

public String getShortName()

Represents a short an readable name of the template used in error messages.

This will most probably either render the name as tag if it is one or just output the filename instead of the full path, which is nonambiguous in the context or an error message.

Returns:

a possibly shortened name of the template to be used in warnings and error messages