org.codehaus.groovy.grails.support

Class ResourceAwareTemplateEngine

java.lang.Object

groovy.text.TemplateEngine

org.codehaus.groovy.grails.support.ResourceAwareTemplateEngine

public abstract class ResourceAwareTemplateEngine
extends groovy.text.TemplateEngine

An abstract TemplateEngine that extends the default Groovy TemplateEngine (@see groovy.text.TemplateEngine) and provides the ability to create templates from the Spring Resource API

Since:

0.4

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	BEAN_ID

Constructor Summary

Constructors

Constructor and Description
ResourceAwareTemplateEngine()

Method Summary

Modifier and Type	Method and Description
groovy.text.Template	createTemplate(java.io.File file)
abstract groovy.text.Template	createTemplate(java.io.InputStream inputStream) Unlike groovy.text.TemplateEngine, implementors need to provide an implementation that operates with an InputStream
groovy.text.Template	createTemplate(java.io.Reader reader)
groovy.text.Template	createTemplate(org.springframework.core.io.Resource resource) Creates the specified Template using the given Spring Resource
abstract groovy.text.Template	createTemplate(org.springframework.core.io.Resource resource, boolean cacheable) Creates the specified Template using the given Spring Resource
groovy.text.Template	createTemplate(java.lang.String templateText)
groovy.text.Template	createTemplate(java.net.URL url)
abstract groovy.text.Template	createTemplateForUri(java.lang.String[] uris)
abstract int	mapStackLineNumber(java.lang.String url, int lineNumber)

Methods inherited from class java.lang.Object

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

Field Detail

BEAN_ID

public static final java.lang.String BEAN_ID

See Also:

Constant Field Values

Constructor Detail

ResourceAwareTemplateEngine

public ResourceAwareTemplateEngine()

Method Detail

createTemplate

public groovy.text.Template createTemplate(org.springframework.core.io.Resource resource)
                                    throws java.io.IOException,
                                           java.lang.ClassNotFoundException

Creates the specified Template using the given Spring Resource

Parameters:

resource - The Spring Resource to create the template for

Returns:

A Template instance

Throws:

java.io.IOException - Thrown when there was an error reading the Template

java.lang.ClassNotFoundException - Thrown when there was a problem loading the Template into a class

createTemplate

public abstract groovy.text.Template createTemplate(org.springframework.core.io.Resource resource,
                                                    boolean cacheable)

Creates the specified Template using the given Spring Resource

Parameters:

resource - The Spring Resource to create the template for

cacheable - Whether the resource can be cached

Returns:

A Template instance

Throws:

java.io.IOException - Thrown when there was an error reading the Template

java.lang.ClassNotFoundException - Thrown when there was a problem loading the Template into a class

createTemplate

public final groovy.text.Template createTemplate(java.io.Reader reader)
                                          throws java.io.IOException

Specified by:

createTemplate in class groovy.text.TemplateEngine

Throws:

java.io.IOException

createTemplate

public abstract groovy.text.Template createTemplate(java.io.InputStream inputStream)
                                             throws java.io.IOException

Unlike groovy.text.TemplateEngine, implementors need to provide an implementation that operates with an InputStream

Parameters:

inputStream - The InputStream

Returns:

A Template instance

Throws:

java.io.IOException - Thrown when an IO error occurs reading the stream

createTemplate

public groovy.text.Template createTemplate(java.lang.String templateText)
                                    throws org.codehaus.groovy.control.CompilationFailedException,
                                           java.lang.ClassNotFoundException,
                                           java.io.IOException

Overrides:

createTemplate in class groovy.text.TemplateEngine

Throws:

org.codehaus.groovy.control.CompilationFailedException

java.lang.ClassNotFoundException

java.io.IOException

createTemplate

public groovy.text.Template createTemplate(java.io.File file)
                                    throws org.codehaus.groovy.control.CompilationFailedException,
                                           java.lang.ClassNotFoundException,
                                           java.io.IOException

Overrides:

createTemplate in class groovy.text.TemplateEngine

Throws:

org.codehaus.groovy.control.CompilationFailedException

java.lang.ClassNotFoundException

java.io.IOException

createTemplate

public groovy.text.Template createTemplate(java.net.URL url)
                                    throws org.codehaus.groovy.control.CompilationFailedException,
                                           java.lang.ClassNotFoundException,
                                           java.io.IOException

Overrides:

createTemplate in class groovy.text.TemplateEngine

Throws:

org.codehaus.groovy.control.CompilationFailedException

java.lang.ClassNotFoundException

java.io.IOException

createTemplateForUri

public abstract groovy.text.Template createTemplateForUri(java.lang.String[] uris)

mapStackLineNumber

public abstract int mapStackLineNumber(java.lang.String url,
                                       int lineNumber)