com.mitchellbosecke.pebble.template

Class PebbleTemplateImpl

java.lang.Object

com.mitchellbosecke.pebble.template.PebbleTemplateImpl

All Implemented Interfaces:

PebbleTemplate

public class PebbleTemplateImpl
extends Object
implements PebbleTemplate

Field Summary

Fields

Modifier and Type	Field and Description
protected PebbleEngine	engine A template has to store a reference to the main engine so that it can compile other templates when using the "import" or "include" tags.

Constructor Summary

Constructors

Constructor and Description
PebbleTemplateImpl(PebbleEngine engine, RootNode root, String name)

Method Summary

Modifier and Type	Method and Description
void	block(Writer writer, EvaluationContext context, String blockName, boolean ignoreOverriden) A typical block declaration will use this method which evaluates the block using the regular user-provided writer.
void	buildContent(Writer writer, EvaluationContext context)
void	evaluate(Writer writer)
void	evaluate(Writer writer, EvaluationContext context) This is the authoritative evaluate method.
void	evaluate(Writer writer, Locale locale)
void	evaluate(Writer writer, Map<String,Object> map)
void	evaluate(Writer writer, Map<String,Object> map, Locale locale)
String	getName()
boolean	hasBlock(String blockName)
boolean	hasMacro(String macroName)
void	importTemplate(EvaluationContext context, String name) Imports a template.
void	includeTemplate(Writer writer, EvaluationContext context, String name)
String	macro(EvaluationContext context, String macroName, ArgumentsNode args, boolean ignoreOverriden)
void	registerBlock(Block block) Registers a block.
void	registerMacro(Macro macro)
void	setParent(EvaluationContext context, String parentName)

Methods inherited from class java.lang.Object

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

Field Detail

engine

protected final PebbleEngine engine

A template has to store a reference to the main engine so that it can compile other templates when using the "import" or "include" tags. It's important that the only method of the PebbleEngine that a template invokes during evaluation is the "getTemplate" method because this is the only one that I'm sure is thread-safe.

Constructor Detail

PebbleTemplateImpl

public PebbleTemplateImpl(PebbleEngine engine,
                          RootNode root,
                          String name)
                   throws PebbleException

Throws:

PebbleException

Method Detail

buildContent

public void buildContent(Writer writer,
                         EvaluationContext context)
                  throws IOException,
                         PebbleException

Throws:

IOException

PebbleException

evaluate

public void evaluate(Writer writer)
              throws PebbleException,
                     IOException

Specified by:

evaluate in interface PebbleTemplate

Throws:

PebbleException

IOException

evaluate

public void evaluate(Writer writer,
                     Locale locale)
              throws PebbleException,
                     IOException

Specified by:

evaluate in interface PebbleTemplate

Throws:

PebbleException

IOException

evaluate

public void evaluate(Writer writer,
                     Map<String,Object> map)
              throws PebbleException,
                     IOException

Specified by:

evaluate in interface PebbleTemplate

Throws:

PebbleException

IOException

evaluate

public void evaluate(Writer writer,
                     Map<String,Object> map,
                     Locale locale)
              throws PebbleException,
                     IOException

Specified by:

evaluate in interface PebbleTemplate

Throws:

PebbleException

IOException

evaluate

public void evaluate(Writer writer,
                     EvaluationContext context)
              throws PebbleException,
                     IOException

This is the authoritative evaluate method. It should not be invoked by the end user and is therefore not included in the PebbleTemplate interface. I can't, however, make it "private" due to the fact that NodeInclude will call this method on a template other than itself.

Parameters:

writer - The writer used to write the final output of the template

context - The evaluation context

Throws:

PebbleException - Thrown if any sort of template error occurs

IOException - Thrown from the writer object

importTemplate

public void importTemplate(EvaluationContext context,
                           String name)
                    throws PebbleException

Imports a template.

Parameters:

context - The evaluation context

name - The template name

Throws:

PebbleException - Thrown if an error occurs while rendering the imported template

includeTemplate

public void includeTemplate(Writer writer,
                            EvaluationContext context,
                            String name)
                     throws PebbleException,
                            IOException

Throws:

PebbleException

IOException

hasMacro

public boolean hasMacro(String macroName)

registerBlock

public void registerBlock(Block block)

Registers a block.

Parameters:

block - The block

hasBlock

public boolean hasBlock(String blockName)

registerMacro

public void registerMacro(Macro macro)
                   throws PebbleException

Throws:

PebbleException

block

public void block(Writer writer,
                  EvaluationContext context,
                  String blockName,
                  boolean ignoreOverriden)
           throws PebbleException,
                  IOException

A typical block declaration will use this method which evaluates the block using the regular user-provided writer.

Parameters:

blockName - The name of the block

context - The evaluation context

ignoreOverriden - Whether or not to ignore overriden blocks

writer - The writer

Throws:

PebbleException - Thrown if an error occurs

IOException - Thrown from the writer object

macro

public String macro(EvaluationContext context,
                    String macroName,
                    ArgumentsNode args,
                    boolean ignoreOverriden)
             throws PebbleException

Throws:

PebbleException

setParent

public void setParent(EvaluationContext context,
                      String parentName)
               throws PebbleException

Throws:

PebbleException

getName

public String getName()