Apache Groovy 3.0.20 · groovy.text.markup.TemplateConfiguration

Modifier and Type	Field and Description
private boolean	autoEscape
private boolean	autoIndent
private String	autoIndentString
private boolean	autoNewLine
private Class<? extends BaseTemplate>	baseTemplateClass
private boolean	cacheTemplates
private String	declarationEncoding
private boolean	expandEmptyElements
private Locale	locale
private String	newLineString
private boolean	useDoubleQuotes

Access	Constructor and Description
public	TemplateConfiguration()
public	TemplateConfiguration(TemplateConfiguration that)

Method Summary

Modifier and Type	Method and Description
public String	getAutoIndentString()
public Class<? extends BaseTemplate>	getBaseTemplateClass()
public String	Returns: the encoding used in the declaration header getDeclarationEncoding()
public Locale	getLocale()
public String	getNewLineString()
public boolean	Returns: true if variables in the model which are assignable to `java.lang.CharSequence` should be automatically escaped. isAutoEscape()
public boolean	Returns: true if the template engine should handle indents automatically isAutoIndent()
public boolean	isAutoNewLine()
public boolean	isCacheTemplates()
public boolean	Returns: whether elements without body should be written in the short form (ex: <br/>) or in an expanded form (ex: <br></br>) isExpandEmptyElements()
public boolean	Returns: true if attributes should use double quotes instead of single quotes isUseDoubleQuotes()
public void	setAutoEscape(final boolean value if the autoEscape flag autoEscape) Set to true if you want variables in the model which are assignable to `java.lang.CharSequence` to be escaped automatically in templates.
public void	setAutoIndent(final boolean the auto-indent flag autoIndent) Set this to true if you want the template engine to render indents automatically.
public void	setAutoIndentString(final String autoIndentString)
public void	setAutoNewLine(final boolean autoNewLine)
public void	setBaseTemplateClass(final Class<? extends BaseTemplate> a class extending `groovy.text.markup.BaseTemplate` baseTemplateClass) Set the template base class.
public void	setCacheTemplates(final boolean should templates be cached cacheTemplates) If cache is enabled, then templates are compiled once for each source (URL or File).
public void	setDeclarationEncoding(final String encoding to be used in the declaration string declarationEncoding) Set the encoding used to write the declaration header.
public void	setExpandEmptyElements(final boolean expandEmptyElements)
public void	setLocale(final Locale locale)
public void	setNewLineString(final String newLineString)
public void	setUseDoubleQuotes(final boolean useDoubleQuotes)

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

autoEscape	back to summary
private boolean autoEscape

autoIndent	back to summary
private boolean autoIndent

autoIndentString	back to summary
private String autoIndentString

autoNewLine	back to summary
private boolean autoNewLine

baseTemplateClass	back to summary
private Class<? extends BaseTemplate> baseTemplateClass

cacheTemplates	back to summary
private boolean cacheTemplates

declarationEncoding	back to summary
private String declarationEncoding

expandEmptyElements	back to summary
private boolean expandEmptyElements

locale	back to summary
private Locale locale

newLineString	back to summary
private String newLineString

useDoubleQuotes	back to summary
private boolean useDoubleQuotes

TemplateConfiguration	back to summary
public TemplateConfiguration()

TemplateConfiguration	back to summary
public TemplateConfiguration(TemplateConfiguration that)

Method Detail

getAutoIndentString	back to summary
public String getAutoIndentString()

getBaseTemplateClass	back to summary
public Class<? extends BaseTemplate> getBaseTemplateClass()

getDeclarationEncoding	back to summary
public String getDeclarationEncoding() Returns:String the encoding used in the declaration header

getLocale	back to summary
public Locale getLocale()

getNewLineString	back to summary
public String getNewLineString()

isAutoEscape	back to summary
public boolean isAutoEscape() Returns:boolean true if variables in the model which are assignable to `java.lang.CharSequence` should be automatically escaped.

isAutoIndent	back to summary
public boolean isAutoIndent() Returns:boolean true if the template engine should handle indents automatically

isAutoNewLine	back to summary
public boolean isAutoNewLine()

isCacheTemplates	back to summary
public boolean isCacheTemplates()

