Commons Lang
  1. Commons Lang
  2. LANG-122

[lang] EscapeUtil.escapeHtml() should clarify that it does not escape ' chars to '

    Details

    • Type: Bug Bug
    • Status: Closed
    • Priority: Minor Minor
    • Resolution: Fixed
    • Affects Version/s: 2.1
    • Fix Version/s: 2.2
    • Component/s: None
    • Labels:
      None
    • Environment:

      Operating System: All
      Platform: All

      Description

      The official HTML character entity spec does not include the popular "'"
      entity name for the single quote character '. the StringUtils class correctly
      follows this behavior, leaving single quotes alone. However, many developers
      incorrectly assume that ' will get escaped into ' (I was one!) and we can
      help them by clarifying this in the Javadoc.

      The following could be appended to the method Javadoc:

      Note: Not all common HTML entity names are formally included in the standard
      specification (http://www.w3.org/TR/REC-html40/sgml/entities.html, as listed
      below). This method follows the standard, and thus does not escape the
      single-quote ' character into &apos.

        Activity

        Hide
        Henri Yandell added a comment -

        svn ci -m "Added note on lack of ' support as detailed in issue #37385
        (http://issues.apache.org/bugzilla/show_bug.cgi?id=37385)"
        src/java/org/apache/commons/lang/StringEscapeUtils.java
        Sending src/java/org/apache/commons/lang/StringEscapeUtils.java
        Transmitting file data .
        Committed revision 394616.

        Show
        Henri Yandell added a comment - svn ci -m "Added note on lack of ' support as detailed in issue #37385 ( http://issues.apache.org/bugzilla/show_bug.cgi?id=37385 )" src/java/org/apache/commons/lang/StringEscapeUtils.java Sending src/java/org/apache/commons/lang/StringEscapeUtils.java Transmitting file data . Committed revision 394616.
        Hide
        Sebb added a comment -

        Fix source so displayed version looks correct

        Show
        Sebb added a comment - Fix source so displayed version looks correct

          People

          • Assignee:
            Unassigned
            Reporter:
            Dov Wasserman
          • Votes:
            0 Vote for this issue
            Watchers:
            1 Start watching this issue

            Dates

            • Created:
              Updated:
              Resolved:

              Development