Package groovy.text.markup
Class MarkupTemplateEngine
java.lang.Object
groovy.text.TemplateEngine
groovy.text.markup.MarkupTemplateEngine
public class MarkupTemplateEngine extends TemplateEngine
A template engine which leverages
StreamingMarkupBuilder to generate XML/XHTML.-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classMarkupTemplateEngine.CachingTemplateResolverA template resolver which avoids callingClassLoader.getResource(String)if a template path already has been queried before.static classMarkupTemplateEngine.DefaultTemplateResolverstatic classMarkupTemplateEngine.TemplateResource -
Constructor Summary
Constructors Constructor Description MarkupTemplateEngine()MarkupTemplateEngine(TemplateConfiguration config)MarkupTemplateEngine(java.lang.ClassLoader parentLoader, TemplateConfiguration config)MarkupTemplateEngine(java.lang.ClassLoader parentLoader, TemplateConfiguration config, TemplateResolver resolver)MarkupTemplateEngine(java.lang.ClassLoader parentLoader, java.io.File templateDirectory, TemplateConfiguration tplConfig)Convenience constructor to build a template engine which searches for templates into a directory -
Method Summary
Modifier and Type Method Description TemplatecreateTemplate(java.io.Reader reader)Creates a template by reading content from the Reader.TemplatecreateTemplate(java.io.Reader reader, java.lang.String sourceName)TemplatecreateTemplate(java.net.URL resource)Creates a template from the content found at the URL using the default encoding.TemplatecreateTemplateByPath(java.lang.String templatePath)TemplatecreateTypeCheckedModelTemplate(java.io.Reader reader, java.lang.String sourceName, java.util.Map<java.lang.String,java.lang.String> modelTypes)TemplatecreateTypeCheckedModelTemplate(java.io.Reader reader, java.util.Map<java.lang.String,java.lang.String> modelTypes)TemplatecreateTypeCheckedModelTemplate(java.lang.String source, java.lang.String sourceName, java.util.Map<java.lang.String,java.lang.String> modelTypes)TemplatecreateTypeCheckedModelTemplate(java.lang.String source, java.util.Map<java.lang.String,java.lang.String> modelTypes)TemplatecreateTypeCheckedModelTemplate(java.net.URL resource, java.util.Map<java.lang.String,java.lang.String> modelTypes)TemplatecreateTypeCheckedModelTemplateByPath(java.lang.String templatePath, java.util.Map<java.lang.String,java.lang.String> modelTypes)CompilerConfigurationgetCompilerConfiguration()TemplateConfigurationgetTemplateConfiguration()GroovyClassLoadergetTemplateLoader()java.net.URLresolveTemplate(java.lang.String templatePath)Methods inherited from class groovy.text.TemplateEngine
createTemplate, createTemplate, createTemplate, createTemplateMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Constructor Details
-
MarkupTemplateEngine
public MarkupTemplateEngine() -
MarkupTemplateEngine
-
MarkupTemplateEngine
-
MarkupTemplateEngine
public MarkupTemplateEngine(java.lang.ClassLoader parentLoader, TemplateConfiguration config, TemplateResolver resolver) -
MarkupTemplateEngine
public MarkupTemplateEngine(java.lang.ClassLoader parentLoader, java.io.File templateDirectory, TemplateConfiguration tplConfig)Convenience constructor to build a template engine which searches for templates into a directory- Parameters:
templateDirectory- directory where to find templatestplConfig- template engine configuration
-
-
Method Details
-
createTemplate
public Template createTemplate(java.io.Reader reader) throws CompilationFailedException, java.lang.ClassNotFoundException, java.io.IOExceptionDescription copied from class:TemplateEngineCreates a template by reading content from the Reader.- Specified by:
createTemplatein classTemplateEngine- Throws:
CompilationFailedExceptionjava.lang.ClassNotFoundExceptionjava.io.IOException
-
createTemplate
public Template createTemplate(java.io.Reader reader, java.lang.String sourceName) throws CompilationFailedException, java.lang.ClassNotFoundException, java.io.IOException- Throws:
CompilationFailedExceptionjava.lang.ClassNotFoundExceptionjava.io.IOException
-
createTemplateByPath
public Template createTemplateByPath(java.lang.String templatePath) throws CompilationFailedException, java.lang.ClassNotFoundException, java.io.IOException- Throws:
CompilationFailedExceptionjava.lang.ClassNotFoundExceptionjava.io.IOException
-
createTypeCheckedModelTemplate
public Template createTypeCheckedModelTemplate(java.lang.String source, java.util.Map<java.lang.String,java.lang.String> modelTypes) throws CompilationFailedException, java.lang.ClassNotFoundException, java.io.IOException- Throws:
CompilationFailedExceptionjava.lang.ClassNotFoundExceptionjava.io.IOException
-
createTypeCheckedModelTemplate
public Template createTypeCheckedModelTemplate(java.lang.String source, java.lang.String sourceName, java.util.Map<java.lang.String,java.lang.String> modelTypes) throws CompilationFailedException, java.lang.ClassNotFoundException, java.io.IOException- Throws:
CompilationFailedExceptionjava.lang.ClassNotFoundExceptionjava.io.IOException
-
createTypeCheckedModelTemplate
public Template createTypeCheckedModelTemplate(java.io.Reader reader, java.util.Map<java.lang.String,java.lang.String> modelTypes) throws CompilationFailedException, java.lang.ClassNotFoundException, java.io.IOException- Throws:
CompilationFailedExceptionjava.lang.ClassNotFoundExceptionjava.io.IOException
-
createTypeCheckedModelTemplate
public Template createTypeCheckedModelTemplate(java.io.Reader reader, java.lang.String sourceName, java.util.Map<java.lang.String,java.lang.String> modelTypes) throws CompilationFailedException, java.lang.ClassNotFoundException, java.io.IOException- Throws:
CompilationFailedExceptionjava.lang.ClassNotFoundExceptionjava.io.IOException
-
createTypeCheckedModelTemplateByPath
public Template createTypeCheckedModelTemplateByPath(java.lang.String templatePath, java.util.Map<java.lang.String,java.lang.String> modelTypes) throws CompilationFailedException, java.lang.ClassNotFoundException, java.io.IOException- Throws:
CompilationFailedExceptionjava.lang.ClassNotFoundExceptionjava.io.IOException
-
createTemplate
public Template createTemplate(java.net.URL resource) throws CompilationFailedException, java.lang.ClassNotFoundException, java.io.IOExceptionDescription copied from class:TemplateEngineCreates a template from the content found at the URL using the default encoding. Please consider usingTemplateEngine.createTemplate(URL, Charset).- Overrides:
createTemplatein classTemplateEngine- Throws:
CompilationFailedExceptionjava.lang.ClassNotFoundExceptionjava.io.IOException
-
createTypeCheckedModelTemplate
public Template createTypeCheckedModelTemplate(java.net.URL resource, java.util.Map<java.lang.String,java.lang.String> modelTypes) throws CompilationFailedException, java.lang.ClassNotFoundException, java.io.IOException- Throws:
CompilationFailedExceptionjava.lang.ClassNotFoundExceptionjava.io.IOException
-
getTemplateLoader
-
getCompilerConfiguration
-
getTemplateConfiguration
-
resolveTemplate
public java.net.URL resolveTemplate(java.lang.String templatePath) throws java.io.IOException- Throws:
java.io.IOException
-