public final Class HtmlEscapers

Class Inheritance

extends Object

java.lang.Object
com.google.common.html.HtmlEscapers

Annotations

@GwtCompatible
@ElementTypesAreNonnullByDefault

Imports

com.google.common.annotations.GwtCompatible, com.google.common.escape.Escaper, .Escapers

Escaper instances suitable for strings to be included in HTML attribute values and most elements' text contents. When possible, avoid manual escaping by using templating systems and high-level APIs that provide autoescaping. One Google-authored templating system available for external use is Closure Templates.

HTML escaping is particularly tricky: For example, some elements' text contents must not be HTML escaped. As a result, it is impossible to escape an HTML document correctly without domain-specific knowledge beyond what HtmlEscapers provides. We strongly encourage the use of HTML templating systems.

Authors: Sven Mawson, David Beaumont
Since: 15.0

Field Summary

Modifier and Type	Field and Description
private static final Escaper	HTML_ESCAPER

Constructor Summary

Access	Constructor and Description
private	HtmlEscapers()

Method Summary

Modifier and Type	Method and Description
public static Escaper	htmlEscaper() Returns an `Escaper` instance that escapes HTML metacharacters as specified by HTML 4.01.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

HTML_ESCAPER	back to summary
private static final Escaper HTML_ESCAPER

Constructor Detail

HtmlEscapers	back to summary
private HtmlEscapers()

Method Detail

htmlEscaper back to summary

htmlEscaper	back to summary
public static Escaper htmlEscaper() Returns an `Escaper` instance that escapes HTML metacharacters as specified by HTML 4.01. The resulting strings can be used both in attribute values and in most elements' text contents, provided that the HTML document's character encoding can encode any non-ASCII code points in the input (as UTF-8 and other Unicode encodings can). Note This escaper only performs minimal escaping to make content structurally compatible with HTML. Specifically, it does not perform entity replacement (symbolic or numeric), so it does not replace non-ASCII code points with character references. This escaper escapes only the following five ASCII characters: `'"&<>`.

public static Escaper htmlEscaper()

Returns an Escaper instance that escapes HTML metacharacters as specified by HTML 4.01. The resulting strings can be used both in attribute values and in most elements' text contents, provided that the HTML document's character encoding can encode any non-ASCII code points in the input (as UTF-8 and other Unicode encodings can).

Note

This escaper only performs minimal escaping to make content structurally compatible with HTML. Specifically, it does not perform entity replacement (symbolic or numeric), so it does not replace non-ASCII code points with character references. This escaper escapes only the following five ASCII characters: '"&<>.