ResolvableGroovyTemplateEngine (Grails Views 1.1.6)

grails.views.ResolvableGroovyTemplateEngine

A TemplateEngine that can resolve templates using the configured TemplateResolver
Authors:
Graeme Rocher
Since:
1.0

Field Summary

Fields
Modifiers	Name	Description
`protected java.util.Map<java.lang.String, WritableScriptTemplate>`	`cachedTemplates`
`protected org.codehaus.groovy.control.CompilerConfiguration`	`compilerConfiguration`	Whether to reload views
`protected java.util.Map<java.util.List, WritableScriptTemplate>`	`resolveCache`

Properties Summary

Properties
Type	Name and description
`groovy.lang.GroovyClassLoader`	`classLoader` The class loader to use
`boolean`	`enableReloading` Whether to enable reloading
`java.lang.String`	`extension` The view uri resolver
`boolean`	`shouldCache`
`TemplateResolver`	`templateResolver` The TemplateResolver to use
`ViewConfiguration`	`viewConfiguration` The view config
`ViewUriResolver`	`viewUriResolver` The configuration to use for compilation

Constructor Summary

Constructors
Constructor and description
`ResolvableGroovyTemplateEngine (ViewConfiguration configuration)` Creates a ResolvableGroovyTemplateEngine for the given base class name and file extension

Methods Summary

Methods
Type	Name and description
`protected WritableScriptTemplate`	`createTemplate(java.lang.Class<? extends groovy.text.Template> cls)` Creates a template for the given template class
`protected WritableScriptTemplate`	`createTemplate(java.lang.Class<? extends groovy.text.Template> cls, java.io.File sourceFile)` Creates a template for the given template class
`WritableScriptTemplate`	`createTemplate(java.io.File file)`
`WritableScriptTemplate`	`createTemplate(java.net.URL url)`
`WritableScriptTemplate`	`createTemplate(java.lang.String path, java.net.URL url)`
`WritableScriptTemplate`	`createTemplate(java.io.Reader reader)`
`org.codehaus.groovy.control.CompilerConfiguration`	`getCompilerConfiguration()`
`java.lang.String`	`getDynamicTemplatePrefix()`
`protected WritableScriptTemplate`	`initializeTemplate(GrailsViewTemplate template, java.io.File sourceFile)` Initialises a template instance
`protected ViewsTransform`	`newViewsTransform()`
`protected void`	`prepareCustomizers(org.codehaus.groovy.control.CompilerConfiguration compilerConfiguration)`
`WritableScriptTemplate`	`resolveTemplate(java.lang.Class type, java.util.Locale locale, java.lang.String... qualifiers)` Resolves a template for the given object
`WritableScriptTemplate`	`resolveTemplate(java.lang.String path)` Resolves a template for the given path
`WritableScriptTemplate`	`resolveTemplate(java.lang.String path, java.util.Locale locale, java.lang.String... qualifiers)` Resolves a template for the given path
`void`	`setLinkGenerator(grails.web.mapping.LinkGenerator linkGenerator)`
`void`	`setMappingContext(org.grails.datastore.mapping.model.MappingContext mappingContext)`
`void`	`setMessageSource(org.springframework.context.MessageSource messageSource)`
`void`	`setMimeUtility(MimeUtility mimeUtility)`
`void`	`setProxyHandler(grails.core.support.proxy.ProxyHandler proxyHandler)`

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class groovy.text.TemplateEngine`	groovy.text.TemplateEngine#createTemplate(java.io.File), groovy.text.TemplateEngine#createTemplate(java.net.URL), groovy.text.TemplateEngine#createTemplate(java.io.Reader), groovy.text.TemplateEngine#createTemplate(java.lang.String), groovy.text.TemplateEngine#wait(long, int), groovy.text.TemplateEngine#wait(long), groovy.text.TemplateEngine#wait(), groovy.text.TemplateEngine#equals(java.lang.Object), groovy.text.TemplateEngine#toString(), groovy.text.TemplateEngine#hashCode(), groovy.text.TemplateEngine#getClass(), groovy.text.TemplateEngine#notify(), groovy.text.TemplateEngine#notifyAll()
`class java.lang.Object`	`java.lang.Object#wait(long, int), java.lang.Object#wait(long), java.lang.Object#wait(), java.lang.Object#equals(java.lang.Object), java.lang.Object#toString(), java.lang.Object#hashCode(), java.lang.Object#getClass(), java.lang.Object#notify(), java.lang.Object#notifyAll()`

- Field Detail
  - protected java.util.Map<java.lang.String, WritableScriptTemplate> cachedTemplates
  - protected org.codehaus.groovy.control.CompilerConfiguration compilerConfiguration
    
    Whether to reload views
  - protected java.util.Map<java.util.List, WritableScriptTemplate> resolveCache
- Property Detail
  - final groovy.lang.GroovyClassLoader classLoader
    
    The class loader to use
  - final boolean enableReloading
    
    Whether to enable reloading
  - final java.lang.String extension
    
    The view uri resolver
  - final boolean shouldCache
  - TemplateResolver templateResolver
    
    The TemplateResolver to use
  - @groovy.lang.Delegate final ViewConfiguration viewConfiguration
    
    The view config
  - final ViewUriResolver viewUriResolver
    
    The configuration to use for compilation
- Constructor Detail
  - ResolvableGroovyTemplateEngine(ViewConfiguration configuration)
    
    Creates a ResolvableGroovyTemplateEngine for the given base class name and file extension
    Parameters:
    baseClassName - The base class name
    extension - The file extension
- Method Detail
  - protected WritableScriptTemplate createTemplate(java.lang.Class<? extends groovy.text.Template> cls)
    
    Creates a template for the given template class
    Parameters:
    cls - The class
    Returns:
    The template
  - protected WritableScriptTemplate createTemplate(java.lang.Class<? extends groovy.text.Template> cls, java.io.File sourceFile)
    
    Creates a template for the given template class
    Parameters:
    cls - The class
    Returns:
    The template
  - @java.lang.Override WritableScriptTemplate createTemplate(java.io.File file)
  - @java.lang.Override WritableScriptTemplate createTemplate(java.net.URL url)
  - WritableScriptTemplate createTemplate(java.lang.String path, java.net.URL url)
  - @java.lang.Override WritableScriptTemplate createTemplate(java.io.Reader reader)
  - org.codehaus.groovy.control.CompilerConfiguration getCompilerConfiguration()
  - java.lang.String getDynamicTemplatePrefix()
  - protected WritableScriptTemplate initializeTemplate(GrailsViewTemplate template, java.io.File sourceFile)
    
    Initialises a template instance
    Parameters:
    template - The created template
    sourceFile - The source file
    Returns:
    The initialized template
  - protected ViewsTransform newViewsTransform()
  - protected void prepareCustomizers(org.codehaus.groovy.control.CompilerConfiguration compilerConfiguration)
  - WritableScriptTemplate resolveTemplate(java.lang.Class type, java.util.Locale locale, java.lang.String... qualifiers)
    
    Resolves a template for the given object
    Parameters:
    object - The object
    qualifiers - One or many qualifiers to scope the view (for example the locale, the version etc.)
    Returns:
    The template or null if it doesn't exist
  - WritableScriptTemplate resolveTemplate(java.lang.String path)
    
    Resolves a template for the given path
    Parameters:
    path - The path to the template
    Returns:
    The template or null if it doesn't exist
  - WritableScriptTemplate resolveTemplate(java.lang.String path, java.util.Locale locale, java.lang.String... qualifiers)
    
    Resolves a template for the given path
    Parameters:
    path - The path to the template
    qualifiers - One or many qualifiers to scope the view (for example the locale, the version etc.)
    Returns:
    The template or null if it doesn't exist
  - @org.springframework.beans.factory.annotation.Autowired void setLinkGenerator(grails.web.mapping.LinkGenerator linkGenerator)
  - @org.springframework.beans.factory.annotation.Autowired(required = false) @org.springframework.beans.factory.annotation.Qualifier("grailsDomainClassMappingContext") void setMappingContext(org.grails.datastore.mapping.model.MappingContext mappingContext)
  - @org.springframework.beans.factory.annotation.Autowired(required = false) void setMessageSource(org.springframework.context.MessageSource messageSource)
  - @org.springframework.beans.factory.annotation.Autowired(required = false) void setMimeUtility(MimeUtility mimeUtility)
  - @org.springframework.beans.factory.annotation.Autowired(required = false) void setProxyHandler(grails.core.support.proxy.ProxyHandler proxyHandler)

Summary:
Field
Property
Constructor
Method

Groovy Documentation

[Groovy] Class ResolvableGroovyTemplateEngine

Field Summary

Properties Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Field Detail

protected java.util.Map<java.lang.String, WritableScriptTemplate> cachedTemplates

protected org.codehaus.groovy.control.CompilerConfiguration compilerConfiguration

protected java.util.Map<java.util.List, WritableScriptTemplate> resolveCache

Property Detail

final groovy.lang.GroovyClassLoader classLoader

final boolean enableReloading

final java.lang.String extension

final boolean shouldCache

TemplateResolver templateResolver

@groovy.lang.Delegate final ViewConfiguration viewConfiguration

final ViewUriResolver viewUriResolver

Constructor Detail

ResolvableGroovyTemplateEngine(ViewConfiguration configuration)

Method Detail

protected WritableScriptTemplate createTemplate(java.lang.Class<? extends groovy.text.Template> cls)

protected WritableScriptTemplate createTemplate(java.lang.Class<? extends groovy.text.Template> cls, java.io.File sourceFile)

@java.lang.Override WritableScriptTemplate createTemplate(java.io.File file)

@java.lang.Override WritableScriptTemplate createTemplate(java.net.URL url)

WritableScriptTemplate createTemplate(java.lang.String path, java.net.URL url)

@java.lang.Override WritableScriptTemplate createTemplate(java.io.Reader reader)

org.codehaus.groovy.control.CompilerConfiguration getCompilerConfiguration()

java.lang.String getDynamicTemplatePrefix()

protected WritableScriptTemplate initializeTemplate(GrailsViewTemplate template, java.io.File sourceFile)

protected ViewsTransform newViewsTransform()

protected void prepareCustomizers(org.codehaus.groovy.control.CompilerConfiguration compilerConfiguration)

WritableScriptTemplate resolveTemplate(java.lang.Class type, java.util.Locale locale, java.lang.String... qualifiers)

WritableScriptTemplate resolveTemplate(java.lang.String path)

WritableScriptTemplate resolveTemplate(java.lang.String path, java.util.Locale locale, java.lang.String... qualifiers)

@org.springframework.beans.factory.annotation.Autowired void setLinkGenerator(grails.web.mapping.LinkGenerator linkGenerator)

@org.springframework.beans.factory.annotation.Autowired(required = false) @org.springframework.beans.factory.annotation.Qualifier("grailsDomainClassMappingContext") void setMappingContext(org.grails.datastore.mapping.model.MappingContext mappingContext)

@org.springframework.beans.factory.annotation.Autowired(required = false) void setMessageSource(org.springframework.context.MessageSource messageSource)

@org.springframework.beans.factory.annotation.Autowired(required = false) void setMimeUtility(MimeUtility mimeUtility)

@org.springframework.beans.factory.annotation.Autowired(required = false) void setProxyHandler(grails.core.support.proxy.ProxyHandler proxyHandler)