org.thymeleaf
Class Arguments

Object
  org.thymeleaf.Arguments

public final class Arguments
extends Object

Objects of this class contain all the required arguments for template processing.

These objects are created internally by the Template Engine in order to provide to processors (attribute, tag or value) with all the information they might need for performing their tasks.

Arguments include many attributes, among which some should be used internally only, and never by developers of attribute/tag/value processors. Public attributes are:

• The Template Engine configuration (Configuration): getConfiguration()
• The template name: getTemplateName()
• The Context (IContext): getContext()
• The Template Parser being used (TemplateParser): getTemplateParser()
• The current map of ID Counts (used for adding a unique index to repeated id attributes): getIdCounts()
• The Expression roots:
  • For normal (non selected) evaluation (${...} in standard dialect): getExpressionEvaluationRoot()
  • For selected evaluation (*{...} in standard dialect): getExpressionSelectionEvaluationRoot()
• The currently selected text inliner ITextInliner, if it exists: getTextInliner()

Since:

1.0

Author:

Daniel Fernández

Constructor Summary

Arguments(Configuration configuration, TemplateParser templateParser, String templateName, IContext context)
Create a new Arguments instance.

Arguments(Configuration configuration, TemplateParser templateParser, String templateName, IContext context, Map<String,Object> localVariables, org.thymeleaf.Arguments.SelectionTarget selectionTarget, Map<String,Integer> idCounts, ITextInliner textInliner)
Create a new Arguments instance.

Method Summary

