Package org.thymeleaf.context

Class AbstractContext

Object

org.thymeleaf.context.AbstractContext

All Implemented Interfaces:

IContext

Direct Known Subclasses:

AbstractExpressionContext, Context, WebContext

public abstract class AbstractContext
extends Object
implements IContext

Abstract base class for most IContext implementations.

Note a class with this name existed since 1.0, but it was completely reimplemented in Thymeleaf 3.0

Since:

3.0.0

Author:

Daniel Fernández

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractContext()
protected	AbstractContext(Locale locale)
protected	AbstractContext(Locale locale, Map<String,Object> variables)

Method Summary

Modifier and Type	Method	Description
void	clearVariables()	Removes all the variables from the context.
boolean	containsVariable(String name)	Checks whether a specific variable is already contained in this context or not.
Locale	getLocale()	Returns the locale that should be used for processing the template.
Object	getVariable(String name)	Retrieve a specific variable, by name.
Set<String>	getVariableNames()	Get a list with all the names of variables contained at this context.
void	removeVariable(String name)	Removes a variable from the context.
void	setLocale(Locale locale)	Sets the locale to be used.
void	setVariable(String name, Object value)	Sets a new variable into the context.
void	setVariables(Map<String,Object> variables)	Sets several variables at a time into the context.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractContext

protected AbstractContext()

AbstractContext

protected AbstractContext(Locale locale)

AbstractContext

protected AbstractContext(Locale locale,
                          Map<String,Object> variables)

Method Detail

getLocale

public final Locale getLocale()

Description copied from interface: IContext

Returns the locale that should be used for processing the template.

Specified by:

getLocale in interface IContext

Returns:

the locale to be used.

containsVariable

public final boolean containsVariable(String name)

Description copied from interface: IContext

Checks whether a specific variable is already contained in this context or not.

Specified by:

containsVariable in interface IContext

Parameters:

name - the name of the variable to be checked.

Returns:

true if the variable is already contained, false if not.

getVariableNames

public final Set<String> getVariableNames()

Description copied from interface: IContext

Get a list with all the names of variables contained at this context.

Specified by:

getVariableNames in interface IContext

Returns:

the variable names.

getVariable

public final Object getVariable(String name)

Description copied from interface: IContext

Retrieve a specific variable, by name.

Specified by:

getVariable in interface IContext

Parameters:

name - the name of the variable to be retrieved.

Returns:

the variable's value.

setLocale

public void setLocale(Locale locale)

Sets the locale to be used.

Parameters:

locale - the locale.

setVariable

public void setVariable(String name,
                        Object value)

Sets a new variable into the context.

Parameters:

name - the name of the variable.

value - the value of the variable.

setVariables

public void setVariables(Map<String,Object> variables)

Sets several variables at a time into the context.

Parameters:

variables - the variables to be set.

removeVariable

public void removeVariable(String name)

Removes a variable from the context.

Parameters:

name - the name of the variable to be removed.

clearVariables

public void clearVariables()

Removes all the variables from the context.