org.thymeleaf.dom
Class NestableAttributeHolderNode

Object
  org.thymeleaf.dom.Node
      org.thymeleaf.dom.NestableNode
          org.thymeleaf.dom.NestableAttributeHolderNode

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

Element, GroupNode

public abstract class NestableAttributeHolderNode
extends NestableNode

A specialization of NestableNode that adds the ability to hold attributes.

Since:

2.0.8

Author:

Daniel Fernández

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.thymeleaf.dom.Node

Node.NodeLocalVariablesMap

Field Summary

Fields inherited from class org.thymeleaf.dom.Node

NODE_PROPERTY_XML_ENCODING, NODE_PROPERTY_XML_STANDALONE, NODE_PROPERTY_XML_VERSION

Constructor Summary

protected

NestableAttributeHolderNode(String documentName, Integer lineNumber)

Method Summary

void	clearAttributes() Clears all the attributes of the element.
Attribute	getAttributeFromNormalizedName(String normalizedAttributeName) Returns an attribute, if it exists (null if not).
Map<String,Attribute>	getAttributeMap() Returns a map with all the names (normalized) and values of the element attributes.
String	getAttributeOriginalNameFromNormalizedName(String normalizedAttributeName) Returns the original name of an attribute from its normalized name.
String	getAttributeValue(String attributeName) Returns the value of an attribute from its attribute name, without needing this name to be normalized (because the specified name will be normalized before performing the comparison).
String	getAttributeValueFromNormalizedName(String normalizedAttributeName) Returns the value of an attribute from its normalized name.
String	getAttributeValueFromNormalizedName(String dialectPrefix, String normalizedAttributeName) Returns the value of an attribute from its normalized names, usually obtained by applying a prefix to a unprefixed name.
boolean	hasAttribute(String attributeName) Returns whether an attribute exists in the element or not.
boolean	hasAttributes() Returns whether this element has any attributes or not.
boolean	hasNormalizedAttribute(String normalizedAttributeName) Returns whether an attribute exists in the element or not.
boolean	hasNormalizedAttribute(String dialectPrefix, String normalizedAttributeName) Returns whether an attribute (by any of its names) exists in the element or not.
int	numAttributes() Returns the number of attributes contained in this element.
void	removeAttribute(String attributeName) Removes a specific attribute from the element.
void	setAttribute(String name, boolean onlyName, String value) Establishes a new value for an element attribute.
void	setAttribute(String name, boolean onlyName, String value, boolean valueIsEscaped) Establishes a new value for an element attribute.
void	setAttribute(String name, String value) Establishes a new value for an element attribute.
void	setAttributes(Map<String,String> newAttributes) Establishes the value for several attributes at a time.
String[]	unsafeGetAttributeNormalizedNames() Returns the inner array used for storing the normalized names of all the existing attributes.
Attribute[]	unsafeGetAttributes() Returns the inner array used for storing the element attributes.

Methods inherited from class org.thymeleaf.dom.NestableNode

addChild, clearChildren, extractChild, getChildren, getElementChildren, getFirstChild, getFirstElementChild, hasChildren, insertAfter, insertBefore, insertChild, moveAllChildren, numChildren, removeChild, removeChild, setChildren, setProcessCommentNodes, setProcessTextNodes, unsafeGetChildrenNodeArray, visit

Methods inherited from class org.thymeleaf.dom.Node

addAllNonExistingNodeLocalVariables, applyDialectPrefix, cloneNode, getDocumentName, getLineNumber, getNodeLocalVariableNames, getNodeProperty, getNodePropertyNames, getParent, getProcessCommentNodes, getProcessTextNodes, getRecomputeProcessorsAfterEachExecution, getRecomputeProcessorsImmediately, hasNodeLocalVariables, hasNodeProperty, hasParent, isProcessable, isSkippable, normalizeName, setAllNodeLocalVariables, setNodeLocalVariable, setNodeProperty, setParent, setProcessable, setRecomputeProcessorsAfterEachExecution, setRecomputeProcessorsImmediately, setSkippable, unsafeGetNodeProperties

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

NestableAttributeHolderNode

protected NestableAttributeHolderNode(String documentName,
                                      Integer lineNumber)

Method Detail

hasAttributes

public final boolean hasAttributes()

Returns whether this element has any attributes or not.

Returns:

true if this element has attributes, false if not.

numAttributes

public final int numAttributes()

Returns the number of attributes contained in this element.

Returns:

the number of attributes.

hasAttribute

public final boolean hasAttribute(String attributeName)

Returns whether an attribute exists in the element or not. The specified name does not have to be normalized, because a normalization operation will be performed before comparing.

Parameters:

attributeName - the name of the attribute to be checked.

Returns:

true if the attribute exists, false if not.

hasNormalizedAttribute

public final boolean hasNormalizedAttribute(String normalizedAttributeName)

