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

SelectableChannel.register(..., Object) doesn't clearly document attachment arg.

    Details

    • Subcomponent:
    • CPU:
      x86
    • OS:
      windows_xp

      Description

      Name: rmT116609 Date: 08/04/2004


      A DESCRIPTION OF THE PROBLEM :
      The attachment parameter of method
      java.nio.channels/SelectableChannel.register(Selector, int, Object)
      isn't clearly documented.

      The method description say that it's an "attachment," but doesn't say what
      an attachment is or what happens to it. Traversing upwards, neither the
      enclosing class description nor the containing package's document says anything about attachments or points to SelectionKey's description of
      attachments.

      EXPECTED VERSUS ACTUAL BEHAVIOR :
      EXPECTED -
      Probably a pointer in the parameter or method description to the existing
      text in SelectionKey.

      ACTUAL -
      See above.

      URL OF FAULTY DOCUMENTATION :
      http://java.sun.com/j2se/1.5.0/docs/api/java/nio/channels/SelectableChannel.html#register(java.nio.channels.Selector,%20int,%20java.lang.Object)

      http://java.sun.com/j2se/1.4.2/docs/api/java/nio/channels/SelectableChannel.html#register(java.nio.channels.Selector,%20int,%20java.lang.Object)
      (Incident Review ID: 295881)
      ======================================================================

        Attachments

          Activity

            People

            • Assignee:
              Unassigned
              Reporter:
              rmandalasunw Ranjith Mandala (Inactive)
            • Votes:
              0 Vote for this issue
              Watchers:
              0 Start watching this issue

              Dates

              • Created:
                Updated:
                Resolved:
                Imported:
                Indexed: