Nested and Inner Type Summary

Modifier and Type	Class and Description
public static class	MarkupTemplateEngine.CachingTemplateResolver A template resolver which avoids calling `ClassLoader#getResource(String)` if a template path already has been queried before.
public static class	MarkupTemplateEngine.DefaultTemplateResolver
private class	MarkupTemplateEngine.MarkupTemplateMaker Implements the `groovy.text.Template` interface by caching a compiled template script and keeping a reference to the optional map of types of the model elements.
pack-priv static class	MarkupTemplateEngine.TemplateGroovyClassLoader A specialized GroovyClassLoader which will support passing values to the type checking extension thanks to a thread local.
public static class	MarkupTemplateEngine.TemplateResource

Modifier and Type	Field and Description
private final Map<String, GroovyCodeSource>	codeSourceCache
private final CompilerConfiguration	compilerConfiguration
private static final AtomicLong	counter
private static final boolean	DEBUG_BYTECODE
private final MarkupTemplateEngine.TemplateGroovyClassLoader	groovyClassLoader
private static final Pattern	LOCALIZED_RESOURCE_PATTERN
pack-priv static final ClassNode	MARKUPTEMPLATEENGINE_CLASSNODE
pack-priv static final String	MODELTYPES_ASTKEY
private final TemplateConfiguration	templateConfiguration
private final TemplateResolver	templateResolver

Constructor Summary

Access	Constructor and Description
public	MarkupTemplateEngine()
public	MarkupTemplateEngine(final TemplateConfiguration config)
public	MarkupTemplateEngine(final ClassLoader parentLoader, final TemplateConfiguration config)
public	MarkupTemplateEngine(final ClassLoader parentLoader, final TemplateConfiguration config, final TemplateResolver resolver)
public	MarkupTemplateEngine(final ClassLoader parentLoader, final File directory where to find templates templateDirectory, TemplateConfiguration template engine configuration tplConfig) Convenience constructor to build a template engine which searches for templates into a directory

Method Summary

Modifier and Type	Method and Description
private static URL[]	buildURLs(final File templateDirectory)
public Template	createTemplate(final Reader reader) Implements abstract groovy.text.TemplateEngine.createTemplate. Creates a template by reading content from the Reader.
public Template	createTemplate(final Reader reader, String sourceName)
public Template	createTemplate(final URL resource) Overrides groovy.text.TemplateEngine.createTemplate. Creates a template from the content found at the URL using the default encoding.
public Template	createTemplateByPath(final String templatePath)
public Template	createTypeCheckedModelTemplate(final String source, Map<String, String> modelTypes)
public Template	createTypeCheckedModelTemplate(final String source, String sourceName, Map<String, String> modelTypes)
public Template	createTypeCheckedModelTemplate(final Reader reader, Map<String, String> modelTypes)
public Template	createTypeCheckedModelTemplate(final Reader reader, String sourceName, Map<String, String> modelTypes)
public Template	createTypeCheckedModelTemplate(final URL resource, Map<String, String> modelTypes)
public Template	createTypeCheckedModelTemplateByPath(final String templatePath, Map<String, String> modelTypes)
public CompilerConfiguration	getCompilerConfiguration()
public TemplateConfiguration	getTemplateConfiguration()
public GroovyClassLoader	getTemplateLoader()
public URL	resolveTemplate(String templatePath)

Inherited from groovy.text.TemplateEngine:: createTemplate createTemplate createTemplate createTemplate

codeSourceCache	back to summary
private final Map<String, GroovyCodeSource> codeSourceCache

compilerConfiguration	back to summary
private final CompilerConfiguration compilerConfiguration

counter	back to summary
private static final AtomicLong counter

DEBUG_BYTECODE	back to summary
private static final boolean DEBUG_BYTECODE

groovyClassLoader	back to summary
private final MarkupTemplateEngine.TemplateGroovyClassLoader groovyClassLoader

LOCALIZED_RESOURCE_PATTERN	back to summary
private static final Pattern LOCALIZED_RESOURCE_PATTERN

MARKUPTEMPLATEENGINE_CLASSNODE	back to summary
pack-priv static final ClassNode MARKUPTEMPLATEENGINE_CLASSNODE

MODELTYPES_ASTKEY	back to summary
pack-priv static final String MODELTYPES_ASTKEY

templateConfiguration	back to summary
private final TemplateConfiguration templateConfiguration

templateResolver	back to summary
private final TemplateResolver templateResolver

Constructor Detail

MarkupTemplateEngine	back to summary
public MarkupTemplateEngine()

MarkupTemplateEngine	back to summary
public MarkupTemplateEngine(final TemplateConfiguration config)

MarkupTemplateEngine	back to summary
public MarkupTemplateEngine(final ClassLoader parentLoader, final TemplateConfiguration config)

MarkupTemplateEngine	back to summary
public MarkupTemplateEngine(final ClassLoader parentLoader, final TemplateConfiguration config, final TemplateResolver resolver)

MarkupTemplateEngine	back to summary
public MarkupTemplateEngine(final ClassLoader parentLoader, final File templateDirectory, TemplateConfiguration tplConfig) Convenience constructor to build a template engine which searches for templates into a directory Parameters templateDirectory:File directory where to find templates tplConfig:TemplateConfiguration template engine configuration

MarkupTemplateEngine

back to summary

public MarkupTemplateEngine(final ClassLoader parentLoader, final File templateDirectory, TemplateConfiguration tplConfig)

Convenience constructor to build a template engine which searches for templates into a directory

Parameters

templateDirectory:File: directory where to find templates
tplConfig:TemplateConfiguration: template engine configuration

Method Detail

buildURLs	back to summary
private static URL[] buildURLs(final File templateDirectory)

createTemplate	back to summary
public Template createTemplate(final Reader reader) throws CompilationFailedException, ClassNotFoundException, IOException Implements abstract groovy.text.TemplateEngine.createTemplate. Doc from groovy.text.TemplateEngine.createTemplate. Creates a template by reading content from the Reader.

createTemplate

back to summary

public Template createTemplate(final Reader reader) throws CompilationFailedException, ClassNotFoundException, IOException

Implements abstract groovy.text.TemplateEngine.createTemplate.

Doc from groovy.text.TemplateEngine.createTemplate.

Creates a template by reading content from the Reader.

createTemplate	back to summary
public Template createTemplate(final Reader reader, String sourceName) throws CompilationFailedException, ClassNotFoundException, IOException

createTemplate back to summary

createTemplate	back to summary
public Template createTemplate(final URL resource) throws CompilationFailedException, ClassNotFoundException, IOException Overrides groovy.text.TemplateEngine.createTemplate. Doc from groovy.text.TemplateEngine.createTemplate. Creates a template from the content found at the URL using the default encoding. Please consider using `createTemplate(URL, Charset)`. Annotations @Override

public Template createTemplate(final URL resource) throws CompilationFailedException, ClassNotFoundException, IOException

Overrides groovy.text.TemplateEngine.createTemplate.

Doc from groovy.text.TemplateEngine.createTemplate.

Creates a template from the content found at the URL using the default encoding. Please consider using createTemplate(URL, Charset).

Annotations

@Override

createTemplateByPath	back to summary
public Template createTemplateByPath(final String templatePath) throws CompilationFailedException, ClassNotFoundException, IOException

createTypeCheckedModelTemplate	back to summary
public Template createTypeCheckedModelTemplate(final String source, Map<String, String> modelTypes) throws CompilationFailedException, ClassNotFoundException, IOException

createTypeCheckedModelTemplate	back to summary
public Template createTypeCheckedModelTemplate(final String source, String sourceName, Map<String, String> modelTypes) throws CompilationFailedException, ClassNotFoundException, IOException

createTypeCheckedModelTemplate	back to summary
public Template createTypeCheckedModelTemplate(final Reader reader, Map<String, String> modelTypes) throws CompilationFailedException, ClassNotFoundException, IOException

createTypeCheckedModelTemplate	back to summary
public Template createTypeCheckedModelTemplate(final Reader reader, String sourceName, Map<String, String> modelTypes) throws CompilationFailedException, ClassNotFoundException, IOException

createTypeCheckedModelTemplate	back to summary
public Template createTypeCheckedModelTemplate(final URL resource, Map<String, String> modelTypes) throws CompilationFailedException, ClassNotFoundException, IOException

createTypeCheckedModelTemplateByPath	back to summary
public Template createTypeCheckedModelTemplateByPath(final String templatePath, Map<String, String> modelTypes) throws CompilationFailedException, ClassNotFoundException, IOException

getCompilerConfiguration	back to summary
public CompilerConfiguration getCompilerConfiguration()

getTemplateConfiguration	back to summary
public TemplateConfiguration getTemplateConfiguration()

getTemplateLoader	back to summary
public GroovyClassLoader getTemplateLoader()

resolveTemplate	back to summary
public URL resolveTemplate(String templatePath) throws IOException

groovy.text.markup back to summary

public Class MarkupTemplateEngine.CachingTemplateResolver

Class Inheritance

extends DefaultTemplateResolver

java.lang.Object
groovy.text.markup.MarkupTemplateEngine.DefaultTemplateResolver
groovy.text.markup.MarkupTemplateEngine.CachingTemplateResolver

A template resolver which avoids calling ClassLoader#getResource(String) if a template path already has been queried before. This improves performance if caching is enabled in the configuration.

Field Summary

Modifier and Type	Field and Description
protected final Map<String, URL>	cache
protected boolean	useCache

Constructor Summary

Access	Constructor and Description
public	CachingTemplateResolver(final Map<String, URL> the backing cache cache) Creates a new caching template resolver.
public	CachingTemplateResolver() Creates a new caching template resolver using a concurrent hash map as the backing cache.

Method Summary

Modifier and Type	Method and Description
public void	configure(final ClassLoader the classloader where templates will be searched for templateClassLoader, final TemplateConfiguration the configuration of the template engine configuration) Overrides groovy.text.markup.MarkupTemplateEngine.DefaultTemplateResolver.configure. Implements groovy.text.markup.TemplateResolver.configure. This method is called once the template engine is initialized, providing the resolver with the template engine configuration and its template class loader.
public URL	resolveTemplate(final String path to the template templatePath) Overrides groovy.text.markup.MarkupTemplateEngine.DefaultTemplateResolver.resolveTemplate. Implements groovy.text.markup.TemplateResolver.resolveTemplate. Resolvers must implement this method in order to resolve a template, given a template path.

Modifier and Type

Method and Description

public void

configure(final ClassLoader

the classloader where templates will be searched for

templateClassLoader, final TemplateConfiguration

the configuration of the template engine

configuration)

Overrides groovy.text.markup.MarkupTemplateEngine.DefaultTemplateResolver.configure.

Implements groovy.text.markup.TemplateResolver.configure.

This method is called once the template engine is initialized, providing the resolver with the template engine configuration and its template class loader.

public URL

resolveTemplate(final String

path to the template

templatePath)

Overrides groovy.text.markup.MarkupTemplateEngine.DefaultTemplateResolver.resolveTemplate.

Implements groovy.text.markup.TemplateResolver.resolveTemplate.

Resolvers must implement this method in order to resolve a template, given a template path.

Field Detail

cache	back to summary
protected final Map<String, URL> cache

useCache	back to summary
protected boolean useCache

Constructor Detail

CachingTemplateResolver	back to summary
public CachingTemplateResolver(final Map<String, URL> cache) Creates a new caching template resolver. The cache implementation being used depends on the use of the template engine. If multiple templates can be rendered in parallel, it must be using a thread-safe cache. Parameters cache:Map<String, URL> the backing cache

CachingTemplateResolver

back to summary

public CachingTemplateResolver(final Map<String, URL> cache)

Creates a new caching template resolver. The cache implementation being used depends on the use of the template engine. If multiple templates can be rendered in parallel, it must be using a thread-safe cache.

Parameters

cache:Map<String, URL>: the backing cache

CachingTemplateResolver	back to summary
public CachingTemplateResolver() Creates a new caching template resolver using a concurrent hash map as the backing cache.

Method Detail

configure	back to summary
public void configure(final ClassLoader templateClassLoader, final TemplateConfiguration configuration) Overrides groovy.text.markup.MarkupTemplateEngine.DefaultTemplateResolver.configure. Implements groovy.text.markup.TemplateResolver.configure. Doc from groovy.text.markup.TemplateResolver.configure. This method is called once the template engine is initialized, providing the resolver with the template engine configuration and its template class loader. Parameters templateClassLoader:ClassLoader the classloader where templates will be searched for configuration:TemplateConfiguration the configuration of the template engine Annotations @Override

configure

back to summary

public void configure(final ClassLoader templateClassLoader, final TemplateConfiguration configuration)

Overrides groovy.text.markup.MarkupTemplateEngine.DefaultTemplateResolver.configure.

Implements groovy.text.markup.TemplateResolver.configure.

Doc from groovy.text.markup.TemplateResolver.configure.

This method is called once the template engine is initialized, providing the resolver with the template engine configuration and its template class loader.

Parameters

templateClassLoader:ClassLoader: the classloader where templates will be searched for
configuration:TemplateConfiguration: the configuration of the template engine

Annotations

@Override

resolveTemplate	back to summary
public URL resolveTemplate(final String templatePath) throws IOException Overrides groovy.text.markup.MarkupTemplateEngine.DefaultTemplateResolver.resolveTemplate. Implements groovy.text.markup.TemplateResolver.resolveTemplate. Doc from groovy.text.markup.TemplateResolver.resolveTemplate. Resolvers must implement this method in order to resolve a template, given a template path. They must return a valid URL or an IOException. Parameters templatePath:String path to the template Returns:URL the template URL, that will be used to load the template Annotations @Override

resolveTemplate

back to summary

public URL resolveTemplate(final String templatePath) throws IOException

Overrides groovy.text.markup.MarkupTemplateEngine.DefaultTemplateResolver.resolveTemplate.

Implements groovy.text.markup.TemplateResolver.resolveTemplate.

Doc from groovy.text.markup.TemplateResolver.resolveTemplate.

Resolvers must implement this method in order to resolve a template, given a template path. They must return a valid URL or an IOException.

Parameters

templatePath:String: path to the template

Returns:URL

the template URL, that will be used to load the template

Annotations

@Override

groovy.text.markup back to summary

public Class MarkupTemplateEngine.DefaultTemplateResolver

Class Inheritance

extends Object
implements TemplateResolver

java.lang.Object
groovy.text.markup.MarkupTemplateEngine.DefaultTemplateResolver

All Implemented Interfaces

groovy.text.markup.TemplateResolver

Known Direct Subclasses

groovy.text.markup.MarkupTemplateEngine.CachingTemplateResolver

Field Summary

Modifier and Type	Field and Description
private ClassLoader	templateClassLoader
private TemplateConfiguration	templateConfiguration

Constructor Summary

Access	Constructor and Description
public	DefaultTemplateResolver()

Method Summary

Modifier and Type	Method and Description
public void	configure(final ClassLoader the classloader where templates will be searched for templateClassLoader, final TemplateConfiguration the configuration of the template engine configuration) Implements groovy.text.markup.TemplateResolver.configure. This method is called once the template engine is initialized, providing the resolver with the template engine configuration and its template class loader.
public URL	resolveTemplate(final String path to the template templatePath) Implements groovy.text.markup.TemplateResolver.resolveTemplate. Resolvers must implement this method in order to resolve a template, given a template path.

Modifier and Type

Method and Description

public void

configure(final ClassLoader

the classloader where templates will be searched for

templateClassLoader, final TemplateConfiguration

the configuration of the template engine

configuration)

Implements groovy.text.markup.TemplateResolver.configure.

This method is called once the template engine is initialized, providing the resolver with the template engine configuration and its template class loader.

public URL

resolveTemplate(final String

path to the template

templatePath)

Implements groovy.text.markup.TemplateResolver.resolveTemplate.

Resolvers must implement this method in order to resolve a template, given a template path.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

templateClassLoader	back to summary
private ClassLoader templateClassLoader

templateConfiguration	back to summary
private TemplateConfiguration templateConfiguration

Constructor Detail

DefaultTemplateResolver	back to summary
public DefaultTemplateResolver()

Method Detail

configure	back to summary
public void configure(final ClassLoader templateClassLoader, final TemplateConfiguration configuration) Implements groovy.text.markup.TemplateResolver.configure. Doc from groovy.text.markup.TemplateResolver.configure. This method is called once the template engine is initialized, providing the resolver with the template engine configuration and its template class loader. Parameters templateClassLoader:ClassLoader the classloader where templates will be searched for configuration:TemplateConfiguration the configuration of the template engine

configure

back to summary

public void configure(final ClassLoader templateClassLoader, final TemplateConfiguration configuration)

Implements groovy.text.markup.TemplateResolver.configure.

Doc from groovy.text.markup.TemplateResolver.configure.

This method is called once the template engine is initialized, providing the resolver with the template engine configuration and its template class loader.

Parameters

templateClassLoader:ClassLoader: the classloader where templates will be searched for
configuration:TemplateConfiguration: the configuration of the template engine

resolveTemplate

back to summary

public URL resolveTemplate(final String templatePath) throws IOException

Implements groovy.text.markup.TemplateResolver.resolveTemplate.

Doc from groovy.text.markup.TemplateResolver.resolveTemplate.

Resolvers must implement this method in order to resolve a template, given a template path. They must return a valid URL or an IOException.

Parameters

templatePath:String: path to the template

Returns:URL

the template URL, that will be used to load the template

