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

Unclear return values descriptions for some methods in javax.swing.JSpinner.*Edi

XMLWordPrintable

    • Cause Known
    • sparc
    • solaris_2.5

      Name: md153984 Date: 10/01/2004


      Descriptions of return values for some method javax.swing.JSpinner.*Editor contain contradictory
      java code:
           1) Descriptions for the methods
                  "public java.text.SimpleDateFormat javax.swing.JSpinner.DateEditor.getFormat()"
                  "public java.text.DecimalFormat javax.swing.JSpinner.NumberEditor.getFormat()"
                contain:
                  "Returns: the value of getTextField().getFormatter().getFormat()"
              In fact getTextField().getFormatter() returns
              javax.swing.JFormattedTextField.AbstractFormatter which has no getFormat() method.

           2) Descriptions for the methods
                 "public javax.swing.SpinnerDateModel javax.swing.JSpinner.DateEditor.getModel()"
                 "public javax.swing.SpinnerListModel javax.swing.JSpinner.ListEditor.getModel()"
                 "public javax.swing.SpinnerNumberModel javax.swing.JSpinner.NumberEditor.getModel()"
              contain:
                 "Returns: getSpinner().getModel()"
              In fact getSpinner().getModel() returns interface javax.swing.SpinnerModel

      May be it would be better to rewrite descriptions without using ambiguous java code constructions.

      ======================================================================
      ###@###.### 10/13/04 15:54 GMT

            peterz Peter Zhelezniakov
            duke J. Duke
            Votes:
            0 Vote for this issue
            Watchers:
            0 Start watching this issue

              Created:
              Updated:
              Imported:
              Indexed: