Uploaded image for project: 'JDK'
  1. JDK
  2. JDK-8243169

Remove addition preview adornment from String::stripIndent and String::translateEscapes

    XMLWordPrintable

    Details

    • Type: CSR
    • Status: Closed
    • Priority: P3
    • Resolution: Approved
    • Fix Version/s: 15
    • Component/s: core-libs
    • Labels:
      None
    • Subcomponent:
    • Compatibility Kind:
      source
    • Compatibility Risk:
      minimal
    • Compatibility Risk Description:
      Documentation only.
    • Interface Kind:
      Java API
    • Scope:
      SE

      Description

      Summary

      The JavaDoc for String::stripIndent and String::translateEscapes still contain JavaDoc elements that should be updated before release.

      Problem

      The current state of the JavaDoc indicates a preview status.

      Solution

      Correct the JavaDoc.

      Specification

      diff -r b559c7e7c4d4 src/java.base/share/classes/java/lang/String.java
      --- a/src/java.base/share/classes/java/lang/String.java Thu Apr 09 16:32:22 2020 -0300
      +++ b/src/java.base/share/classes/java/lang/String.java Mon Apr 20 11:47:17 2020 -0300
      @@ -2888,15 +2888,6 @@
           }
      
           /**
      -     * {@preview Associated with text blocks, a preview feature of
      -     *           the Java language.
      -     *
      -     *           This method is associated with <i>text blocks</i>, a preview
      -     *           feature of the Java language. Programs can only use this
      -     *           method when preview features are enabled. Preview features
      -     *           may be removed in a future release, or upgraded to permanent
      -     *           features of the Java language.}
      -     *
            * Returns a string whose value is this string, with incidental
            * {@linkplain Character#isWhitespace(int) white space} removed from
            * the beginning and end of every line.
      @@ -2970,7 +2961,7 @@
            * @see String#indent(int)
            * @see Character#isWhitespace(int)
            *
      -     * @since 13
      +     * @since 15
            *
            */
           public String stripIndent() {
      @@ -3011,15 +3002,6 @@
           }
      
           /**
      -     * {@preview Associated with text blocks, a preview feature of
      -     *           the Java language.
      -     *
      -     *           This method is associated with <i>text blocks</i>, a preview
      -     *           feature of the Java language. Programs can only use this
      -     *           method when preview features are enabled. Preview features
      -     *           may be removed in a future release, or upgraded to permanent
      -     *           features of the Java language.}
      -     *
            * Returns a string whose value is this string, with escape sequences
            * translated as if in a string literal.
            * <p>
      @@ -3103,7 +3085,7 @@
            *
            * @jls 3.10.7 Escape Sequences
            *
      -     * @since 13
      +     * @since 15
            */
           public String translateEscapes() {
               if (isEmpty()) {

        Attachments

          Issue Links

            Activity

              People

              Assignee:
              jlaskey Jim Laskey
              Reporter:
              jlaskey Jim Laskey
              Reviewed By:
              Chris Hegarty
              Votes:
              0 Vote for this issue
              Watchers:
              1 Start watching this issue

                Dates

                Created:
                Updated:
                Resolved: