Package com.google.common.escape

Class CharEscaper

  • Direct Known Subclasses:
    ArrayBasedCharEscaper
    @Beta
@GwtCompatible
public abstract class CharEscaper
extends Escaper
    An object that converts literal text into a format safe for inclusion in a particular context (such as an XML document). Typically (but not always), the inverse process of "unescaping" the text is performed automatically by the relevant parser.

    For example, an XML escaper would convert the literal string "Foo<Bar>" into "Foo&lt;Bar&gt;" to prevent "<Bar>" from being confused with an XML tag. When the resulting XML document is parsed, the parser API will return this text as the original literal string "Foo<Bar>".

    A CharEscaper instance is required to be stateless, and safe when used concurrently by multiple threads.

    Several popular escapers are defined as constants in classes like HtmlEscapers, XmlEscapers, and SourceCodeEscapers. To create your own escapers extend this class and implement the escape(char) method.

    Since:
    15.0

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.String escape​(java.lang.String string)
      Returns the escaped form of a given literal string.

      • Methods inherited from class java.lang.Object

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

    • Method Detail

      • escape

        public java.lang.String escape​(java.lang.String string)
        Returns the escaped form of a given literal string.
        Specified by:
        escape in class Escaper
        Parameters:
        string - the literal string to be escaped
        Returns:
        the escaped form of string
        Throws:
        java.lang.NullPointerException - if string is null