Index
All Classes|All Packages
A
- append(char) - Method in class groovy.text.markup.DelegatingIndentWriter
- append(CharSequence) - Method in class groovy.text.markup.DelegatingIndentWriter
- append(CharSequence, int, int) - Method in class groovy.text.markup.DelegatingIndentWriter
B
- BaseTemplate - Class in groovy.text.markup
-
All templates compiled through
MarkupTemplateEngine
extend this abstract class, which provides a number of utility methods to generate markup. - BaseTemplate(MarkupTemplateEngine, Map, Map<String, String>, TemplateConfiguration) - Constructor for class groovy.text.markup.BaseTemplate
C
- cache - Variable in class groovy.text.markup.MarkupTemplateEngine.CachingTemplateResolver
- CachingTemplateResolver() - Constructor for class groovy.text.markup.MarkupTemplateEngine.CachingTemplateResolver
-
Creates a new caching template resolver using a concurrent hash map as the backing cache.
- CachingTemplateResolver(Map<String, URL>) - Constructor for class groovy.text.markup.MarkupTemplateEngine.CachingTemplateResolver
-
Creates a new caching template resolver.
- close() - Method in class groovy.text.markup.DelegatingIndentWriter
- comment(Object) - Method in class groovy.text.markup.BaseTemplate
-
Renders the supplied object using its
Object.toString()
method inside a comment markup block (<!-- ... - configure(ClassLoader, TemplateConfiguration) - Method in class groovy.text.markup.MarkupTemplateEngine.CachingTemplateResolver
- configure(ClassLoader, TemplateConfiguration) - Method in class groovy.text.markup.MarkupTemplateEngine.DefaultTemplateResolver
- configure(ClassLoader, TemplateConfiguration) - Method in interface groovy.text.markup.TemplateResolver
-
This method is called once the template engine is initialized, providing the resolver with the template engine configuration and its template class loader.
- contents(Closure) - Method in class groovy.text.markup.BaseTemplate
-
Wraps a closure so that it can be used as a prototype for inclusion in layouts.
- createTemplate(File) - Method in class groovy.text.TemplateEngine
-
Creates a template from the File contents.
- createTemplate(File, Charset) - Method in class groovy.text.TemplateEngine
-
Creates a template from the File contents using the given charset encoding.
- createTemplate(Reader) - Method in class groovy.text.GStringTemplateEngine
- createTemplate(Reader) - Method in class groovy.text.markup.MarkupTemplateEngine
- createTemplate(Reader) - Method in class groovy.text.SimpleTemplateEngine
- createTemplate(Reader) - Method in class groovy.text.StreamingTemplateEngine
-
Creates a template instance using the template source from the provided Reader.
- createTemplate(Reader) - Method in class groovy.text.TemplateEngine
-
Creates a template by reading content from the Reader.
- createTemplate(Reader) - Method in class groovy.text.XmlTemplateEngine
- createTemplate(Reader, String) - Method in class groovy.text.markup.MarkupTemplateEngine
- createTemplate(String) - Method in class groovy.text.TemplateEngine
-
Creates a template from the String contents.
- createTemplate(URL) - Method in class groovy.text.markup.MarkupTemplateEngine
- createTemplate(URL) - Method in class groovy.text.TemplateEngine
-
Creates a template from the content found at the URL using the default encoding.
- createTemplate(URL, Charset) - Method in class groovy.text.TemplateEngine
-
Creates a template from the content found at the URL using the given charset encoding.
- createTemplateByPath(String) - Method in class groovy.text.markup.MarkupTemplateEngine
- createTypeCheckedModelTemplate(Reader, String, Map<String, String>) - Method in class groovy.text.markup.MarkupTemplateEngine
- createTypeCheckedModelTemplate(Reader, Map<String, String>) - Method in class groovy.text.markup.MarkupTemplateEngine
- createTypeCheckedModelTemplate(String, String, Map<String, String>) - Method in class groovy.text.markup.MarkupTemplateEngine
- createTypeCheckedModelTemplate(String, Map<String, String>) - Method in class groovy.text.markup.MarkupTemplateEngine
- createTypeCheckedModelTemplate(URL, Map<String, String>) - Method in class groovy.text.markup.MarkupTemplateEngine
- createTypeCheckedModelTemplateByPath(String, Map<String, String>) - Method in class groovy.text.markup.MarkupTemplateEngine
D
- DEFAULT_INDENTATION - Static variable in class groovy.text.XmlTemplateEngine
- DefaultTemplateResolver() - Constructor for class groovy.text.markup.MarkupTemplateEngine.DefaultTemplateResolver
- DelegatingIndentWriter - Class in groovy.text.markup
-
A writer which delegates to another writer and supports an additional indenting level.
- DelegatingIndentWriter(Writer) - Constructor for class groovy.text.markup.DelegatingIndentWriter
- DelegatingIndentWriter(Writer, String) - Constructor for class groovy.text.markup.DelegatingIndentWriter
F
- flush() - Method in class groovy.text.markup.DelegatingIndentWriter
- fragment(Map, String) - Method in class groovy.text.markup.BaseTemplate
-
Renders an embedded template as a fragment.
G
- getAutoIndentString() - Method in class groovy.text.markup.TemplateConfiguration
- getBaseTemplateClass() - Method in class groovy.text.markup.TemplateConfiguration
- getColumn() - Method in exception groovy.text.TemplateParseException
- getCompilerConfiguration() - Method in class groovy.text.markup.MarkupTemplateEngine
- getDeclarationEncoding() - Method in class groovy.text.markup.TemplateConfiguration
- getIndentation() - Method in class groovy.text.XmlTemplateEngine
- getLineNumber() - Method in exception groovy.text.TemplateExecutionException
-
Returns the line number in the template source where the error occurred
- getLineNumber() - Method in exception groovy.text.TemplateParseException
- getLocale() - Method in class groovy.text.markup.TemplateConfiguration
- getModel() - Method in class groovy.text.markup.BaseTemplate
- getNewLineString() - Method in class groovy.text.markup.TemplateConfiguration
- getOut() - Method in class groovy.text.markup.BaseTemplate
-
Convenience method to return the current writer instance.
- getTemplateConfiguration() - Method in class groovy.text.markup.MarkupTemplateEngine
- getTemplateLoader() - Method in class groovy.text.markup.MarkupTemplateEngine
- groovy.text - package groovy.text
- groovy.text.markup - package groovy.text.markup
- GStringTemplateEngine - Class in groovy.text
-
Processes template source files substituting variables and expressions into placeholders in a template source text to produce the desired output using a streaming approach.
- GStringTemplateEngine() - Constructor for class groovy.text.GStringTemplateEngine
- GStringTemplateEngine(ClassLoader) - Constructor for class groovy.text.GStringTemplateEngine
H
- hasLocale() - Method in class groovy.text.markup.MarkupTemplateEngine.TemplateResource
I
- includeEscaped(String) - Method in class groovy.text.markup.BaseTemplate
-
Includes contents of another file, not as a template but as escaped text.
- includeGroovy(String) - Method in class groovy.text.markup.BaseTemplate
-
Includes another template inside this template.
- includeUnescaped(String) - Method in class groovy.text.markup.BaseTemplate
-
Includes contents of another file, not as a template but as unescaped text.
- isAutoEscape() - Method in class groovy.text.markup.TemplateConfiguration
- isAutoIndent() - Method in class groovy.text.markup.TemplateConfiguration
- isAutoNewLine() - Method in class groovy.text.markup.TemplateConfiguration
- isCacheTemplates() - Method in class groovy.text.markup.TemplateConfiguration
- isEscapeBackslash() - Method in class groovy.text.SimpleTemplateEngine
- isExpandEmptyElements() - Method in class groovy.text.markup.TemplateConfiguration
- isUseDoubleQuotes() - Method in class groovy.text.markup.TemplateConfiguration
- isVerbose() - Method in class groovy.text.SimpleTemplateEngine
L
- layout(Map, String) - Method in class groovy.text.markup.BaseTemplate
-
Imports a template and renders it using the specified model, allowing fine grained composition of templates and layouting.
- layout(Map, String, boolean) - Method in class groovy.text.markup.BaseTemplate
-
Imports a template and renders it using the specified model, allowing fine grained composition of templates and layouting.
M
- make() - Method in interface groovy.text.Template
- make(Map) - Method in interface groovy.text.Template
- MarkupTemplateEngine - Class in groovy.text.markup
-
A template engine which leverages
StreamingMarkupBuilder
to generate XML/XHTML. - MarkupTemplateEngine() - Constructor for class groovy.text.markup.MarkupTemplateEngine
- MarkupTemplateEngine(TemplateConfiguration) - Constructor for class groovy.text.markup.MarkupTemplateEngine
- MarkupTemplateEngine(ClassLoader, TemplateConfiguration) - Constructor for class groovy.text.markup.MarkupTemplateEngine
- MarkupTemplateEngine(ClassLoader, TemplateConfiguration, TemplateResolver) - Constructor for class groovy.text.markup.MarkupTemplateEngine
- MarkupTemplateEngine(ClassLoader, File, TemplateConfiguration) - Constructor for class groovy.text.markup.MarkupTemplateEngine
-
Convenience constructor to build a template engine which searches for templates into a directory
- MarkupTemplateEngine.CachingTemplateResolver - Class in groovy.text.markup
-
A template resolver which avoids calling
ClassLoader.getResource(String)
if a template path already has been queried before. - MarkupTemplateEngine.DefaultTemplateResolver - Class in groovy.text.markup
- MarkupTemplateEngine.TemplateResource - Class in groovy.text.markup
- methodMissing(String, Object) - Method in class groovy.text.markup.BaseTemplate
-
This is the main method responsible for writing a tag and its attributes.
N
- newLine() - Method in class groovy.text.markup.BaseTemplate
-
Adds a new line to the output.
- next() - Method in class groovy.text.markup.DelegatingIndentWriter
P
- parse(String) - Static method in class groovy.text.markup.MarkupTemplateEngine.TemplateResource
- pi(Map<?, ?>) - Method in class groovy.text.markup.BaseTemplate
-
Renders processing instructions.
- previous() - Method in class groovy.text.markup.DelegatingIndentWriter
R
- resolveTemplate(String) - Method in class groovy.text.markup.MarkupTemplateEngine.CachingTemplateResolver
- resolveTemplate(String) - Method in class groovy.text.markup.MarkupTemplateEngine.DefaultTemplateResolver
- resolveTemplate(String) - Method in class groovy.text.markup.MarkupTemplateEngine
- resolveTemplate(String) - Method in interface groovy.text.markup.TemplateResolver
-
Resolvers must implement this method in order to resolve a template, given a template path.
- run() - Method in class groovy.text.markup.BaseTemplate
S
- setAutoEscape(boolean) - Method in class groovy.text.markup.TemplateConfiguration
-
Set to true if you want variables in the model which are assignable to
CharSequence
to be escaped automatically in templates. - setAutoIndent(boolean) - Method in class groovy.text.markup.TemplateConfiguration
-
Set this to true if you want the template engine to render indents automatically.
- setAutoIndentString(String) - Method in class groovy.text.markup.TemplateConfiguration
- setAutoNewLine(boolean) - Method in class groovy.text.markup.TemplateConfiguration
- setBaseTemplateClass(Class<? extends BaseTemplate>) - Method in class groovy.text.markup.TemplateConfiguration
-
Set the template base class.
- setCacheTemplates(boolean) - Method in class groovy.text.markup.TemplateConfiguration
-
If cache is enabled, then templates are compiled once for each source (URL or File).
- setConfigurePrinter(Closure) - Method in class groovy.text.XmlTemplateEngine
-
Closure that can be used to configure the printer.
- setDeclarationEncoding(String) - Method in class groovy.text.markup.TemplateConfiguration
-
Set the encoding used to write the declaration header.
- setEscapeBackslash(boolean) - Method in class groovy.text.SimpleTemplateEngine
- setExpandEmptyElements(boolean) - Method in class groovy.text.markup.TemplateConfiguration
- setIndentation(String) - Method in class groovy.text.XmlTemplateEngine
- setLocale(Locale) - Method in class groovy.text.markup.TemplateConfiguration
- setNewLineString(String) - Method in class groovy.text.markup.TemplateConfiguration
- setUseDoubleQuotes(boolean) - Method in class groovy.text.markup.TemplateConfiguration
- setVerbose(boolean) - Method in class groovy.text.SimpleTemplateEngine
- SimpleTemplateEngine - Class in groovy.text
-
Processes template source files substituting variables and expressions into placeholders in a template source text to produce the desired output.
- SimpleTemplateEngine() - Constructor for class groovy.text.SimpleTemplateEngine
- SimpleTemplateEngine(boolean) - Constructor for class groovy.text.SimpleTemplateEngine
- SimpleTemplateEngine(GroovyShell) - Constructor for class groovy.text.SimpleTemplateEngine
- SimpleTemplateEngine(ClassLoader) - Constructor for class groovy.text.SimpleTemplateEngine
- SPACES - Static variable in class groovy.text.markup.DelegatingIndentWriter
- StreamingTemplateEngine - Class in groovy.text
-
Processes template source files substituting variables and expressions into placeholders in a template source text to produce the desired output using a closure based approach.
- StreamingTemplateEngine() - Constructor for class groovy.text.StreamingTemplateEngine
-
Create a streaming template engine instance using the default class loader
- StreamingTemplateEngine(ClassLoader) - Constructor for class groovy.text.StreamingTemplateEngine
-
Create a streaming template engine instance using a custom class loader
- stringOf(Closure) - Method in class groovy.text.markup.BaseTemplate
T
- TAB - Static variable in class groovy.text.markup.DelegatingIndentWriter
- Template - Interface in groovy.text
-
A template is a block of text with an associated binding that can be output to a writer or evaluated to a string.
- TemplateConfiguration - Class in groovy.text.markup
-
Configuration options for the
markup template engine
. - TemplateConfiguration() - Constructor for class groovy.text.markup.TemplateConfiguration
- TemplateConfiguration(TemplateConfiguration) - Constructor for class groovy.text.markup.TemplateConfiguration
- TemplateEngine - Class in groovy.text
-
A template engine is a factory for creating a Template instance for a given text input.
- TemplateEngine() - Constructor for class groovy.text.TemplateEngine
- TemplateExecutionException - Exception in groovy.text
-
A custom exception class to flag template execution errors
- TemplateExecutionException(int) - Constructor for exception groovy.text.TemplateExecutionException
- TemplateExecutionException(int, String) - Constructor for exception groovy.text.TemplateExecutionException
- TemplateExecutionException(int, String, Throwable) - Constructor for exception groovy.text.TemplateExecutionException
- TemplateExecutionException(int, Throwable) - Constructor for exception groovy.text.TemplateExecutionException
- TemplateParseException - Exception in groovy.text
-
A custom exception class to flag template parsing errors
- TemplateParseException(int, int) - Constructor for exception groovy.text.TemplateParseException
- TemplateParseException(String, int, int) - Constructor for exception groovy.text.TemplateParseException
- TemplateParseException(String, Throwable, int, int) - Constructor for exception groovy.text.TemplateParseException
- TemplateParseException(Throwable, int, int) - Constructor for exception groovy.text.TemplateParseException
- TemplateResolver - Interface in groovy.text.markup
-
Interface for template resolvers, which, given a template identifier, return an URL where the template can be loaded.
- toString() - Method in class groovy.text.markup.BaseTemplate
- toString() - Method in class groovy.text.markup.MarkupTemplateEngine.TemplateResource
- toString() - Method in class groovy.text.XmlTemplateEngine
- tryEscape(Object) - Method in class groovy.text.markup.BaseTemplate
-
Escapes the string representation of the supplied object if it derives from
CharSequence
, otherwise returns the object itself.
U
- useCache - Variable in class groovy.text.markup.MarkupTemplateEngine.CachingTemplateResolver
W
- withLocale(String) - Method in class groovy.text.markup.MarkupTemplateEngine.TemplateResource
- write(char[]) - Method in class groovy.text.markup.DelegatingIndentWriter
- write(char[], int, int) - Method in class groovy.text.markup.DelegatingIndentWriter
- write(int) - Method in class groovy.text.markup.DelegatingIndentWriter
- write(String) - Method in class groovy.text.markup.DelegatingIndentWriter
- write(String, int, int) - Method in class groovy.text.markup.DelegatingIndentWriter
- writeIndent() - Method in class groovy.text.markup.DelegatingIndentWriter
- writeTo(Writer) - Method in class groovy.text.markup.BaseTemplate
-
Main method used to render a template.
X
- xmlDeclaration() - Method in class groovy.text.markup.BaseTemplate
-
Renders an XML declaration header.
- XmlTemplateEngine - Class in groovy.text
-
Template engine for use in templating scenarios where both the template source and the expected output are intended to be XML.
- XmlTemplateEngine() - Constructor for class groovy.text.XmlTemplateEngine
- XmlTemplateEngine(XmlParser, GroovyShell) - Constructor for class groovy.text.XmlTemplateEngine
- XmlTemplateEngine(XmlParser, ClassLoader) - Constructor for class groovy.text.XmlTemplateEngine
- XmlTemplateEngine(String, boolean) - Constructor for class groovy.text.XmlTemplateEngine
Y
- yield(Object) - Method in class groovy.text.markup.BaseTemplate
-
Renders the object provided as parameter using its
Object.toString()
method, The contents is rendered after being escaped for XML, enforcing valid XML output. - yieldUnescaped(Object) - Method in class groovy.text.markup.BaseTemplate
-
Renders the object provided as parameter using its
Object.toString()
method, The contents is rendered as is, unescaped.
All Classes|All Packages