Class 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()
     
    • Field Detail

      • sb

        private final java.lang.StringBuilder sb
        StringBuilder to be used in the Builder class.
      • translator

        private final CharSequenceTranslator translator
        CharSequenceTranslator to be used in the Builder class.
    • Constructor Detail

      • Builder

        private Builder​(CharSequenceTranslator translator)
        Builder constructor.
        Parameters:
        translator - a CharSequenceTranslator.
    • Method Detail

      • 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