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

(spec){Reader,Writer}.close() documentation is ambiguous

XMLWordPrintable

    • b59
    • x86
    • windows_xp

      Name: rmT116609 Date: 08/10/2004


      A DESCRIPTION OF THE PROBLEM :
      The method description for java.io.FilterReader.close() says:

          Close the stream.

      It is not clear whether that means "closes this stream" or "closes the
      underlying stream" (the stream given in the constructor).


      In addition, a number of other close methods have the same documentation
      problem.



      EXPECTED VERSUS ACTUAL BEHAVIOR :
      EXPECTED -
      Something like the method descriptions the explicitly method closing the
      underlying stream (or explicit mention that the underlying stream is not
      closed).
      ACTUAL -
      See above.

      URL OF FAULTY DOCUMENTATION :
      .../api/java/io/FilterReader.html#close()
      (Incident Review ID: 296512)
      ======================================================================

            jhangalsunw Jayalaxmi Hangal (Inactive)
            rmandalasunw Ranjith Mandala (Inactive)
            Votes:
            0 Vote for this issue
            Watchers:
            0 Start watching this issue

              Created:
              Updated:
              Resolved:
              Imported:
              Indexed: