-
Bug
-
Resolution: Won't Fix
-
P4
-
None
-
1.4.2
Name: apR10229 Date: 12/15/2002
The constructor of nested class
javax.swing.JTree.AccessibleJTree.AccessibleJTreeNode
takes a reference type of input, however, the behavior for a case when
null is passed is not documented.
The existing specification for JTree.AccessibleJTree.AccessibleJTreeNode
doesn't comply the "Requirements for Writing Java API Specifications"
listed at http://java.sun.com/j2se/javadoc/writingapispecs/index.html#method.
In particular, there is a requirement for a method specification:
-------------------------
Method Specification
This section applies to Java methods and constructors. Each method and
constructor specification must include:
.....
4.Null Argument Values - For each reference type argument, specify the
behavior when null is passed in.See two examples. NOTE: If possible,
document the general null argument behavior at the package or class level,
such as causing a java.lang.NullPointerException to be thrown. Deviations
from this behavior can then be documented at the method level.
------------------------
Please document null-parameter behavior for the specified constructor, or
put an appropriate single generic note into the class description.
======================================================================
Name: apR10229 Date: 12/15/2002
The constructor parameters should be documented too.
There are no any meaningful information about AccessibleJTreeNode constructor
in the Java API Doc.
======================================================================
The constructor of nested class
javax.swing.JTree.AccessibleJTree.AccessibleJTreeNode
takes a reference type of input, however, the behavior for a case when
null is passed is not documented.
The existing specification for JTree.AccessibleJTree.AccessibleJTreeNode
doesn't comply the "Requirements for Writing Java API Specifications"
listed at http://java.sun.com/j2se/javadoc/writingapispecs/index.html#method.
In particular, there is a requirement for a method specification:
-------------------------
Method Specification
This section applies to Java methods and constructors. Each method and
constructor specification must include:
.....
4.Null Argument Values - For each reference type argument, specify the
behavior when null is passed in.See two examples. NOTE: If possible,
document the general null argument behavior at the package or class level,
such as causing a java.lang.NullPointerException to be thrown. Deviations
from this behavior can then be documented at the method level.
------------------------
Please document null-parameter behavior for the specified constructor, or
put an appropriate single generic note into the class description.
======================================================================
Name: apR10229 Date: 12/15/2002
The constructor parameters should be documented too.
There are no any meaningful information about AccessibleJTreeNode constructor
in the Java API Doc.
======================================================================