org.thymeleaf.dom
Class Attribute

Object
  org.thymeleaf.dom.Attribute

All Implemented Interfaces:

Serializable

public final class Attribute
extends Object
implements Serializable

Models an element attribute.

Since:

2.0.0

Author:

Daniel Fernández

See Also:

Serialized Form

Field Summary

static String

XMLNS_PREFIX Prefix for namespace-definition attributes (like xmlns:th).

Constructor Summary

Attribute(String name, boolean onlyName, String value)

Method Summary

String	getNormalizedName() Returns the normalized name of the attribute.
String	getNormalizedPrefix() Returns the normalized prefix of this attribute (part of its name), if it exists, or null if the element is unprefixed.
String	getOriginalName() Returns the original name of the attribute.
String	getUnprefixedNormalizedName() Returns the normalized version of the attribute name, without its prefix (if it has one).
String	getValue() Returns the value of the attribute.
String	getXmlnsPrefix() If this is a namespace declaration attribute (like "xmlns:x"), this method returns the prefix (the "x").
boolean	hasPrefix() Returns whether the attribute name has a prefix or not.
boolean	isOnlyName() Determines whether this attribute is to be specified only by its name (no equals sign, no value).
boolean	isXmlnsAttribute() Returns whether this attribute is a namespace declaration (xmlns:*) or not.

Methods inherited from class Object

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

Field Detail

XMLNS_PREFIX

public static final String XMLNS_PREFIX

Prefix for namespace-definition attributes (like xmlns:th).

See Also:

Constant Field Values

Constructor Detail

Attribute

public Attribute(String name,
                 boolean onlyName,
                 String value)

Method Detail

getOriginalName

public String getOriginalName()

Returns the original name of the attribute. Given the fact that the engine works using the normalized versions of attribute names (in order to be case-insensitive), it is necessary to make a distinction between the 'original' name of an attribute (as it is written in the template file) and its 'normalized' name.

If the attribute name has a prefix, this 'original name' includes such prefix.

Returns:

the original name of the attribute.

getNormalizedName

public String getNormalizedName()

Returns the normalized name of the attribute. Attribute names are normalized by means of the Node.normalizeName(String) method so that the engine can work in a case-insensitive way.

If the attribute name has a prefix, this 'normalized name' includes such prefix.

Returns:

the normalized name of the attribute.

getNormalizedPrefix

public String getNormalizedPrefix()

Returns the normalized prefix of this attribute (part of its name), if it exists, or null if the element is unprefixed.

Prefixes are normalized in the same way as element names, using the Node.normalizeName(String) method.

Returns:

the normalized prefix.

getUnprefixedNormalizedName

public String getUnprefixedNormalizedName()

Returns the normalized version of the attribute name, without its prefix (if it has one).

Returns:

the unprefixed normalized name.

hasPrefix

public boolean hasPrefix()

Returns whether the attribute name has a prefix or not.

Returns:

true if the attribute name has a prefix, false if not.

isOnlyName

public boolean isOnlyName()

Determines whether this attribute is to be specified only by its name (no equals sign, no value).

If this is true, but getValue() is not null, this flag is ignored.

Parsers and/or template writers are not required to honor this flag, and they can choose to render attributes with their values always even if these are empty and/or null and this flag is set.

Returns:

true if attribute should be represented only by its name.

Since:

2.0.14

getValue

public String getValue()

Returns the value of the attribute.

Returns:

the value of the attribute.

isXmlnsAttribute

public boolean isXmlnsAttribute()

Returns whether this attribute is a namespace declaration (xmlns:*) or not.

Returns:

true if the attribute is a namespace declaration, false if not.

getXmlnsPrefix

public String getXmlnsPrefix()

If this is a namespace declaration attribute (like "xmlns:x"), this method returns the prefix (the "x").

If this is not a namespace declaration attribute, this method will return null.

Returns:

the namespace prefix, if this is a namespace declaration attribute.