com.liferay.portal.template

Class BaseTemplate

java.lang.Object

com.liferay.portal.template.BaseTemplate

All Implemented Interfaces:

Template, java.util.Map<java.lang.String,java.lang.Object>

public abstract class BaseTemplate
extends java.lang.Object
implements Template

Nested Class Summary

Nested classes/interfaces inherited from interface java.util.Map

java.util.Map.Entry<K,V>

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.Map<java.lang.String,java.lang.Object>	context

Constructor Summary

Constructors

Constructor and Description
BaseTemplate(TemplateResource templateResource, java.util.Map<java.lang.String,java.lang.Object> context, TemplateContextHelper templateContextHelper) Deprecated. As of Mueller (7.2.x), replaced by BaseTemplate(TemplateResource, Map, TemplateContextHelper, boolean)
BaseTemplate(TemplateResource templateResource, java.util.Map<java.lang.String,java.lang.Object> context, TemplateContextHelper templateContextHelper, boolean restricted)

Method Summary

Modifier and Type	Method and Description
protected void	cacheTemplateResource(TemplateResourceCache templateResourceCache, TemplateResource templateResource)
void	clear()
boolean	containsKey(java.lang.Object key)
boolean	containsValue(java.lang.Object value)
java.util.Set<java.util.Map.Entry<java.lang.String,java.lang.Object>>	entrySet()
java.lang.Object	get(java.lang.Object key)
protected java.lang.String	getTemplateResourceUUID(TemplateResource templateResource)
protected abstract void	handleException(TemplateResource templateResource, TemplateResource errorTemplateResource, java.lang.Exception exception, java.io.Writer writer)
boolean	isEmpty()
java.util.Set<java.lang.String>	keySet()
void	prepare(javax.servlet.http.HttpServletRequest httpServletRequest)
void	prepareTaglib(javax.servlet.http.HttpServletRequest httpServletRequest, javax.servlet.http.HttpServletResponse httpServletResponse)
protected abstract void	processTemplate(TemplateResource templateResource, java.io.Writer writer)
void	processTemplate(java.io.Writer writer)
void	processTemplate(java.io.Writer writer, java.util.function.Supplier<TemplateResource> errorTemplateResourceSupplier)
java.lang.Object	put(java.lang.String key, java.lang.Object value)
void	putAll(java.util.Map<? extends java.lang.String,? extends java.lang.Object> map)
protected java.lang.Object	putClass(java.lang.String key, java.lang.Class<?> clazz)
java.lang.Object	remove(java.lang.Object key)
int	size()
java.util.Collection<java.lang.Object>	values()

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, equals, forEach, getOrDefault, hashCode, merge, putIfAbsent, remove, replace, replace, replaceAll

Field Detail

context

protected java.util.Map<java.lang.String,java.lang.Object> context

Constructor Detail

BaseTemplate

@Deprecated
public BaseTemplate(TemplateResource templateResource,
                                java.util.Map<java.lang.String,java.lang.Object> context,
                                TemplateContextHelper templateContextHelper)

Deprecated. As of Mueller (7.2.x), replaced by BaseTemplate(TemplateResource, Map, TemplateContextHelper, boolean)

BaseTemplate

public BaseTemplate(TemplateResource templateResource,
                    java.util.Map<java.lang.String,java.lang.Object> context,
                    TemplateContextHelper templateContextHelper,
                    boolean restricted)

Method Detail

clear

public void clear()

Specified by:

clear in interface java.util.Map<java.lang.String,java.lang.Object>

containsKey

public boolean containsKey(java.lang.Object key)

Specified by:

containsKey in interface java.util.Map<java.lang.String,java.lang.Object>

containsValue

public boolean containsValue(java.lang.Object value)

Specified by:

containsValue in interface java.util.Map<java.lang.String,java.lang.Object>

entrySet

public java.util.Set<java.util.Map.Entry<java.lang.String,java.lang.Object>> entrySet()

Specified by:

entrySet in interface java.util.Map<java.lang.String,java.lang.Object>

get

public java.lang.Object get(java.lang.Object key)

Specified by:

get in interface java.util.Map<java.lang.String,java.lang.Object>

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface java.util.Map<java.lang.String,java.lang.Object>

keySet

public java.util.Set<java.lang.String> keySet()

Specified by:

keySet in interface java.util.Map<java.lang.String,java.lang.Object>

prepare

public void prepare(javax.servlet.http.HttpServletRequest httpServletRequest)

Specified by:

prepare in interface Template

prepareTaglib

public void prepareTaglib(javax.servlet.http.HttpServletRequest httpServletRequest,
                          javax.servlet.http.HttpServletResponse httpServletResponse)

Specified by:

prepareTaglib in interface Template

processTemplate

public void processTemplate(java.io.Writer writer)
                     throws TemplateException

Specified by:

processTemplate in interface Template

Throws:

TemplateException

processTemplate

public void processTemplate(java.io.Writer writer,
                            java.util.function.Supplier<TemplateResource> errorTemplateResourceSupplier)
                     throws TemplateException

Specified by:

processTemplate in interface Template

Throws:

TemplateException

put

public java.lang.Object put(java.lang.String key,
                            java.lang.Object value)

Specified by:

put in interface java.util.Map<java.lang.String,java.lang.Object>

putAll

public void putAll(java.util.Map<? extends java.lang.String,? extends java.lang.Object> map)

Specified by:

putAll in interface java.util.Map<java.lang.String,java.lang.Object>

remove

public java.lang.Object remove(java.lang.Object key)

Specified by:

remove in interface java.util.Map<java.lang.String,java.lang.Object>

size

public int size()

Specified by:

size in interface java.util.Map<java.lang.String,java.lang.Object>

values

public java.util.Collection<java.lang.Object> values()

Specified by:

values in interface java.util.Map<java.lang.String,java.lang.Object>

cacheTemplateResource

protected void cacheTemplateResource(TemplateResourceCache templateResourceCache,
                                     TemplateResource templateResource)

getTemplateResourceUUID

protected java.lang.String getTemplateResourceUUID(TemplateResource templateResource)

handleException

protected abstract void handleException(TemplateResource templateResource,
                                        TemplateResource errorTemplateResource,
                                        java.lang.Exception exception,
                                        java.io.Writer writer)
                                 throws TemplateException

Throws:

TemplateException

processTemplate

protected abstract void processTemplate(TemplateResource templateResource,
                                        java.io.Writer writer)
                                 throws java.lang.Exception

Throws:

java.lang.Exception

putClass

protected java.lang.Object putClass(java.lang.String key,
                                    java.lang.Class<?> clazz)