JDK-4770063 : stddoclet: generate doc for readObjectNoData() in serialized form page
  • Type: Bug
  • Status: Resolved
  • Resolution: Fixed
  • Component: tools
  • Sub-Component: javadoc(tool)
  • Priority: P3
  • Affected Version: 1.4.2
  • OS: generic
  • CPU: generic
  • Submit Date: 2002-10-28
  • Updated Date: 2014-05-05
  • Resolved Date: 2003-12-19
The Version table provides details related to the release that this issue/RFE will be addressed.

Unresolved : Release in which this issue/RFE will be addressed.
Resolved: Release in which this issue/RFE has been resolved.
Fixed : Release in which this issue/RFE has been fixed. The release containing this fix may be available for download as an Early Access Release or a General Availabitlity Release.

To download the current JDK release, click here.
Other
5.0 b32Resolved
Description
Javadoc currently generates documentation on the serialized form page for
custom writeObject() and readObject() methods declared by a serializable class.
In JDK 1.4, support was added for an additional custom serialization method,
readObjectNoData(), which is used in some cases to initialize superclass state
if the serialization stream lacks data for that superclass (for details, see
the class-level javadoc for java.io.ObjectInputStream, as well as section 3.5
of the latest serialization specification).

It would be useful if javadoc could generate documentation for
readObjectNoData() on the serialized form page in the same way that it
currently does for writeObject() and readObject().  This would allow
serializable classes to document their initial state in the event that they are
deserialized from a stream that's missing superclass data.

Comments
CONVERTED DATA BugTraq+ Release Management Values COMMIT TO FIX: tiger tiger-beta FIXED IN: tiger-beta INTEGRATED IN: tiger-b32 tiger-beta
2004-06-14

EVALUATION ###@###.### wrote: > Should we implement this new request to add readObjectNoData() to the > serialized form spec? ###@###.### wrote: Yep...it should certainly be documented. Support has been added for readObjectNoData() in the serialized form. ###@###.### 2002-10-28 ###@###.### 2003-12-01
2004-06-11

SUGGESTED FIX See description.
2004-06-11

PUBLIC COMMENTS Javadoc currently generates documentation on the serialized form page for custom writeObject() and readObject() methods declared by a serializable class. In JDK 1.4, support was added for an additional custom serialization method, readObjectNoData(), which is used in some cases to initialize superclass state if the serialization stream lacks data for that superclass (for details, see the class-level javadoc for java.io.ObjectInputStream, as well as section 3.5 of the latest serialization specification). It would be useful if javadoc could generate documentation for readObjectNoData() on the serialized form page in the same way that it currently does for writeObject() and readObject(). This would allow serializable classes to document their initial state in the event that they are deserialized from a stream that's missing superclass data. ===================== This bug has been fixed. ###@###.### 2003-12-01
2003-12-01