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

javadoc for CharsetEncoder.maxBytesPerChar() should be made clearer

    XMLWordPrintable

    Details

    • Type: Enhancement
    • Status: Closed
    • Priority: P5
    • Resolution: Won't Fix
    • Affects Version/s: 9
    • Fix Version/s: tbd_minor
    • Component/s: core-libs
    • Labels:

      Description

      Javadoc currently states:

      --------------------------------
      public final float CharsetEncoder.maxBytesPerChar()
      Returns the maximum number of bytes that will be produced for each character of input.
      This value may be used to compute the worst-case size of the output buffer required for a given input sequence.
      --------------------------------

      This may be misinterpreted, as it may be not clear what CHARACTERs this sentence is about.
      If they were Unicode code-points, UTF8Encoder.maxBytesPerChar() should return 4.0.
      However, as the statement is in fact about Java characters, it correctly returns 3.0.

        Attachments

          Issue Links

            Activity

              People

              Assignee:
              Unassigned Unassigned
              Reporter:
              shadowbug Shadow Bug
              Votes:
              0 Vote for this issue
              Watchers:
              4 Start watching this issue

                Dates

                Created:
                Updated:
                Resolved: