Package org.apache.commons.text

Class StringEscapeUtils.Builder

java.lang.Object

org.apache.commons.text.StringEscapeUtils.Builder

Enclosing class:

StringEscapeUtils

public static final class StringEscapeUtils.Builder
extends java.lang.Object

Convenience wrapper for StringBuilder providing escape methods.

Example:

 new Builder(ESCAPE_HTML4)
      .append("<p>")
      .escape("This is paragraph 1 and special chars like & get escaped.")
      .append("</p><p>")
      .escape("This is paragraph 2 & more...")
      .append("</p>")
      .toString()
 

Method Summary

Modifier and Type	Method	Description
StringEscapeUtils.Builder	append(java.lang.String input)	Literal append, no escaping being done.
StringEscapeUtils.Builder	escape(java.lang.String input)	Escape input according to the given CharSequenceTranslator.
java.lang.String	toString()	Return the escaped string.

Methods inherited from class java.lang.Object

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

Method Detail

escape

public StringEscapeUtils.Builder escape(java.lang.String input)

Escape input according to the given CharSequenceTranslator.

Parameters:

input - the String to escape

Returns:

this, to enable chaining

append

public StringEscapeUtils.Builder append(java.lang.String input)

Literal append, no escaping being done.

Parameters:

input - the String to append

Returns:

this, to enable chaining

toString

public java.lang.String toString()

Return the escaped string.

Overrides:

toString in class java.lang.Object

Returns:

The escaped string