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 tags 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 tags 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 tags starting with the specified prefix but with no associated attribute or tag processor 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 attribute processors, implementing the IAttrProcessor interface, that will be able to process and apply logic to attributes starting with the specified prefix.
• A set of tag processors, implementing the ITagProcessor interface, that will be able to process and apply logic to tags starting with the specified prefix.
• A set of value processors, implementing the IValueProcessor interface that will be used by attribute and tag processors in order to evaluate different kinds of expressions (e.g. externalized message expressions, variable expressions...).
• 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 tag/attribute 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

Set<IAttrProcessor>	getAttrProcessors() Returns the set of attribute processors.
Set<IDocTypeResolutionEntry>	getDocTypeResolutionEntries() Returns the set of DOCTYPE resolution entries.
Set<IDocTypeTranslation>	getDocTypeTranslations() Returns the set of DOCTYPE translations.
String	getPrefix() Returns the default dialect prefix (the one that will be used if none is explicitly specified during dialect configuration).
Set<ITagProcessor>	getTagProcessors() Returns the set of tag processors.
Set<IValueProcessor>	getValueProcessors() Returns the set of value 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 tag is considered processable by the processors in the dialect, 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 the existence of attributes or tags starting with the dialect prefix for which no attribute/tag processor exists is considered an error.

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.

getAttrProcessors

Set<IAttrProcessor> getAttrProcessors()

Returns the set of attribute processors.

Returns:

the set of attribute processors.

getTagProcessors

Set<ITagProcessor> getTagProcessors()

Returns the set of tag processors.

Returns:

the set of tag processors.

getValueProcessors

Set<IValueProcessor> getValueProcessors()

Returns the set of value processors.

Returns:

the set of value processors.

getDocTypeTranslations

Set<IDocTypeTranslation> getDocTypeTranslations()

Returns the set of DOCTYPE translations.

Returns:

the set of DOCTYPE translations.

getDocTypeResolutionEntries

Set<IDocTypeResolutionEntry> getDocTypeResolutionEntries()

Returns the set of DOCTYPE resolution entries.

Returns:

the set of DOCTYPE resolution entries.