org.thymeleaf
Class TemplateProcessingParameters

Object
  extended by org.thymeleaf.TemplateProcessingParameters

public final class TemplateProcessingParameters
extends Object

Objects of this class contain all the required arguments for template resolution and parsing.

These objects are created internally by the Template Engine in order to provide the Template Parser and the Template Resolvers with the info they need to read and parse the template document.

Since:
2.0.0
Author:
Daniel Fernández

Constructor Summary
TemplateProcessingParameters(Configuration configuration, String templateName, IContext context)
           Create a new TemplateProcessingParameters instance.
TemplateProcessingParameters(Configuration configuration, String templateName, IProcessingContext context)
           Create a new TemplateProcessingParameters instance.
 
Method Summary
 Configuration getConfiguration()
           Returns the Template Engine configuration being used for processing templates.
 IContext getContext()
           Returns the current context specified for template processing.
 Object getExecutionAttribute(String attributeName)
           Returns the execution attribute with the specified name.
 Map<String,Object> getExecutionAttributes()
           Returns the execution attributes.
 IProcessingContext getProcessingContext()
           Returns the processing context specified for template processing.
 String getTemplateName()
           Returns the name of the template currently being processed.
 
Methods inherited from class Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

TemplateProcessingParameters

public TemplateProcessingParameters(Configuration configuration,
                                    String templateName,
                                    IContext context)

Create a new TemplateProcessingParameters instance.

Mainly for internal use. Should not be called directly except when processing a template (e.g. a fragment) using the TemplateEngine from a element/attribute processor.

Parameters:
configuration - the configuration
templateName - the template name
context - the context

TemplateProcessingParameters

public TemplateProcessingParameters(Configuration configuration,
                                    String templateName,
                                    IProcessingContext context)

Create a new TemplateProcessingParameters instance.

Mainly for internal use. Should not be called directly except when processing a template (e.g. a fragment) using the TemplateEngine from a element/attribute processor.

Parameters:
configuration - the configuration
templateName - the template name
context - the processing context
Since:
2.0.9
Method Detail

getConfiguration

public Configuration getConfiguration()

Returns the Template Engine configuration being used for processing templates.

Returns:
the configuration

getTemplateName

public String getTemplateName()

Returns the name of the template currently being processed.

Returns:
the template name

getContext

public IContext getContext()

Returns the current context specified for template processing.

Equivalent to getProcessingContext().getContext().

Returns:
the current context

getProcessingContext

public IProcessingContext getProcessingContext()

Returns the processing context specified for template processing.

Returns:
the processing context
Since:
2.0.9

getExecutionAttributes

public Map<String,Object> getExecutionAttributes()

Returns the execution attributes.

Returns:
the current map of execution attributes

getExecutionAttribute

public Object getExecutionAttribute(String attributeName)

Returns the execution attribute with the specified name.

Parameters:
attributeName - the name of the attribute to be retrieved
Returns:
the value of the attribute


Copyright © 2013 The THYMELEAF team. All Rights Reserved.