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

invalid use of @serial tag

    XMLWordPrintable

Details

    • CSR
    • Resolution: Approved
    • P4
    • 19
    • client-libs
    • None
    • minimal
    • Change in doc only.
    • Java API
    • SE

    Description

      Summary

      Remove the @serial tag from method documentation since it does not belong there.

      Problem

      A serial tag in the method documentation is causing a warning message in various awt methods. The serial tag should not be used in method documentation and should only be used in package, class/interface, or field documentation.

      Solution

      Remove the serial tag from method documentation.

      Specification

      Remove @serial tag from java/applet/Applet.java in readObject(ObjectInputStream s)

      - * @serial

      + *

      * @see java.awt.GraphicsEnvironment#isHeadless

      * @since 1.4

      */

      @Serial

      private void readObject(ObjectInputStream s)


      Remove @serial tag from java/awt/Button.java in readObject(ObjectInputStream s)

      - * @serial

      + *

      * @see #removeActionListener(ActionListener)

      * @see #addActionListener(ActionListener)

      * @see java.awt.GraphicsEnvironment#isHeadless

      * @see #writeObject(ObjectOutputStream)

      */

      @Serial

      private void readObject(ObjectInputStream s)


      Remove @serial tag from java/awt/Checkbox.java in readObject(ObjectInputStream s)

      - * @serial

      + *

      * @see #removeItemListener(ItemListener)

      * @see #addItemListener(ItemListener)

      * @see java.awt.GraphicsEnvironment#isHeadless

      * @see #writeObject(ObjectOutputStream)

      */

      @Serial

      private void readObject(ObjectInputStream s)


      Remove @serial tag from java/awt/CheckboxMenuItem.java in readObject(ObjectInputStream s)

      - * @serial

      + *

      * @see #removeActionListener(ActionListener)

      * @see #addActionListener(ActionListener)

      * @see #writeObject(ObjectOutputStream)

      */

      @Serial

      private void readObject(ObjectInputStream s)


      Remove @serial tag from java/awt/Choice.java in readObject(ObjectInputStream s)

      - * @serial

      + *

      * @see #removeItemListener(ItemListener)

      * @see #addItemListener(ItemListener)

      * @see java.awt.GraphicsEnvironment#isHeadless

      * @see #writeObject(ObjectOutputStream)

      */

      @Serial

      private void readObject(ObjectInputStream s)


      Remove @serial tag from java/awt/Container.java in readObject(ObjectInputStream s)

      - * @serial

      + *

      * @see #addContainerListener

      * @see #writeObject(ObjectOutputStream)

      */

      @Serial

      private void readObject(ObjectInputStream s)


      Remove @serial tag from java/awt/Font.java in readObject(ObjectInputStream s)

      - * @serial

      + *

      * @see #writeObject(java.io.ObjectOutputStream)

      */

      @Serial

      private void readObject(java.io.ObjectInputStream s)

      throws java.lang.ClassNotFoundException,


      Remove @serial tag from java/awt/Label.java in readObject(ObjectInputStream s)

      - * @serial

      + *

      * @see java.awt.GraphicsEnvironment#isHeadless

      * @since 1.4

      */

      @Serial

      private void readObject(ObjectInputStream s)


      Remove @serial tag from java/awt/MenuComponent.java in readObject(ObjectInputStream s)

      - * @serial

      + *

      * @see java.awt.GraphicsEnvironment#isHeadless

      */

      @SuppressWarnings("removal")

      @Serial

      private void readObject(ObjectInputStream s)


      Remove @serial tag from java/awt/FocusEvent.java in readResolve()

      - * @serial

      + *

      * @see #cause

      * @since 9

      */

      @Serial

      @SuppressWarnings("serial")

      Object readResolve() throws ObjectStreamException {


      Remove @serial tag from java/awt/KeyEvent.java in readObject(ObjectInputStream s)

      - * @serial

      */

      @Serial

      @SuppressWarnings("deprecation")

      private void readObject(ObjectInputStream s)

      throws IOException, ClassNotFoundException {


      Remove @serial tag from java/awt/MouseEvent.java in readObject(ObjectInputStream s)

      - * @serial

      */

      @Serial

      @SuppressWarnings("deprecation")

      private void readObject(ObjectInputStream s)

      throws IOException, ClassNotFoundException {

      Attachments

        Issue Links

          Activity

            People

              achung Alisen Chung
              jjg Jonathan Gibbons
              Philip Race
              Votes:
              0 Vote for this issue
              Watchers:
              1 Start watching this issue

              Dates

                Created:
                Updated:
                Resolved: