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

Incorrect Javadoc comment for PropertyChangeEvent.getNewValue() method

XMLWordPrintable

    • x86
    • windows_nt

      Name: rmT116609 Date: 10/09/2003


      A DESCRIPTION OF THE PROBLEM :
      The Javadoc for getNewValue() method of java.beans.PropertyChangeEvent class incorrectly states that "Sets the new value for the property, expresssed as an Object."

      This error is present in both Java 1.3 API doc and 1.4.2 API doc. (i.e., errors present in both of the following URLs)

      http://java.sun.com/j2se/1.4.2/docs/api/java/beans/PropertyChangeEvent.html#getNewValue()

      Though, we can easily make it out that this is a typo error, it will be better if the error is fixed. It may confuse a new comer to this API doc for help.



      EXPECTED VERSUS ACTUAL BEHAVIOR :
      EXPECTED -
      The correct version should be:

      "Gets the new value for the property, expressed as on Object."
      ACTUAL -
      public Object getNewValue()
      Sets the new value for the property, expressed as an Object.

      URL OF FAULTY DOCUMENTATION :
      http://java.sun.com/j2se/1.4.2/docs/api/java/beans/PropertyChangeEvent.html#getNewValue()
      (Incident Review ID: 208937)
      ======================================================================

            shickeysunw Shannon Hickey (Inactive)
            rmandalasunw Ranjith Mandala (Inactive)
            Votes:
            0 Vote for this issue
            Watchers:
            0 Start watching this issue

              Created:
              Updated:
              Resolved:
              Imported:
              Indexed: