com.google.common.html.types

Class SafeHtml

java.lang.Object

com.google.common.html.types.SafeHtml

@Immutable
 @JsType
public final class SafeHtml
extends Object

A string that is safe to use in HTML context in DOM APIs and HTML documents.

A SafeHtml is a string-like object that carries the security type contract that its value as a string will not cause untrusted script execution when evaluated as HTML in a browser.

Values of this type are guaranteed to be safe to use in HTML contexts, such as, assignment to the innerHTML DOM property, or interpolation into a HTML template in HTML PC_DATA context, in the sense that the use will not result in a Cross-Site-Scripting vulnerability.

Field Summary

Fields

Modifier and Type	Field and Description
static SafeHtml	EMPTY The SafeHtml wrapping an empty string.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object other)
String	getSafeHtmlString() Returns this value's underlying string.
int	hashCode()
String	toString() Returns a debug representation of this value's underlying string, NOT the string representation of the SafeHtml.

Methods inherited from class java.lang.Object

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

Field Detail

EMPTY

public static final SafeHtml EMPTY

The SafeHtml wrapping an empty string.

Method Detail

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object other)

Overrides:

equals in class Object

toString

public String toString()

Returns a debug representation of this value's underlying string, NOT the string representation of the SafeHtml.

Having toString() return a debug representation is intentional. This type has a GWT-compiled JavaScript version; JavaScript has no static typing and a distinct method method name provides a modicum of type-safety.

Overrides:

toString in class Object

See Also:

getSafeHtmlString()

getSafeHtmlString

public String getSafeHtmlString()

Returns this value's underlying string. See class documentation for what guarantees exist on the returned string.