com.google.template.soy.soytree

Class TagName

java.lang.Object

com.google.template.soy.soytree.TagName

public final class TagName
extends Object

An html tag name that could either be a StaticTagName or a PrintNode. We only allow PrintNode for dynamic tag name at this point.

For {code @StaticTagName}, the equality semantics are based on the lower-ascii tag name and ignore source location. So 'DIV' and 'div' are considered equivalent.

For DynamicTagName, the equality semantics are based on the ExprRootNode associated with the PrintNode.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TagName.RcDataTagName An enum to represent tags that have rcdata content.

Constructor Summary

Constructors

Constructor and Description
TagName(PrintNode node)
TagName(RawTextNode node)

Method Summary

Modifier and Type	Method and Description
static boolean	checkOptionalTagShouldBePopped(TagName openTag, TagName closeTag) Checks if the an open tag can be auto-closed by a following close tag.
boolean	equals(Object other)
PrintNode	getDynamicTagName()
SoyNode.StandaloneNode	getNode()
TagName.RcDataTagName	getRcDataTagName() Returns the TagName.RcDataTagName for this node, if any.
String	getStaticTagName() Returns the static name.
String	getStaticTagNameAsLowerCase() Returns the static name in ascii lowercase.
SourceLocation	getTagLocation()
int	hashCode()
boolean	isDefinitelyOptional()
boolean	isDefinitelyVoid()
boolean	isForeignContent()
boolean	isStatic()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

TagName

public TagName(RawTextNode node)

TagName

public TagName(PrintNode node)

Method Detail

isStatic

public boolean isStatic()

isDefinitelyVoid

public boolean isDefinitelyVoid()

isDefinitelyOptional

public boolean isDefinitelyOptional()

checkOptionalTagShouldBePopped

public static boolean checkOptionalTagShouldBePopped(TagName openTag,
                                                     TagName closeTag)

Checks if the an open tag can be auto-closed by a following close tag.

We throws an IllegalArgumentException if two inputs have the same tag names, since this should never happen (should be handled by previous logic in StrictHtmlValidationPass).

This implements half of the content model described in https://www.w3.org/TR/html5/syntax.html#optional-tags. Notably we do nothing when we see cases like "li element is immediately followed by another li element". The validation logic relies on auto-closing open tags when we see close tags. Since only </ul> and </ol> are allowed to pop <li>, we believe this should still give us a confident error message. We might consider adding support for popping open tags when we visit open tags in the future.

isForeignContent

public boolean isForeignContent()

getRcDataTagName

@Nullable
public TagName.RcDataTagName getRcDataTagName()

Returns the TagName.RcDataTagName for this node, if any.

getStaticTagName

public String getStaticTagName()

Returns the static name.

getStaticTagNameAsLowerCase

public String getStaticTagNameAsLowerCase()

Returns the static name in ascii lowercase.

Throws:

IllegalStateException - if this tag name isn't static.

getNode

public SoyNode.StandaloneNode getNode()

getDynamicTagName

public PrintNode getDynamicTagName()

getTagLocation

public SourceLocation getTagLocation()

equals

public boolean equals(@Nullable
                      Object other)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object