Arguments	addLocalVariables(Map<String,Object> newVariables) Creates a new Arguments object by adding some new local variables to the existing map (the rest of the attributes are copied verbatim).
Arguments	addLocalVariablesAndSetSelectionTarget(Map<String,Object> newVariables, Object target) Creates a new Arguments object by setting new local variables and a selection target.
Arguments	addLocalVariablesAndTextInliner(Map<String,Object> newVariables, ITextInliner newTextInliner) Creates a new Arguments object by setting new local variables and a new text inliner.
Arguments	addLocalVariablesAndTextInlinerAndSetSelectionTarget(Map<String,Object> newVariables, ITextInliner newTextInliner, Object target) Creates a new Arguments object by adding new local variables, a text inliner and a selection target.
Integer	getAndIncrementIDSeq(String id) Returns a new index (ID count) for a specific value of the id attribute, and increments the count.
Configuration	getConfiguration() Returns the Template Engine configuration being used for processing templates.
IContext	getContext() Returns the current context specified for template processing.
Object	getExpressionEvaluationRoot() Returns the current evaluation root.
Object	getExpressionSelectionEvaluationRoot() Returns the current selection evaluation root.
Map<String,Integer>	getIdCounts() Returns the map of ID counts.
Object	getLocalVariable(String variableName) Returns the value of a local variable.
Map<String,Object>	getLocalVariables() Returns the map of local variables.
Integer	getNextIDSeq(String id) Returns the index (ID count) for a specific value of the id attribute without incrementing the count.
Integer	getPreviousIDSeq(String id) Returns the last index (ID count) returned for a specific value of the id attribute (without incrementing the count).
org.thymeleaf.Arguments.SelectionTarget	getSelectionTarget() Returns the current selection target (e.g.
Object	getSelectionTargetObject() Returns the selection target object, object contained by the result of getSelectionTarget(), and raises an exception if there isn't any.
String	getTemplateName() Returns the name of the template currently being processed.
TemplateParser	getTemplateParser() Returns the template parser being used for parsing templates.
ITextInliner	getTextInliner() Returns the currently set text inliner (if any).
boolean	hasLocalVariables() Returns whether local variables have currently been specified or not.
boolean	hasSelectionTarget() Returns whether there currently is a selection going on (e.g.
boolean	hasTextInliner() Returns whether a text inliner has been set for the fragment of code currently being processed (e.g.
Arguments	setSelectionTarget(Object target) Creates a new Arguments object by setting a selection target.
Arguments	setTextInliner(ITextInliner newTextInliner) Creates a new Arguments object by setting a new text inliner.
Arguments	setTextInlinerAndSetSelectionTarget(ITextInliner newTextInliner, Object target) Creates a new Arguments object by setting a new text inliner and a selection target.

Methods inherited from class Object

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

Constructor Detail

Arguments

public Arguments(Configuration configuration,
                 TemplateParser templateParser,
                 String templateName,
                 IContext context)

Create a new Arguments instance.

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

Parameters:

configuration - the configuration

templateParser - the template parser

templateName - the template name

context - the context

Arguments

public Arguments(Configuration configuration,
                 TemplateParser templateParser,
                 String templateName,
                 IContext context,
                 Map<String,Object> localVariables,
                 org.thymeleaf.Arguments.SelectionTarget selectionTarget,
                 Map<String,Integer> idCounts,
                 ITextInliner textInliner)

Create a new Arguments instance.

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

Parameters:

configuration - the configuration

templateParser - the template parser

templateName - the template name

context - the context

localVariables - the local variables

selectionTarget - the selection target

idCounts - the map of ID counts

textInliner - the text inliner (if any, can be null)

Method Detail

getConfiguration

public Configuration getConfiguration()

Returns the Template Engine configuration being used for processing templates.

Returns:

the configuration

getTemplateParser

public TemplateParser getTemplateParser()

Returns the template parser being used for parsing templates.

Returns:

the template parser

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.

Returns:

the current context

hasLocalVariables

public boolean hasLocalVariables()

Returns whether local variables have currently been specified or not. (e.g. th:with in standard dialect).

Returns:

true if there are local variables, false if not

getLocalVariable

public Object getLocalVariable(String variableName)

Returns the value of a local variable.

Parameters:

variableName - the name of the local variable to be returned

Returns:

the value of the variable, or null if the variable does not exist (or has null value)

getLocalVariables

public Map<String,Object> getLocalVariables()

Returns the map of local variables.

Returns:

the local variabes

hasTextInliner

public boolean hasTextInliner()

Returns whether a text inliner has been set for the fragment of code currently being processed (e.g. with th:inline in standard dialect).

Returns:

true if there is a text inliner set, false if not

getTextInliner

public ITextInliner getTextInliner()

Returns the currently set text inliner (if any).

Returns:

the text inliner, or null if none has been set

hasSelectionTarget

public boolean hasSelectionTarget()

Returns whether there currently is a selection going on (e.g. th:object in standard dialect).

Returns:

true if there is a selection currently established, false if not

getSelectionTarget

public org.thymeleaf.Arguments.SelectionTarget getSelectionTarget()

Returns the current selection target (e.g. object selected by a th:object attribute in standard dialect).

Returns:

the current selection target, if there is any

getSelectionTargetObject

public Object getSelectionTargetObject()

Returns the selection target object, object contained by the result of getSelectionTarget(), and raises an exception if there isn't any.

Meant for internal use.

Returns:

the selection target object

getIdCounts

public Map<String,Integer> getIdCounts()

Returns the map of ID counts.

These numbers are used to avoid conflicts among elements with the same id attribute; for example elements being repeated as a part of a th:each iteration.

Returns:

the current map of ID counts

getExpressionEvaluationRoot

public Object getExpressionEvaluationRoot()

Returns the current evaluation root. This is the object on which expressions (normal expressions, like those specified in the standard dialect with ${...}) are executed.

Returns:

the expression evaluation root

getExpressionSelectionEvaluationRoot

public Object getExpressionSelectionEvaluationRoot()

Returns the current selection evaluation root. This is the object on which selection expressions (like those specified in the standard dialect with *{...}) are executed.

Returns:

the selection evaluation root

getAndIncrementIDSeq

public Integer getAndIncrementIDSeq(String id)

Returns a new index (ID count) for a specific value of the id attribute, and increments the count.

Parameters:

id - the ID for which the count will be computed

Returns:

the new count, ready to be used

getNextIDSeq

public Integer getNextIDSeq(String id)

Returns the index (ID count) for a specific value of the id attribute without incrementing the count.

Parameters:

id - the ID for which the count will be retrieved

Returns:

the current count

getPreviousIDSeq

public Integer getPreviousIDSeq(String id)

Returns the last index (ID count) returned for a specific value of the id attribute (without incrementing the count).

Parameters:

id - the ID for which the last count will be retrieved

Returns:

the count

addLocalVariables

public Arguments addLocalVariables(Map<String,Object> newVariables)

Creates a new Arguments object by adding some new local variables to the existing map (the rest of the attributes are copied verbatim).

Parameters:

newVariables - the new variables

Returns:

the new Arguments object

setSelectionTarget

public Arguments setSelectionTarget(Object target)

Creates a new Arguments object by setting a selection target.

Parameters:

target - the new selection target object

Returns:

the new Arguments object

addLocalVariablesAndSetSelectionTarget

public Arguments addLocalVariablesAndSetSelectionTarget(Map<String,Object> newVariables,
                                                        Object target)

Creates a new Arguments object by setting new local variables and a selection target.

Parameters:

newVariables - the new local variables

target - the new selection target object

Returns:

the new Arguments object

setTextInliner

public Arguments setTextInliner(ITextInliner newTextInliner)

Creates a new Arguments object by setting a new text inliner.

Parameters:

newTextInliner - the new text inliner

Returns:

the new Arguments object

addLocalVariablesAndTextInliner

public Arguments addLocalVariablesAndTextInliner(Map<String,Object> newVariables,
                                                 ITextInliner newTextInliner)

Creates a new Arguments object by setting new local variables and a new text inliner.

Parameters:

newVariables - the new local variables

newTextInliner - the new text inliner

Returns:

the new Arguments object

setTextInlinerAndSetSelectionTarget

public Arguments setTextInlinerAndSetSelectionTarget(ITextInliner newTextInliner,
                                                     Object target)

Creates a new Arguments object by setting a new text inliner and a selection target.

Parameters:

newTextInliner - the new text inliner

target - the new selection target object

Returns:

the new Arguments object

addLocalVariablesAndTextInlinerAndSetSelectionTarget

public Arguments addLocalVariablesAndTextInlinerAndSetSelectionTarget(Map<String,Object> newVariables,
                                                                      ITextInliner newTextInliner,
                                                                      Object target)

Creates a new Arguments object by adding new local variables, a text inliner and a selection target.

Parameters:

newVariables - the new local variables

newTextInliner - the new text inliner

target - the new selection target object

Returns:

the new Arguments object