com.github.jknack.handlebars.cache

Class ConcurrentMapTemplateCache

java.lang.Object

com.github.jknack.handlebars.cache.ConcurrentMapTemplateCache

All Implemented Interfaces:

TemplateCache

public class ConcurrentMapTemplateCache
extends Object
implements TemplateCache

A simple TemplateCache built on top of ConcurrentHashMap.

Since:

0.1.0

Author:

edgar.espina

Constructor Summary

Constructors

Modifier	Constructor and Description
	ConcurrentMapTemplateCache() Creates a new ConcurrentMapTemplateCache.
protected	ConcurrentMapTemplateCache(ConcurrentMap<TemplateSource,org.apache.commons.lang3.tuple.Pair<TemplateSource,Template>> cache) Creates a new ConcurrentMapTemplateCache.

Method Summary

Methods

Modifier and Type	Method and Description
void	clear() Remove all mappings from the cache.
void	evict(TemplateSource source) Evict the mapping for this source from this cache if it is present.
Template	get(TemplateSource source, Parser parser) Return the value to which this cache maps the specified key.
ConcurrentMapTemplateCache	setReload(boolean reload) Turn on/off auto reloading of templates.

Methods inherited from class java.lang.Object

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

Constructor Detail

ConcurrentMapTemplateCache

protected ConcurrentMapTemplateCache(ConcurrentMap<TemplateSource,org.apache.commons.lang3.tuple.Pair<TemplateSource,Template>> cache)

Creates a new ConcurrentMapTemplateCache.

Parameters:

cache - The concurrent map cache. Required.

ConcurrentMapTemplateCache

public ConcurrentMapTemplateCache()

Creates a new ConcurrentMapTemplateCache.

Method Detail

clear

public void clear()

Description copied from interface: TemplateCache

Remove all mappings from the cache.

Specified by:

clear in interface TemplateCache

evict

public void evict(TemplateSource source)

Description copied from interface: TemplateCache

Evict the mapping for this source from this cache if it is present.

Specified by:

evict in interface TemplateCache

Parameters:

source - the source whose mapping is to be removed from the cache

get

public Template get(TemplateSource source,
           Parser parser)
             throws IOException

Description copied from interface: TemplateCache

Return the value to which this cache maps the specified key.

Specified by:

get in interface TemplateCache

Parameters:

source - source whose associated template is to be returned.

parser - The Handlebars parser.

Returns:

A template.

Throws:

IOException - If input can't be parsed.

setReload

public ConcurrentMapTemplateCache setReload(boolean reload)

Description copied from interface: TemplateCache

Turn on/off auto reloading of templates. Auto reload is done using TemplateSource.lastModified().

Specified by:

setReload in interface TemplateCache

Parameters:

reload - True, for turning off template reload. Default is: false.

Returns:

This template loader.