Returns whether an attribute exists in the element or not. The specified name has to be already normalized because no normalization operations will be performed before comparing.

Parameters:

normalizedAttributeName - the name of the attribute to be checked, already normalized.

Returns:

true if the attribute exists, false if not.

hasNormalizedAttribute

public final boolean hasNormalizedAttribute(String dialectPrefix,
                                            String normalizedAttributeName)

Returns whether an attribute (by any of its names) exists in the element or not. The specified names have to be already normalized because no normalization operations will be performed before comparing.

Parameters:

dialectPrefix - the dialect prefix to be applied to the specified attribute. Can be null.

normalizedAttributeName - the names of the attribute to be checked, already normalized.

Returns:

true if the attribute exists (any matches found), false if not.

Since:

2.1.0

getAttributeFromNormalizedName

public final Attribute getAttributeFromNormalizedName(String normalizedAttributeName)

Returns an attribute, if it exists (null if not). The specified name has to be already normalized because no normalization operations will be performed before comparing.

Parameters:

normalizedAttributeName - the name of the attribute to retrieve.

Returns:

the attribute.

unsafeGetAttributeNormalizedNames

public final String[] unsafeGetAttributeNormalizedNames()

Returns the inner array used for storing the normalized names of all the existing attributes. This method is unsafe and for internal use, and should not be called directly. Modifications to this array could produce severe DOM inconsistencies.

Returns:

the unsafe array of normalized names.

unsafeGetAttributes

public final Attribute[] unsafeGetAttributes()

Returns the inner array used for storing the element attributes. This method is unsafe and for internal use, and should not be called directly. Modifications to this array could produce severe DOM inconsistencies.

Returns:

the array of attributes.

getAttributeOriginalNameFromNormalizedName

public final String getAttributeOriginalNameFromNormalizedName(String normalizedAttributeName)

Returns the original name of an attribute from its normalized name.

Parameters:

normalizedAttributeName - the normalized name of the attribute.

Returns:

the original attribute (as written in the template file).

getAttributeValueFromNormalizedName

public final String getAttributeValueFromNormalizedName(String normalizedAttributeName)

Returns the value of an attribute from its normalized name.

Parameters:

normalizedAttributeName - the normalized name of the attribute.

Returns:

the valur of the attribute, or null if the attribute does not exist.

getAttributeValueFromNormalizedName

public final String getAttributeValueFromNormalizedName(String dialectPrefix,
                                                        String normalizedAttributeName)

Returns the value of an attribute from its normalized names, usually obtained by applying a prefix to a unprefixed name.

Parameters:

dialectPrefix - the dialect prefix to be applied to the specified attribute. Can be null.

normalizedAttributeName - the normalized name of the attribute.

Returns:

the valur of the attribute, or null if the attribute does not exist.

Since:

2.1.0

getAttributeValue

public final String getAttributeValue(String attributeName)

Returns the value of an attribute from its attribute name, without needing this name to be normalized (because the specified name will be normalized before performing the comparison).

Parameters:

attributeName - the attribute name.

Returns:

the value of the attribute.

getAttributeMap

public final Map<String,Attribute> getAttributeMap()

Returns a map with all the names (normalized) and values of the element attributes.

The map object returned by this method is a new instance, created ad-hoc with each method call.

Returns:

the map of all current attributes in the element.

setAttribute

public final void setAttribute(String name,
                               String value)

Establishes a new value for an element attribute. If the attribute already exists, its value is substituted by the one specified.

Parameters:

name - the name of the attribute.

value - the value of the attribute.

setAttribute

public final void setAttribute(String name,
                               boolean onlyName,
                               String value)

Establishes a new value for an element attribute. If the attribute already exists, its value is substituted by the one specified.

Parameters:

name - the name of the attribute.

onlyName - whether this attribute has a value or not (is only a name).

value - the value of the attribute.

setAttribute

public final void setAttribute(String name,
                               boolean onlyName,
                               String value,
                               boolean valueIsEscaped)

Establishes a new value for an element attribute. If the attribute already exists, its value is substituted by the one specified.

Parameters:

name - the name of the attribute.

onlyName - whether this attribute has a value or not (is only a name).

value - the value of the attribute.

valueIsEscaped - whether the value being set for the attribute is already escaped (e.g. direct from template parsing) or not.

Since:

2.1.3

setAttributes

public final void setAttributes(Map<String,String> newAttributes)

Establishes the value for several attributes at a time. If any of the specified attributes already exists, their values will be substituted by the one specified in the parameter map.

Parameters:

newAttributes - the new attributes to be established.

clearAttributes

public final void clearAttributes()

Clears all the attributes of the element.

removeAttribute

public final void removeAttribute(String attributeName)

Removes a specific attribute from the element. The specified name does not have to be normalized (it will be normalized before performing the removal operation).

Parameters:

attributeName - the name of tha attribute to remove (does not have to be normalized).