Package com.aspectran.web.support.util

Class HtmlUtils

java.lang.Object
com.aspectran.web.support.util.HtmlUtils
public abstract class HtmlUtils extends Object

This class is a clone of org.springframework.web.util.HtmlUtils

Utility class for HTML escaping.

Escapes and unescapes based on the W3C HTML 4.01 recommendation, handling character entity references.

Reference: https://www.w3.org/TR/html4/charset.html

For a comprehensive set of String escaping utilities, consider Apache Commons Text and its StringEscapeUtils class. We do not use that class here in order to avoid a runtime dependency on Commons Text just for HTML escaping. Furthermore, Spring's HTML escaping is more flexible and 100% HTML 4.0 compliant.

  • Field Details

    • DEFAULT_CHARACTER_ENCODING

      public static final String DEFAULT_CHARACTER_ENCODING
      Default character encoding to use when request.getCharacterEncoding returns null, according to the Servlet spec.
      See Also:

  • Constructor Details

    • HtmlUtils

      public HtmlUtils()

  • Method Details

    • htmlEscape

      @NonNull public static String htmlEscape(String input)
      Turn special characters into HTML character references.

      Handles complete character set defined in HTML 4.01 recommendation.

      Escapes all special characters to their corresponding entity reference (e.g. <).

      Reference: https://www.w3.org/TR/html4/sgml/entities.html

      Parameters:
      input - the (unescaped) input string
      Returns:
      the escaped string

    • htmlEscape

      @NonNull public static String htmlEscape(String input, String encoding)
      Turn special characters into HTML character references.

      Handles complete character set defined in HTML 4.01 recommendation.

      Escapes all special characters to their corresponding entity reference (e.g. <) at least as required by the specified encoding. In other words, if a special character does not have to be escaped for the given encoding, it may not be.

      Reference: https://www.w3.org/TR/html4/sgml/entities.html

      Parameters:
      input - the (unescaped) input string
      encoding - the name of a supported charset
      Returns:
      the escaped string
      Since:
      4.1.2

    • htmlEscapeDecimal

      @NonNull public static String htmlEscapeDecimal(String input)
      Turn special characters into HTML character references.

      Handles complete character set defined in HTML 4.01 recommendation.

      Escapes all special characters to their corresponding numeric reference in decimal format (&#Decimal;).

      Reference: https://www.w3.org/TR/html4/sgml/entities.html

      Parameters:
      input - the (unescaped) input string
      Returns:
      the escaped string

    • htmlEscapeDecimal

      @NonNull public static String htmlEscapeDecimal(String input, String encoding)
      Turn special characters into HTML character references.

      Handles complete character set defined in HTML 4.01 recommendation.

      Escapes all special characters to their corresponding numeric reference in decimal format (&#Decimal;) at least as required by the specified encoding. In other words, if a special character does not have to be escaped for the given encoding, it may not be.

      Reference: https://www.w3.org/TR/html4/sgml/entities.html

      Parameters:
      input - the (unescaped) input string
      encoding - the name of a supported charset
      Returns:
      the escaped string
      Since:
      4.1.2

    • htmlEscapeHex

      @NonNull public static String htmlEscapeHex(String input)
      Turn special characters into HTML character references.

      Handles complete character set defined in HTML 4.01 recommendation.

      Escapes all special characters to their corresponding numeric reference in hex format (&#xHex;).

      Reference: https://www.w3.org/TR/html4/sgml/entities.html

      Parameters:
      input - the (unescaped) input string
      Returns:
      the escaped string

    • htmlEscapeHex

      @NonNull public static String htmlEscapeHex(String input, String encoding)
      Turn special characters into HTML character references.

      Handles complete character set defined in HTML 4.01 recommendation.

      Escapes all special characters to their corresponding numeric reference in hex format (&#xHex;) at least as required by the specified encoding. In other words, if a special character does not have to be escaped for the given encoding, it may not be.

      Reference: https://www.w3.org/TR/html4/sgml/entities.html

      Parameters:
      input - the (unescaped) input string
      encoding - the name of a supported charset
      Returns:
      the escaped string
      Since:
      4.1.2

    • htmlUnescape

      public static String htmlUnescape(String input)
      Turn HTML character references into their plain text UNICODE equivalent.

      Handles complete character set defined in HTML 4.01 recommendation and all reference types (decimal, hex, and entity).

      Correctly converts the following formats:

      &#Entity; - (Example: &) case sensitive &#Decimal; - (Example: D)
      &#xHex; - (Example: å) case insensitive

      Gracefully handles malformed character references by copying original characters as is when encountered.

      Reference: https://www.w3.org/TR/html4/sgml/entities.html

      Parameters:
      input - the (escaped) input string
      Returns:
      the unescaped string