Apache Groovy 3.0.20 · groovy.text.markup.BaseTemplate

Modifier and Type	Class and Description
private static class	BaseTemplate.TagData

Modifier and Type	Field and Description
private final Map<String, Template>	cachedFragments
private final TemplateConfiguration	configuration
private boolean	doWriteIndent
private static final Map<K, V>	EMPTY_MODEL
private final MarkupTemplateEngine	engine
private final Map<K, V>	model
private final Map<String, String>	modelTypes
private Writer	out

Access	Constructor and Description
public	BaseTemplate(final MarkupTemplateEngine templateEngine, final Map<K, V> model, final Map<String, String> modelTypes, final TemplateConfiguration configuration)

Method Summary

Modifier and Type	Method and Description
public BaseTemplate	Returns: this template instance. comment(Object the object to be rendered inside an XML comment block. cs) Renders the supplied object using its `Object#toString` method inside a comment markup block (<!-- ...
public Closure<V>	Returns: a wrapped closure returning an empty string contents(final Closure<V> the fragment to be wrapped cl) Wraps a closure so that it can be used as a prototype for inclusion in layouts.
private Writer	createWriter(final Writer out)
private String	escapeQuotes(String str)
private Map<K, V>	forkModel(Map<K, V> m)
public Object	Returns: this template instance fragment(Map<K, V> model to be passed to the template model, String template body templateText) Renders an embedded template as a fragment.
public Map<K, V>	getModel()
public Writer	Returns: the current writer getOut() Convenience method to return the current writer instance.
public void	includeEscaped(String the path to the other file templatePath) Includes contents of another file, not as a template but as escaped text.
public void	includeGroovy(String the path to the included resource. templatePath) Includes another template inside this template.
public void	includeUnescaped(String the path to the other file templatePath) Includes contents of another file, not as a template but as unescaped text.
public Object	Returns: this template instance layout(Map<K, V> model to be passed to the template model, String the name of the template to be used as a layout templateName) Imports a template and renders it using the specified model, allowing fine grained composition of templates and layouting.
public Object	Returns: this template instance layout(Map<K, V> model to be passed to the template model, String the name of the template to be used as a layout templateName, boolean a boolean indicating if we should inherit the parent model inheritModel) Imports a template and renders it using the specified model, allowing fine grained composition of templates and layouting.
public Object	Returns: this template instance methodMissing(String the name of the tag tagName, Object tag generation arguments args) This is the main method responsible for writing a tag and its attributes.
public void	newLine() Adds a new line to the output.
public BaseTemplate	Returns: this template instance pi(Map<?, ?> the attributes to render attrs) Renders processing instructions.
public abstract Object	run()
public String	stringOf(Closure<V> cl)
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.
public Object	Returns: an escaped string, or the object itself tryEscape(Object an object to be escaped for XML contents) Escapes the string representation of the supplied object if it derives from `java.lang.CharSequence`, otherwise returns the object itself.
private void	writeAttribute(String attName, String value)
private void	writeAttributes(final Map<?, ?> attributes)
private void	writeBody(final Object body)
private void	writeIndent()
private void	writeQt()
public Writer	Returns: a writer instance writeTo(final Writer the Writer to which this Writable should output its data. out) Implements groovy.lang.Writable.writeTo. Main method used to render a template.
public BaseTemplate	Returns: this template instance xmlDeclaration() Renders an XML declaration header.
public BaseTemplate	Returns: this template instance yield(Object the object to be rendered obj) Renders the object provided as parameter using its `Object#toString()` method, The contents is rendered after being escaped for XML, enforcing valid XML output.
public BaseTemplate	Returns: this template instance yieldUnescaped(Object the object to be rendered unescaped obj) Renders the object provided as parameter using its `Object#toString()` method, The contents is rendered as is, unescaped.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll wait wait wait

cachedFragments	back to summary
private final Map<String, Template> cachedFragments

configuration	back to summary
private final TemplateConfiguration configuration

doWriteIndent	back to summary
private boolean doWriteIndent

EMPTY_MODEL	back to summary
private static final Map<K, V> EMPTY_MODEL

engine	back to summary
private final MarkupTemplateEngine engine

model	back to summary
private final Map<K, V> model

modelTypes	back to summary
private final Map<String, String> modelTypes

out	back to summary
private Writer out

BaseTemplate	back to summary
public BaseTemplate(final MarkupTemplateEngine templateEngine, final Map<K, V> model, final Map<String, String> modelTypes, final TemplateConfiguration configuration)

Method Detail

comment back to summary

comment	back to summary
public BaseTemplate comment(Object cs) throws IOException Renders the supplied object using its `Object#toString` method inside a comment markup block (<!-- ... -->). The object is rendered as is, unescaped. Parameters cs:Object the object to be rendered inside an XML comment block. Returns:BaseTemplate this template instance.

public BaseTemplate comment(Object cs) throws IOException

Renders the supplied object using its Object#toString method inside a comment markup block (). The object is rendered as is, unescaped.

Parameters

cs:Object: the object to be rendered inside an XML comment block.

Returns:BaseTemplate

this template instance.

contents	back to summary
public Closure<V> contents(final Closure<V> cl) Wraps a closure so that it can be used as a prototype for inclusion in layouts. This is useful when you want to use a closure in a model, but that you don't want to render the result of the closure but instead call it as if it was a specification of a template fragment. Parameters cl:Closure<V> the fragment to be wrapped Returns:Closure<V> a wrapped closure returning an empty string

contents

back to summary

public Closure<V> contents(final Closure<V> cl)

Wraps a closure so that it can be used as a prototype for inclusion in layouts. This is useful when you want to use a closure in a model, but that you don't want to render the result of the closure but instead call it as if it was a specification of a template fragment.

Parameters

cl:Closure<V>: the fragment to be wrapped

Returns:Closure<V>

a wrapped closure returning an empty string

createWriter	back to summary
private Writer createWriter(final Writer out)

escapeQuotes	back to summary
private String escapeQuotes(String str)

forkModel	back to summary
private Map<K, V> forkModel(Map<K, V> m) Annotations @SuppressWarnings:unchecked

fragment back to summary

fragment	back to summary
public Object fragment(Map<K, V> model, String templateText) throws IOException, ClassNotFoundException Renders an embedded template as a fragment. Fragments are cached in a template, meaning that if you use the same fragment in a template, it will only be compiled once, but once per template instance. This is less performant than using `layout(java.util.Map, String)`. Parameters model:Map<K, V> model to be passed to the template templateText:String template body Returns:Object this template instance

public Object fragment(Map<K, V> model, String templateText) throws IOException, ClassNotFoundException

Renders an embedded template as a fragment. Fragments are cached in a template, meaning that if you use the same fragment in a template, it will only be compiled once, but once per template instance. This is less performant than using layout(java.util.Map, String).

Parameters

model:Map<K, V>: model to be passed to the template
templateText:String: template body

Returns:Object

this template instance

getModel	back to summary
public Map<K, V> getModel()

getOut	back to summary
public Writer getOut() Convenience method to return the current writer instance. Returns:Writer the current writer

getOut

back to summary

public Writer getOut()

Convenience method to return the current writer instance.

Returns:Writer: the current writer

includeEscaped	back to summary
public void includeEscaped(String templatePath) throws IOException Includes contents of another file, not as a template but as escaped text. Parameters templatePath:String the path to the other file

includeEscaped

back to summary

public void includeEscaped(String templatePath) throws IOException

Includes contents of another file, not as a template but as escaped text.

Parameters

templatePath:String: the path to the other file

includeGroovy	back to summary
public void includeGroovy(String templatePath) throws IOException, ClassNotFoundException Includes another template inside this template. Parameters templatePath:String the path to the included resource.

includeGroovy

back to summary

public void includeGroovy(String templatePath) throws IOException, ClassNotFoundException

Includes another template inside this template.

Parameters

templatePath:String: the path to the included resource.

includeUnescaped	back to summary
public void includeUnescaped(String templatePath) throws IOException Includes contents of another file, not as a template but as unescaped text. Parameters templatePath:String the path to the other file

includeUnescaped

back to summary

public void includeUnescaped(String templatePath) throws IOException

Includes contents of another file, not as a template but as unescaped text.

Parameters

templatePath:String: the path to the other file

layout back to summary

layout	back to summary
public Object layout(Map<K, V> model, String templateName) throws IOException, ClassNotFoundException Imports a template and renders it using the specified model, allowing fine grained composition of templates and layouting. This works similarily to a template include but allows a distinct model to be used. This version doesn't inherit the model from the parent. If you need model inheritance, see `layout(java.util.Map, String, boolean)`. Parameters model:Map<K, V> model to be passed to the template templateName:String the name of the template to be used as a layout Returns:Object this template instance

public Object layout(Map<K, V> model, String templateName) throws IOException, ClassNotFoundException

Imports a template and renders it using the specified model, allowing fine grained composition of templates and layouting. This works similarily to a template include but allows a distinct model to be used. This version doesn't inherit the model from the parent. If you need model inheritance, see layout(java.util.Map, String, boolean).

Parameters

model:Map<K, V>: model to be passed to the template
templateName:String: the name of the template to be used as a layout

Returns:Object

this template instance

layout	back to summary
public Object layout(Map<K, V> model, String templateName, boolean inheritModel) throws IOException, ClassNotFoundException Imports a template and renders it using the specified model, allowing fine grained composition of templates and layouting. This works similarily to a template include but allows a distinct model to be used. If the layout inherits from the parent model, a new model is created, with the values from the parent model, eventually overridden with those provided specifically for this layout. Parameters model:Map<K, V> model to be passed to the template templateName:String the name of the template to be used as a layout inheritModel:boolean a boolean indicating if we should inherit the parent model Returns:Object this template instance

layout

back to summary

public Object layout(Map<K, V> model, String templateName, boolean inheritModel) throws IOException, ClassNotFoundException

Imports a template and renders it using the specified model, allowing fine grained composition of templates and layouting. This works similarily to a template include but allows a distinct model to be used. If the layout inherits from the parent model, a new model is created, with the values from the parent model, eventually overridden with those provided specifically for this layout.

Parameters

model:Map<K, V>: model to be passed to the template
templateName:String: the name of the template to be used as a layout
inheritModel:boolean: a boolean indicating if we should inherit the parent model

Returns:Object

this template instance

methodMissing	back to summary
public Object methodMissing(String tagName, Object args) throws IOException This is the main method responsible for writing a tag and its attributes. The arguments may be: a closure in which case the closure is rendered inside the tag body a string , in which case the string is rendered as the tag body a map of attributes in which case the attributes are rendered inside the opening tag or a combination of (attributes,string), (attributes,closure) Parameters tagName:String the name of the tag args:Object tag generation arguments Returns:Object this template instance

methodMissing

back to summary

public Object methodMissing(String tagName, Object args) throws IOException

This is the main method responsible for writing a tag and its attributes. The arguments may be:

a closure
a string
a map of attributes

or a combination of (attributes,string), (attributes,closure)

Parameters

tagName:String: the name of the tag
args:Object: tag generation arguments

Returns:Object

this template instance

newLine	back to summary
public void newLine() throws IOException Adds a new line to the output. The new line string can be configured by `groovy.text.markup.TemplateConfiguration#setNewLineString(String)`

pi back to summary

pi	back to summary
public BaseTemplate pi(Map<?, ?> attrs) throws IOException Renders processing instructions. The supplied map contains all elements to be rendered as processing instructions. The key is the name of the element, the value is either a map of attributes, or an object to be rendered directly. For example: `pi("xml-stylesheet":[href:"mystyle.css", type:"text/css"])` will be rendered as: <?xml-stylesheet href='mystyle.css' type='text/css'?> Parameters attrs:Map<?, ?> the attributes to render Returns:BaseTemplate this template instance

public BaseTemplate pi(Map<?, ?> attrs) throws IOException

Renders processing instructions. The supplied map contains all elements to be rendered as processing instructions. The key is the name of the element, the value is either a map of attributes, or an object to be rendered directly. For example:


    pi("xml-stylesheet":[href:"mystyle.css", type:"text/css"])

will be rendered as:

    <?xml-stylesheet href='mystyle.css' type='text/css'?>

Parameters

attrs:Map<?, ?>: the attributes to render

Returns:BaseTemplate

this template instance

run	back to summary
public abstract Object run()

stringOf	back to summary
public String stringOf(Closure<V> cl) throws IOException

toString back to summary

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Doc from java.lang.Object.toString. Returns a string representation of the object. Satisfying this method's contract implies a non-`null` result must be returned. Returns:String a string representation of the object

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Returns:String: a string representation of the object

tryEscape back to summary

tryEscape	back to summary
public Object tryEscape(Object contents) Escapes the string representation of the supplied object if it derives from `java.lang.CharSequence`, otherwise returns the object itself. Parameters contents:Object an object to be escaped for XML Returns:Object an escaped string, or the object itself

public Object tryEscape(Object contents)

Escapes the string representation of the supplied object if it derives from java.lang.CharSequence, otherwise returns the object itself.

Parameters

contents:Object: an object to be escaped for XML

Returns:Object

an escaped string, or the object itself

writeAttribute	back to summary
private void writeAttribute(String attName, String value) throws IOException

writeAttributes	back to summary
private void writeAttributes(final Map<?, ?> attributes) throws IOException

writeBody	back to summary
private void writeBody(final Object body) throws IOException

writeIndent	back to summary
private void writeIndent() throws IOException

writeQt	back to summary
private void writeQt() throws IOException

writeTo	back to summary
public Writer writeTo(final Writer out) throws IOException Implements groovy.lang.Writable.writeTo. Main method used to render a template. Parameters out:Writer the Writer to which this Writable should output its data. Returns:Writer a writer instance Exceptions IOException: Doc from groovy.lang.Writable.writeTo. if an error occurred while outputting data to the writer

writeTo

back to summary

public Writer writeTo(final Writer out) throws IOException

Implements groovy.lang.Writable.writeTo.

Main method used to render a template.

Parameters

out:Writer: the Writer to which this Writable should output its data.

Returns:Writer

a writer instance

Exceptions

IOException:

Doc from groovy.lang.Writable.writeTo.

if an error occurred while outputting data to the writer

xmlDeclaration back to summary

xmlDeclaration	back to summary
public BaseTemplate xmlDeclaration() throws IOException Renders an XML declaration header. If the declaration encoding is set in the `template configuration`, then the encoding is rendered into the declaration. Returns:BaseTemplate this template instance

public BaseTemplate xmlDeclaration() throws IOException

Renders an XML declaration header. If the declaration encoding is set in the template configuration, then the encoding is rendered into the declaration.

Returns:BaseTemplate: this template instance

yield back to summary

yield	back to summary
public BaseTemplate yield(Object obj) throws IOException Renders the object provided as parameter using its `Object#toString()` method, The contents is rendered after being escaped for XML, enforcing valid XML output. Parameters obj:Object the object to be rendered Returns:BaseTemplate this template instance

public BaseTemplate yield(Object obj) throws IOException

Renders the object provided as parameter using its Object#toString() method, The contents is rendered after being escaped for XML, enforcing valid XML output.

Parameters

obj:Object: the object to be rendered

Returns:BaseTemplate

this template instance

yieldUnescaped back to summary

yieldUnescaped	back to summary
public BaseTemplate yieldUnescaped(Object obj) throws IOException Renders the object provided as parameter using its `Object#toString()` method, The contents is rendered as is, unescaped. This means that depending on what the `Object#toString()` method call returns, you might create invalid markup. Parameters obj:Object the object to be rendered unescaped Returns:BaseTemplate this template instance

public BaseTemplate yieldUnescaped(Object obj) throws IOException

Renders the object provided as parameter using its Object#toString() method, The contents is rendered as is, unescaped. This means that depending on what the Object#toString() method call returns, you might create invalid markup.

Parameters

obj:Object: the object to be rendered unescaped

Returns:BaseTemplate

this template instance

public abstract Class BaseTemplate

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Class BaseTemplate.TagData

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

Modifier and Type	Field and Description
private final Object[]	array
private Map<K, V>	attributes
private Object	body

Modifier and Type	Method and Description
public Map<K, V>	getAttributes()
public Object	getBody()
public BaseTemplate.TagData	invoke()