groovy.text.markup back to summary

private Class MarkupTemplateEngine.MarkupTemplateMaker

Class Inheritance

extends Object
implements Template

java.lang.Object
groovy.text.markup.MarkupTemplateEngine.MarkupTemplateMaker

All Implemented Interfaces

groovy.text.Template

Implements the groovy.text.Template interface by caching a compiled template script and keeping a reference to the optional map of types of the model elements.

Field Summary

Modifier and Type	Field and Description
pack-priv final Map<String, String>	modeltypes
pack-priv final Class<BaseTemplate>	templateClass

Constructor Summary

Access	Constructor and Description
public	MarkupTemplateMaker(final Reader reader, String sourceName, Map<String, String> modelTypes)
public	MarkupTemplateMaker(final URL resource, Map<String, String> modelTypes)

Method Summary

Modifier and Type	Method and Description
public Writable	make() Implements groovy.text.Template.make.
public Writable	make(final Map<K, V> binding) Implements groovy.text.Template.make.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

modeltypes	back to summary
pack-priv final Map<String, String> modeltypes

templateClass	back to summary
pack-priv final Class<BaseTemplate> templateClass

Constructor Detail

MarkupTemplateMaker	back to summary
public MarkupTemplateMaker(final Reader reader, String sourceName, Map<String, String> modelTypes) Annotations @SuppressWarnings:unchecked

MarkupTemplateMaker	back to summary
public MarkupTemplateMaker(final URL resource, Map<String, String> modelTypes) throws IOException Annotations @SuppressWarnings:unchecked

Method Detail

make	back to summary
public Writable make() Implements groovy.text.Template.make.

make	back to summary
public Writable make(final Map<K, V> binding) Implements groovy.text.Template.make.

groovy.text.markup back to summary

pack-priv Class MarkupTemplateEngine.TemplateGroovyClassLoader

Class Inheritance

extends GroovyClassLoader

java.lang.Object
java.lang.ClassLoader
java.security.SecureClassLoader
java.net.URLClassLoader
groovy.lang.GroovyClassLoader
groovy.text.markup.MarkupTemplateEngine.TemplateGroovyClassLoader

A specialized GroovyClassLoader which will support passing values to the type checking extension thanks to a thread local.

Field Summary

Modifier and Type	Field and Description
pack-priv static final ThreadLocal<Map<String, String>>	modelTypes

Inherited from groovy.lang.GroovyClassLoader:: classCache sourceCache

Constructor Summary

Access	Constructor and Description
public	TemplateGroovyClassLoader(final ClassLoader parentLoader, final CompilerConfiguration compilerConfiguration)

Method Summary

Modifier and Type	Method and Description
public Class<T>	parseClass(final GroovyCodeSource codeSource, Map<String, String> hints)

Field Detail

modelTypes	back to summary
pack-priv static final ThreadLocal<Map<String, String>> modelTypes

Constructor Detail

TemplateGroovyClassLoader	back to summary
public TemplateGroovyClassLoader(final ClassLoader parentLoader, final CompilerConfiguration compilerConfiguration)

Method Detail

parseClass	back to summary
public Class<T> parseClass(final GroovyCodeSource codeSource, Map<String, String> hints) throws CompilationFailedException

groovy.text.markup back to summary

public Class MarkupTemplateEngine.TemplateResource

Class Inheritance

extends Object

java.lang.Object
groovy.text.markup.MarkupTemplateEngine.TemplateResource

Field Summary

Modifier and Type	Field and Description
private final String	baseName
private final String	extension
private final String	locale

Constructor Summary

Access	Constructor and Description
private	TemplateResource(final String baseName, final String locale, final String extension)

Method Summary

Modifier and Type	Method and Description
public boolean	hasLocale()
public static MarkupTemplateEngine.TemplateResource	parse(String fullPath)
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.
public MarkupTemplateEngine.TemplateResource	withLocale(String locale)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll wait wait wait

Field Detail

baseName	back to summary
private final String baseName

extension	back to summary
private final String extension

locale	back to summary
private final String locale

Constructor Detail

TemplateResource	back to summary
private TemplateResource(final String baseName, final String locale, final String extension)

Method Detail

hasLocale	back to summary
public boolean hasLocale()

parse	back to summary
public static MarkupTemplateEngine.TemplateResource parse(String fullPath)

toString back to summary

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Returns:String: a string representation of the object

withLocale	back to summary
public MarkupTemplateEngine.TemplateResource withLocale(String locale)