org.thymeleaf.dialect
Interface IDialect

All Known Implementing Classes:

AbstractDialect, AbstractXHTMLEnabledDialect, StandardDialect

public interface IDialect

Interface for all Thymeleaf Dialects.

A Dialect must define:

• A default prefix for the names of the attributes and elements that will be processed by processors in this dialect. For example, the standard dialect defines a th prefix for its th:attr, th:value, etc. attributes. This prefix is optional, so that if prefix is null all elements and attributes will be considered processable by processors in this dialect. This prefix can be overridden: the developer can select a different one when he/she adds a dialect to the template engine (note, though, that this might affect existing .DTD files for XML/XHTML validation). A prefix is not exclusive to a dialect, and several dialects can specify the same one (effectively acting as an aggregate dialect)
• A leniency flag indicating whether the existence of attributes or elements starting with the specified prefix after the template has been processed is considered an error (non-lenient) or not (lenient). When several dialects share the same prefix, leniency is computed by prefix (if at least one dialect for a prefix is lenient, then the whole prefix is considered to be so).
• A set of processors, implementing the IProcessor interface, that will be able to process and apply logic to DOM nodes (mainly elements and their attributes) starting with the specified prefix.
• A map of execution attributes, referenced by name. These are objects that will be made available to processors during execution.
• A set of DOCTYPE translations, implementing the IDocTypeTranslation interface, which will be applied when processing templates.
• A set of DOCTYPE resolution entries, implementing the IDocTypeResolutionEntry interface, that will be fed into the EntityResolver of the XML parser so that DTD files can be retrieved as (maybe local) resources – depending on the specific implementation of the interface.

A template engine can be specified more than one dialect (each with its processors). In that case, dialects are first checked for conflicts so that, for example, they do not declare DOCTYPE translations or resolution entries conflicting with the ones in other dialect/s (although they can be equal).

Since:

1.0

Author:

Daniel Fernández

Method Summary

java.util.Set<IDocTypeResolutionEntry>	getDocTypeResolutionEntries() Returns the set of DOCTYPE resolution entries.
java.util.Set<IDocTypeTranslation>	getDocTypeTranslations() Returns the set of DOCTYPE translations.
java.util.Map<String,Object>	getExecutionAttributes() Returns the execution attributes that will be set during executions of the template engine.
String	getPrefix() Returns the default dialect prefix (the one that will be used if none is explicitly specified during dialect configuration).
java.util.Set<IProcessor>	getProcessors() Returns the set of processors.
boolean	isLenient() Returns whether the dialect is lenient or not.

Method Detail

getPrefix

String getPrefix()

Returns the default dialect prefix (the one that will be used if none is explicitly specified during dialect configuration).

If null is returned, then every attribute and/or element is considered processable by the processors in the dialect that apply to that kind of node (elements with their attributes), and not only those that start with a specific prefix.

Prefixes are not exclusive to a dialect: several dialects can declare the same prefix, effectively acting as an aggregate dialect.

Returns:

the dialect prefix.

isLenient

boolean isLenient()

Returns whether the dialect is lenient or not. If the dialect is not lenient, then after execution of a template no attributes or elements should exist in the result with the prefix specified by this dialect (an error is raised if such thing happens).

For non-lenient dialects, any xmlns:{prefix} attributes in the document root or any other element will be removed from output. These attributes will not be removed for lenient dialects.

When several dialects act on the same prefix, a prefix will be considered to be lenient if any of the dialects for that prefix is lenient.

Unless it is really required (for instance, in dialects with null prefix), dialects should be non-lenient.

Returns:

true if the dialect is lenient, false if not.

getProcessors

java.util.Set<IProcessor> getProcessors()

Returns the set of processors.

Returns:

the set of processors.

getExecutionAttributes

java.util.Map<String,Object> getExecutionAttributes()

Returns the execution attributes that will be set during executions of the template engine.

If more than one dialect are set, all of their execution attributes will be added to the available execution attributes map.

Returns:

the execution attributes for this dialect.

Since:

1.1

getDocTypeTranslations

java.util.Set<IDocTypeTranslation> getDocTypeTranslations()

Returns the set of DOCTYPE translations.

Returns:

the set of DOCTYPE translations.

getDocTypeResolutionEntries

java.util.Set<IDocTypeResolutionEntry> getDocTypeResolutionEntries()

Returns the set of DOCTYPE resolution entries.

Returns:

the set of DOCTYPE resolution entries.