Package org.thymeleaf.model

Interface IModelFactory

All Known Implementing Classes:

StandardModelFactory

public interface IModelFactory

Interface defining model factories.

A Model Factory can be obtained at custom processor artifacts by means of ITemplateContext.getModelFactory(), and then used for creating and modifying models (IModel) and events (ITemplateEvent.

The StandardModelFactory implementation will be used by default.

Since:

3.0.0

Author:

Daniel Fernández

See Also:

IModel, ITemplateEvent, StandardModelFactory

Method Summary

Modifier and Type	Method	Description
ICDATASection	createCDATASection(CharSequence content)	Create a new CDATA Section event, containing the specified contents.
ICloseElementTag	createCloseElementTag(String elementName)	Create a new close tag, non-synthetic and non-unmatched.
ICloseElementTag	createCloseElementTag(String elementName, boolean synthetic, boolean unmatched)	Create a new close tag.
IComment	createComment(CharSequence content)	Create a new Comment event, containing the specified contents.
IDocType	createDocType(String publicId, String systemId)	Create a DOCTYPE clause event with the specified public ID and system ID.
IDocType	createDocType(String keyword, String elementName, String publicId, String systemId, String internalSubset)	Create a DOCTYPE clause event, specifying all its components.
IDocType	createHTML5DocType()	Create a DOCTYPE clause event for HTML5 (no type, no public or system id).
IModel	createModel()	Creates a new, empty model.
IModel	createModel(ITemplateEvent event)	Creates a new model containing only one event (initially).
IOpenElementTag	createOpenElementTag(String elementName)	Create a new open element tag, non-synthetic.
IOpenElementTag	createOpenElementTag(String elementName, boolean synthetic)	Create a new open element tag.
IOpenElementTag	createOpenElementTag(String elementName, String attributeName, String attributeValue)	Create a new open element tag, non-synthetic, specifying one attribute.
IOpenElementTag	createOpenElementTag(String elementName, String attributeName, String attributeValue, boolean synthetic)	Create a new open element tag, specifying one attribute.
IOpenElementTag	createOpenElementTag(String elementName, Map<String,String> attributes, AttributeValueQuotes attributeValueQuotes, boolean synthetic)	Create a new open element tag, specifying several attributes.
IProcessingInstruction	createProcessingInstruction(String target, String content)	Create a new Processing Instruction event, specifying its target and content.
IStandaloneElementTag	createStandaloneElementTag(String elementName)	Create a new standalone element tag, non synthetic and minimized.
IStandaloneElementTag	createStandaloneElementTag(String elementName, boolean synthetic, boolean minimized)	Create a new standalone element tag.
IStandaloneElementTag	createStandaloneElementTag(String elementName, String attributeName, String attributeValue)	Create a new standalone element tag, non synthetic and minimized, specifying one attribute.
IStandaloneElementTag	createStandaloneElementTag(String elementName, String attributeName, String attributeValue, boolean synthetic, boolean minimized)	Create a new standalone element tag, specifying one attribute.
IStandaloneElementTag	createStandaloneElementTag(String elementName, Map<String,String> attributes, AttributeValueQuotes attributeValueQuotes, boolean synthetic, boolean minimized)	Create a new standalone element tag, specifying several attributes.
IText	createText(CharSequence text)	Create a new Text event, specifying its contents.
IXMLDeclaration	createXMLDeclaration(String version, String encoding, String standalone)	Create a new XML Declaration event, specifying values for all its attributes.
IModel	parse(TemplateData ownerTemplate, String template)	Parse the template specified as String and return the result as a model.
<T extends IProcessableElementTag> T	removeAttribute(T tag, String attributeName)	Create a new tag removing an existing attribute.
<T extends IProcessableElementTag> T	removeAttribute(T tag, String prefix, String name)	Create a new tag removing an existing attribute.
<T extends IProcessableElementTag> T	removeAttribute(T tag, AttributeName attributeName)	Create a new tag removing an existing attribute.
<T extends IProcessableElementTag> T	replaceAttribute(T tag, AttributeName oldAttributeName, String attributeName, String attributeValue)	Create a new tag object replacing an attribute in the original tag with another one.
<T extends IProcessableElementTag> T	replaceAttribute(T tag, AttributeName oldAttributeName, String attributeName, String attributeValue, AttributeValueQuotes attributeValueQuotes)	Create a new tag object replacing an attribute in the original tag with another one, also specifying the type of quotes to be used for representing the attribute value.
<T extends IProcessableElementTag> T	setAttribute(T tag, String attributeName, String attributeValue)	Create a new tag object that adds a new attribute to the existing ones in a specified tag.
<T extends IProcessableElementTag> T	setAttribute(T tag, String attributeName, String attributeValue, AttributeValueQuotes attributeValueQuotes)	Create a new tag object that adds a new attribute to the existing ones in a specified tag, also specifying the type of quotes to be used for representing the attribute value.

Method Detail

createModel

IModel createModel()

Creates a new, empty model.

Returns:

the new model.

createModel

IModel createModel(ITemplateEvent event)

Creates a new model containing only one event (initially).

Parameters:

event - the event to be put into the newly created model.

Returns:

the new model.

parse

IModel parse(TemplateData ownerTemplate,
             String template)

Parse the template specified as String and return the result as a model.

Note the template argument specified here is the template content itself, not a name to be resolved by a template resolver. The ownerTemplate argument is mandatory, and specifies the template that is being processed and as a part of which process the String template is being parsed.

Parameters:

ownerTemplate - the template being processed, for which the String template is being parsed into a model object.

template - the String containing the contents of the template to be parsed.

Returns:

the IModel representing the parsed template.

createCDATASection

ICDATASection createCDATASection(CharSequence content)

Create a new CDATA Section event, containing the specified contents.

Parameters:

content - the content (i.e. without prefix or suffix) of the new CDATA Section.

Returns:

the new CDATA Section.

createComment

IComment createComment(CharSequence content)

Create a new Comment event, containing the specified contents.

Parameters:

content - the content (i.e. without prefix or suffix) of the new Comment.

Returns:

the new Comment.

createHTML5DocType

IDocType createHTML5DocType()

Create a DOCTYPE clause event for HTML5 (no type, no public or system id).

Returns:

the new DOCTYPE, corresponding with an HTML5 DOCTYPE clause.

createDocType

IDocType createDocType(String publicId,
                       String systemId)

Create a DOCTYPE clause event with the specified public ID and system ID.

Parameters:

publicId - the public ID to be applied (might be null).

systemId - the system ID to be applied (might be null if public ID is also null).

Returns:

the new DOCTPYE.

createDocType

IDocType createDocType(String keyword,
                       String elementName,
                       String publicId,
                       String systemId,
                       String internalSubset)

Create a DOCTYPE clause event, specifying all its components.

Parameters:

keyword - the keyword value (should be DOCTYPE, but case might vary).

elementName - the root element name.

publicId - the public ID (might be null).

systemId - the system ID (might be null).

internalSubset - the internal subset (might be null).

Returns:

the new DOCTYPE.

createProcessingInstruction

IProcessingInstruction createProcessingInstruction(String target,
                                                   String content)

Create a new Processing Instruction event, specifying its target and content.

Parameters:

target - the target value.

content - the content value.

Returns:

the new Processing Instruction.

createText

IText createText(CharSequence text)

Create a new Text event, specifying its contents.

Parameters:

text - the text contents.

Returns:

the new Text.

createXMLDeclaration

IXMLDeclaration createXMLDeclaration(String version,
                                     String encoding,
                                     String standalone)

Create a new XML Declaration event, specifying values for all its attributes.

Parameters:

version - the version value (might be null).

encoding - the encoding value (might be null).

standalone - the standalone value (might be null).

Returns:

the new XML Declaration.

createStandaloneElementTag

IStandaloneElementTag createStandaloneElementTag(String elementName)

Create a new standalone element tag, non synthetic and minimized.

This is equivalent to calling createStandaloneElementTag(String, boolean, boolean) with false as a value for synthetic and true as a value for minimized.

Parameters:

elementName - the element name.

Returns:

the standalone tag.

createStandaloneElementTag

IStandaloneElementTag createStandaloneElementTag(String elementName,
                                                 String attributeName,
                                                 String attributeValue)

Create a new standalone element tag, non synthetic and minimized, specifying one attribute.

This is equivalent to calling createStandaloneElementTag(String, String, String, boolean, boolean) with false as a value for synthetic and true as a value for minimized.

Parameters:

elementName - the element name.

attributeName - the name of the attribute to be added to the tag.

attributeValue - the value of the attribute to be added to the tag.

Returns:

the standalone tag.

createStandaloneElementTag

IStandaloneElementTag createStandaloneElementTag(String elementName,
                                                 boolean synthetic,
                                                 boolean minimized)

Create a new standalone element tag.

Parameters:

elementName - the element name.

synthetic - whether the tag is synthetic or not. Synthetic tags are used for balancing of markup and will not appear on output.

minimized - whether the tag is minimized or not, i.e. whether it ends in /> or simply >.

Returns:

the standalone tag.

createStandaloneElementTag

IStandaloneElementTag createStandaloneElementTag(String elementName,
                                                 String attributeName,
                                                 String attributeValue,
                                                 boolean synthetic,
                                                 boolean minimized)

Create a new standalone element tag, specifying one attribute.

Parameters:

elementName - the element name.

attributeName - the name of the attribute to be added to the tag.

attributeValue - the value of the attribute to be added to the tag.

synthetic - whether the tag is synthetic or not. Synthetic tags are used for balancing of markup and will not appear on output.

minimized - whether the tag is minimized or not, i.e. whether it ends in /> or simply >.

Returns:

the standalone tag.

createStandaloneElementTag

IStandaloneElementTag createStandaloneElementTag(String elementName,
                                                 Map<String,String> attributes,
                                                 AttributeValueQuotes attributeValueQuotes,
                                                 boolean synthetic,
                                                 boolean minimized)

Create a new standalone element tag, specifying several attributes.

Parameters:

elementName - the element name.

attributes - the map of attribute names and values.

attributeValueQuotes - the type of quotes to be used for representing the attribute values.

synthetic - whether the tag is synthetic or not. Synthetic tags are used for balancing of markup and will not appear on output.

minimized - whether the tag is minimized or not, i.e. whether it ends in /> or simply >.

Returns:

the standalone tag.

createOpenElementTag

IOpenElementTag createOpenElementTag(String elementName)

Create a new open element tag, non-synthetic.

This is equivalent to calling createOpenElementTag(String, boolean) with false as a value for synthetic.

Parameters:

elementName - the element name.

Returns:

the open tag.

createOpenElementTag

IOpenElementTag createOpenElementTag(String elementName,
                                     String attributeName,
                                     String attributeValue)

Create a new open element tag, non-synthetic, specifying one attribute.

This is equivalent to calling createOpenElementTag(String, String, String, boolean) with false as a value for synthetic.

Parameters:

elementName - the element name.

attributeName - the name of the attribute to be added to the tag.

attributeValue - the value of the attribute to be added to the tag.

Returns:

the open tag.

createOpenElementTag

IOpenElementTag createOpenElementTag(String elementName,
                                     boolean synthetic)

Create a new open element tag.

Parameters:

elementName - the element name.

synthetic - whether the tag is synthetic or not. Synthetic tags are used for balancing of markup and will not appear on output.

Returns:

the open tag.

createOpenElementTag

IOpenElementTag createOpenElementTag(String elementName,
                                     String attributeName,
                                     String attributeValue,
                                     boolean synthetic)

Create a new open element tag, specifying one attribute.

Parameters:

elementName - the element name.

attributeName - the name of the attribute to be added to the tag.

attributeValue - the value of the attribute to be added to the tag.

synthetic - whether the tag is synthetic or not. Synthetic tags are used for balancing of markup and will not appear on output.

Returns:

the open tag.

createOpenElementTag

IOpenElementTag createOpenElementTag(String elementName,
                                     Map<String,String> attributes,
                                     AttributeValueQuotes attributeValueQuotes,
                                     boolean synthetic)

Create a new open element tag, specifying several attributes.

Parameters:

elementName - the element name.

attributes - the map of attribute names and values.

attributeValueQuotes - the type of quotes to be used for representing the attribute values.

synthetic - whether the tag is synthetic or not. Synthetic tags are used for balancing of markup and will not appear on output.

Returns:

the open tag.

createCloseElementTag

ICloseElementTag createCloseElementTag(String elementName)

Create a new close tag, non-synthetic and non-unmatched.

This is equivalent to calling createCloseElementTag(String, boolean, boolean) with false as a value for synthetic and also false as a value for unmatched.

Parameters:

elementName - the element name.

Returns:

the close tag.

createCloseElementTag

ICloseElementTag createCloseElementTag(String elementName,
                                       boolean synthetic,
                                       boolean unmatched)

Create a new close tag.

Parameters:

elementName - the element name.

synthetic - whether the tag is synthetic or not. Synthetic tags are used for balancing of markup and will not appear on output.

unmatched - whether this tag should be considered unmatched, i.e. there is no corresponding previous open tag for it.

Returns:

the close tag.

setAttribute

<T extends IProcessableElementTag> T setAttribute(T tag,
                                                  String attributeName,
                                                  String attributeValue)

Create a new tag object that adds a new attribute to the existing ones in a specified tag.

Note that this method should create a new object because ITemplateEvent implementations are immutable. Also, the created tag will be of the same type (i.e. standalone or open) as the specified as argument.

Type Parameters:

T - the type of the original and new tags.

Parameters:

tag - the original tag.

attributeName - the name of the attribute to be added.

attributeValue - the value of the attribute to be added.

Returns:

the new tag.

setAttribute

<T extends IProcessableElementTag> T setAttribute(T tag,
                                                  String attributeName,
                                                  String attributeValue,
                                                  AttributeValueQuotes attributeValueQuotes)

Create a new tag object that adds a new attribute to the existing ones in a specified tag, also specifying the type of quotes to be used for representing the attribute value.

Note that this method should create a new object because ITemplateEvent implementations are immutable. Also, the created tag will be of the same type (i.e. standalone or open) as the specified as argument.

Type Parameters:

T - the type of the original and new tags.

Parameters:

tag - the original tag.

attributeName - the name of the attribute to be added.

attributeValue - the value of the attribute to be added.

attributeValueQuotes - the type of quotes to be used for representing the attribute value.

Returns:

the new tag.

replaceAttribute

<T extends IProcessableElementTag> T replaceAttribute(T tag,
                                                      AttributeName oldAttributeName,
                                                      String attributeName,
                                                      String attributeValue)

Create a new tag object replacing an attribute in the original tag with another one.

Note that this method should create a new object because ITemplateEvent implementations are immutable. Also, the created tag will be of the same type (i.e. standalone or open) as the specified as argument.

If the attribute being replaced does not exist, the new one will be created as if setAttribute(IProcessableElementTag, String, String) was called instead. If the old attribute does exist, its position in the tag as well as its quote type will be used.

Type Parameters:

T - the type of the original and new tags.

Parameters:

tag - the original tag.

oldAttributeName - the name of the attribute to be replaced.

attributeName - the name of the attribute to be added.

attributeValue - the value of the attribute to be added.

Returns:

the new tag.

replaceAttribute

<T extends IProcessableElementTag> T replaceAttribute(T tag,
                                                      AttributeName oldAttributeName,
                                                      String attributeName,
                                                      String attributeValue,
                                                      AttributeValueQuotes attributeValueQuotes)

Create a new tag object replacing an attribute in the original tag with another one, also specifying the type of quotes to be used for representing the attribute value.

Note that this method should create a new object because ITemplateEvent implementations are immutable. Also, the created tag will be of the same type (i.e. standalone or open) as the specified as argument.

If the attribute being replaced does not exist, the new one will be created as if setAttribute(IProcessableElementTag, String, String) was called instead. If the old attribute does exist, its position in the tag will be used.

Type Parameters:

T - the type of the original and new tags.

Parameters:

tag - the original tag.

oldAttributeName - the name of the attribute to be replaced.

attributeName - the name of the attribute to be added.

attributeValue - the value of the attribute to be added.

attributeValueQuotes - the type of quotes to be used for representing the attribute value.

Returns:

the new tag.

removeAttribute

<T extends IProcessableElementTag> T removeAttribute(T tag,
                                                     String attributeName)

Create a new tag removing an existing attribute.

Note that this method should create a new object because ITemplateEvent implementations are immutable. Also, the created tag will be of the same type (i.e. standalone or open) as the specified as argument.

If the attribute being removed does not exist, nothing will be done and the same tag object will be returned.

Type Parameters:

T - the type of the original and new tags.

Parameters:

tag - the original tag.

attributeName - the name of the attribute to be removed.

Returns:

the new tag.

removeAttribute

<T extends IProcessableElementTag> T removeAttribute(T tag,
                                                     String prefix,
                                                     String name)

Create a new tag removing an existing attribute.

Note that this method should create a new object because ITemplateEvent implementations are immutable. Also, the created tag will be of the same type (i.e. standalone or open) as the specified as argument.

If the attribute being removed does not exist, nothing will be done and the same tag object will be returned.

Type Parameters:

T - the type of the original and new tags.

Parameters:

tag - the original tag.

prefix - the prefix of the attribute (might be null).

name - the name of the attribute.

Returns:

the new tag.

removeAttribute

<T extends IProcessableElementTag> T removeAttribute(T tag,
                                                     AttributeName attributeName)

Create a new tag removing an existing attribute.

Note that this method should create a new object because ITemplateEvent implementations are immutable. Also, the created tag will be of the same type (i.e. standalone or open) as the specified as argument.

If the attribute being removed does not exist, nothing will be done and the same tag object will be returned.

Type Parameters:

T - the type of the original and new tags.

Parameters:

tag - the original tag.

attributeName - the attribute name.

Returns:

the new tag.