ResolvableGroovyTemplateEngine (Grails Views 3.2.3)

grails.views.ResolvableGroovyTemplateEngine

@groovy.transform.CompileStatic
@groovy.util.logging.Slf4j
abstract class ResolvableGroovyTemplateEngine
extends groovy.text.TemplateEngine

A TemplateEngine that can resolve templates using the configured TemplateResolver

Authors:: Graeme Rocher

Since:: 1.0

Nested Class Summary

Nested classes
Modifiers	Name	Description
`class`	`ResolvableGroovyTemplateEngine.1`

Field Summary

Fields
Modifiers	Name	Description
`private static WritableScriptTemplate`	`NULL_ENTRY`
`protected Cache<java.lang.String, WritableScriptTemplate>`	`cachedTemplates`
`private groovy.lang.GroovyClassLoader`	`classLoader`	The class loader to use
`protected org.codehaus.groovy.control.CompilerConfiguration`	`compilerConfiguration`	Whether to reload views
`private boolean`	`enableReloading`	Whether to enable reloading
`private java.lang.String`	`extension`	The view uri resolver
`private LinkGenerator`	`linkGenerator`
`private MappingContext`	`mappingContext`
`private MessageSource`	`messageSource`
`private MimeUtility`	`mimeUtility`
`private ProxyHandler`	`proxyHandler`
`protected Cache<java.util.List, WritableScriptTemplate>`	`resolveCache`
`private boolean`	`shouldCache`
`private int`	`templateCounter`
`private TemplateResolver`	`templateResolver`	The TemplateResolver to use
`private ViewConfiguration`	`viewConfiguration`	The view config
`private ViewUriResolver`	`viewUriResolver`	The configuration to use for compilation

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`
`groovy.text.markup.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, java.lang.ClassLoader classLoader)` Creates a ResolvableGroovyTemplateEngine for the given base class name and file extension

Methods Summary

Methods
Type Params	Return Type	Name and description
	`private WritableScriptTemplate`	`attemptResolveClass(java.lang.String path)`
	`private WritableScriptTemplate`	`attemptResolvePath(java.lang.String path)`
	`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)`
	`private WritableScriptTemplate`	`getCachedTemplatesWithDefault(java.lang.String key)`
	`org.codehaus.groovy.control.CompilerConfiguration`	`getCompilerConfiguration()`
	`abstract 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(LinkGenerator linkGenerator)`
	`void`	`setMappingContext(MappingContext mappingContext)`
	`void`	`setMessageSource(MessageSource messageSource)`
	`void`	`setMimeUtility(MimeUtility mimeUtility)`
	`void`	`setProxyHandler(ProxyHandler proxyHandler)`
	`private WritableScriptTemplate`	`templateByPath(java.lang.String path)`

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class groovy.text.TemplateEngine`	groovy.text.TemplateEngine#createTemplate(java.net.URL), groovy.text.TemplateEngine#createTemplate(java.io.File, java.nio.charset.Charset), groovy.text.TemplateEngine#createTemplate(java.net.URL, java.nio.charset.Charset), groovy.text.TemplateEngine#createTemplate(java.io.File), groovy.text.TemplateEngine#createTemplate(java.io.Reader), groovy.text.TemplateEngine#createTemplate(java.lang.String), groovy.text.TemplateEngine#wait(long), groovy.text.TemplateEngine#wait(long, int), 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()

- Field Detail
  - private static final WritableScriptTemplate NULL_ENTRY
  - protected Cache<java.lang.String, WritableScriptTemplate> cachedTemplates
  - private final groovy.lang.GroovyClassLoader classLoader
    
    The class loader to use
  - protected org.codehaus.groovy.control.CompilerConfiguration compilerConfiguration
    
    Whether to reload views
  - private final boolean enableReloading
    
    Whether to enable reloading
  - private final java.lang.String extension
    
    The view uri resolver
  - private LinkGenerator linkGenerator
  - private MappingContext mappingContext
  - private MessageSource messageSource
  - private MimeUtility mimeUtility
  - private ProxyHandler proxyHandler
  - protected Cache<java.util.List, WritableScriptTemplate> resolveCache
  - private final boolean shouldCache
  - private int templateCounter
  - private TemplateResolver templateResolver
    
    The TemplateResolver to use
  - @groovy.lang.Delegate private final ViewConfiguration viewConfiguration
    
    The view config
  - private final ViewUriResolver viewUriResolver
    
    The configuration to use for compilation
- 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
  - groovy.text.markup.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, java.lang.ClassLoader classLoader)
    
    Creates a ResolvableGroovyTemplateEngine for the given base class name and file extension
    Parameters:
    baseClassName - The base class name
    extension - The file extension
- Method Detail
  - private WritableScriptTemplate attemptResolveClass(java.lang.String path)
  - private WritableScriptTemplate attemptResolvePath(java.lang.String path)
  - 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)
  - private WritableScriptTemplate getCachedTemplatesWithDefault(java.lang.String key)
  - org.codehaus.groovy.control.CompilerConfiguration getCompilerConfiguration()
  - abstract 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(LinkGenerator linkGenerator)
  - @org.springframework.beans.factory.annotation.Autowired(required: false) @org.springframework.beans.factory.annotation.Qualifier(value: grailsDomainClassMappingContext) void setMappingContext(MappingContext mappingContext)
  - @org.springframework.beans.factory.annotation.Autowired(required: false) void setMessageSource(MessageSource messageSource)
  - @org.springframework.beans.factory.annotation.Autowired(required: false) void setMimeUtility(MimeUtility mimeUtility)
  - @org.springframework.beans.factory.annotation.Autowired(required: false) void setProxyHandler(ProxyHandler proxyHandler)
  - private WritableScriptTemplate templateByPath(java.lang.String path)

Groovy Documentation

[Groovy] Class ResolvableGroovyTemplateEngine

Nested Class Summary

Field Summary

Properties Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Field Detail

private static final WritableScriptTemplate NULL_ENTRY

protected Cache<java.lang.String, WritableScriptTemplate> cachedTemplates

private final groovy.lang.GroovyClassLoader classLoader

protected org.codehaus.groovy.control.CompilerConfiguration compilerConfiguration

private final boolean enableReloading

private final java.lang.String extension

private LinkGenerator linkGenerator

private MappingContext mappingContext

private MessageSource messageSource

private MimeUtility mimeUtility

private ProxyHandler proxyHandler

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

private final boolean shouldCache

private int templateCounter

private TemplateResolver templateResolver

@groovy.lang.Delegate private final ViewConfiguration viewConfiguration

private final ViewUriResolver viewUriResolver

Property Detail

final groovy.lang.GroovyClassLoader classLoader

final boolean enableReloading

final java.lang.String extension

final boolean shouldCache

groovy.text.markup.TemplateResolver templateResolver

@groovy.lang.Delegate final ViewConfiguration viewConfiguration

final ViewUriResolver viewUriResolver

Constructor Detail

ResolvableGroovyTemplateEngine(ViewConfiguration configuration, java.lang.ClassLoader classLoader)

Method Detail

private WritableScriptTemplate attemptResolveClass(java.lang.String path)

private WritableScriptTemplate attemptResolvePath(java.lang.String path)

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)

private WritableScriptTemplate getCachedTemplatesWithDefault(java.lang.String key)

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

abstract 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(LinkGenerator linkGenerator)

@org.springframework.beans.factory.annotation.Autowired(required: false) @org.springframework.beans.factory.annotation.Qualifier(value: grailsDomainClassMappingContext) void setMappingContext(MappingContext mappingContext)

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

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

@org.springframework.beans.factory.annotation.Autowired(required: false) void setProxyHandler(ProxyHandler proxyHandler)

private WritableScriptTemplate templateByPath(java.lang.String path)