isExpandEmptyElements	back to summary
public boolean isExpandEmptyElements() Returns:boolean whether elements without body should be written in the short form (ex: <br/>) or in an expanded form (ex: <br></br>)

isUseDoubleQuotes	back to summary
public boolean isUseDoubleQuotes() Returns:boolean true if attributes should use double quotes instead of single quotes

setAutoEscape back to summary

setAutoEscape	back to summary
public void setAutoEscape(final boolean autoEscape) Set to true if you want variables in the model which are assignable to `java.lang.CharSequence` to be escaped automatically in templates. If this flag is set to true and that you want a value not to be automatically escaped, then you need to use ${unescaped.variable} instead of $variable Parameters autoEscape:boolean value if the autoEscape flag

public void setAutoEscape(final boolean autoEscape)

Set to true if you want variables in the model which are assignable to java.lang.CharSequence to be escaped automatically in templates. If this flag is set to true and that you want a value not to be automatically escaped, then you need to use ${unescaped.variable} instead of $variable

Parameters

autoEscape:boolean: value if the autoEscape flag

setAutoIndent back to summary

setAutoIndent	back to summary
public void setAutoIndent(final boolean autoIndent) Set this to true if you want the template engine to render indents automatically. In that case, the supplied writer is wrapped into a `groovy.text.markup.DelegatingIndentWriter` and indents are inserted after each call to newLine. Parameters autoIndent:boolean the auto-indent flag

public void setAutoIndent(final boolean autoIndent)

Set this to true if you want the template engine to render indents automatically. In that case, the supplied writer is wrapped into a groovy.text.markup.DelegatingIndentWriter and indents are inserted after each call to newLine.

Parameters

autoIndent:boolean: the auto-indent flag

setAutoIndentString	back to summary
public void setAutoIndentString(final String autoIndentString)

setAutoNewLine	back to summary
public void setAutoNewLine(final boolean autoNewLine)

setBaseTemplateClass back to summary

setBaseTemplateClass	back to summary
public void setBaseTemplateClass(final Class<? extends BaseTemplate> baseTemplateClass) Set the template base class. You can use a distinct template class to provide more statically available data to your templates. Parameters baseTemplateClass:Class<? extends BaseTemplate> a class extending `groovy.text.markup.BaseTemplate`

public void setBaseTemplateClass(final Class<? extends BaseTemplate> baseTemplateClass)

Set the template base class. You can use a distinct template class to provide more statically available data to your templates.

Parameters

baseTemplateClass:Class<? extends BaseTemplate>: a class extending groovy.text.markup.BaseTemplate

setCacheTemplates	back to summary
public void setCacheTemplates(final boolean cacheTemplates) If cache is enabled, then templates are compiled once for each source (URL or File). It is recommended to keep this flag to true unless you are in development mode and want automatic reloading of templates. Parameters cacheTemplates:boolean should templates be cached

setCacheTemplates

back to summary

public void setCacheTemplates(final boolean cacheTemplates)

If cache is enabled, then templates are compiled once for each source (URL or File). It is recommended to keep this flag to true unless you are in development mode and want automatic reloading of templates.

Parameters

cacheTemplates:boolean: should templates be cached

setDeclarationEncoding	back to summary
public void setDeclarationEncoding(final String declarationEncoding) Set the encoding used to write the declaration header. Note that it is the responsibility of the user to ensure that it matches the writer encoding. Parameters declarationEncoding:String encoding to be used in the declaration string

setDeclarationEncoding

back to summary

public void setDeclarationEncoding(final String declarationEncoding)

Set the encoding used to write the declaration header. Note that it is the responsibility of the user to ensure that it matches the writer encoding.

Parameters

declarationEncoding:String: encoding to be used in the declaration string

setExpandEmptyElements	back to summary
public void setExpandEmptyElements(final boolean expandEmptyElements)

setLocale	back to summary
public void setLocale(final Locale locale)

setNewLineString	back to summary
public void setNewLineString(final String newLineString)

setUseDoubleQuotes	back to summary
public void setUseDoubleQuotes(final boolean useDoubleQuotes)

public Class TemplateConfiguration

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail