United StatesChange Country, Oracle Worldwide Web Sites Communities I am a... I want to...
Bug ID: JDK-4770063 stddoclet: generate doc for readObjectNoData() in serialized form page
JDK-4770063 : stddoclet: generate doc for readObjectNoData() in serialized form page

Details
Type:
Bug
Submit Date:
2002-10-28
Status:
Resolved
Updated Date:
2003-12-19
Project Name:
JDK
Resolved Date:
2003-12-19
Component:
docs
OS:
generic
Sub-Component:
doclet
CPU:
generic
Priority:
P3
Resolution:
Fixed
Affected Versions:
1.4.2
Fixed Versions:
5.0 (b32)

Related Reports

Sub Tasks

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
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
SUGGESTED FIX

See description.
                                     
2004-06-11
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
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



Hardware and Software, Engineered to Work Together