MarkupTemplateEngine (groovy 2.4.4 API)

groovy.text.markup.MarkupTemplateEngine

Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Nested Class Summary

Nested classes
Modifiers	Name	Description
`static class`	`MarkupTemplateEngine.CachingTemplateResolver`	A template resolver which avoids calling ClassLoader.getResource if a template path already has been queried before.
`static class`	`MarkupTemplateEngine.DefaultTemplateResolver`
`static class`	`MarkupTemplateEngine.TemplateResource`

Constructor Summary

Constructors
Constructor and description
`MarkupTemplateEngine ()`
`MarkupTemplateEngine (TemplateConfiguration tplConfig)`
`MarkupTemplateEngine (ClassLoader parentLoader, TemplateConfiguration tplConfig)`
`MarkupTemplateEngine (ClassLoader parentLoader, TemplateConfiguration tplConfig, TemplateResolver resolver)`
`MarkupTemplateEngine (ClassLoader parentLoader, File templateDirectory, TemplateConfiguration tplConfig)` Convenience constructor to build a template engine which searches for templates into a directory

Methods Summary

Methods
Type	Name and description
`Template`	`createTemplate(Reader reader)`
`Template`	`createTemplate(Reader reader, String sourceName)`
`Template`	`createTemplate(URL resource)`
`Template`	`createTemplateByPath(String templatePath)`
`Template`	`createTypeCheckedModelTemplate(String source, Map<String, String> modelTypes)`
`Template`	`createTypeCheckedModelTemplate(String source, String sourceName, Map<String, String> modelTypes)`
`Template`	`createTypeCheckedModelTemplate(Reader reader, Map<String, String> modelTypes)`
`Template`	`createTypeCheckedModelTemplate(Reader reader, String sourceName, Map<String, String> modelTypes)`
`Template`	`createTypeCheckedModelTemplate(URL resource, Map<String, String> modelTypes)`
`Template`	`createTypeCheckedModelTemplateByPath(String templatePath, Map<String, String> modelTypes)`
`CompilerConfiguration`	`getCompilerConfiguration()`
`TemplateConfiguration`	`getTemplateConfiguration()`
`GroovyClassLoader`	`getTemplateLoader()`
`URL`	`resolveTemplate(String templatePath)`

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class TemplateEngine`	`createTemplate, createTemplate, createTemplate, createTemplate`
`class Object`	`wait, wait, wait, equals, toString, hashCode, getClass, notify, notifyAll`

- Constructor Detail
  - public MarkupTemplateEngine()
  - public MarkupTemplateEngine(TemplateConfiguration tplConfig)
  - public MarkupTemplateEngine(ClassLoader parentLoader, TemplateConfiguration tplConfig)
  - public MarkupTemplateEngine(ClassLoader parentLoader, TemplateConfiguration tplConfig, TemplateResolver resolver)
  - public MarkupTemplateEngine(ClassLoader parentLoader, File templateDirectory, TemplateConfiguration tplConfig)
    
    Convenience constructor to build a template engine which searches for templates into a directory
    Parameters:
    templateDirectory - directory where to find templates
    tplConfig - template engine configuration
- Method Detail
  - public Template createTemplate(Reader reader)
  - public Template createTemplate(Reader reader, String sourceName)
  - @Override public Template createTemplate(URL resource)
  - public Template createTemplateByPath(String templatePath)
  - public Template createTypeCheckedModelTemplate(String source, Map<String, String> modelTypes)
  - public Template createTypeCheckedModelTemplate(String source, String sourceName, Map<String, String> modelTypes)
  - public Template createTypeCheckedModelTemplate(Reader reader, Map<String, String> modelTypes)
  - public Template createTypeCheckedModelTemplate(Reader reader, String sourceName, Map<String, String> modelTypes)
  - public Template createTypeCheckedModelTemplate(URL resource, Map<String, String> modelTypes)
  - public Template createTypeCheckedModelTemplateByPath(String templatePath, Map<String, String> modelTypes)
  - public CompilerConfiguration getCompilerConfiguration()
  - public TemplateConfiguration getTemplateConfiguration()
  - public GroovyClassLoader getTemplateLoader()
  - public URL resolveTemplate(String templatePath)

Summary:
Nested
Constructor
Method

| Detail:
Constructor
Method

[Java] Class MarkupTemplateEngine

Nested Class Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Constructor Detail

public MarkupTemplateEngine()

public MarkupTemplateEngine(TemplateConfiguration tplConfig)

public MarkupTemplateEngine(ClassLoader parentLoader, TemplateConfiguration tplConfig)

public MarkupTemplateEngine(ClassLoader parentLoader, TemplateConfiguration tplConfig, TemplateResolver resolver)

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

Method Detail

public Template createTemplate(Reader reader)

public Template createTemplate(Reader reader, String sourceName)

@Override public Template createTemplate(URL resource)

public Template createTemplateByPath(String templatePath)

public Template createTypeCheckedModelTemplate(String source, Map<String, String> modelTypes)

public Template createTypeCheckedModelTemplate(String source, String sourceName, Map<String, String> modelTypes)

public Template createTypeCheckedModelTemplate(Reader reader, Map<String, String> modelTypes)

public Template createTypeCheckedModelTemplate(Reader reader, String sourceName, Map<String, String> modelTypes)

public Template createTypeCheckedModelTemplate(URL resource, Map<String, String> modelTypes)

public Template createTypeCheckedModelTemplateByPath(String templatePath, Map<String, String> modelTypes)

public CompilerConfiguration getCompilerConfiguration()

public TemplateConfiguration getTemplateConfiguration()

public GroovyClassLoader getTemplateLoader()

public URL resolveTemplate(String templatePath)