|
Quick Lists
|
|
Bug ID:
|
6546713
|
|
Votes
|
0
|
|
Synopsis
|
(coll) Clarify meaning of "(optional)" in collections docs
|
|
Category
|
java:classes_util
|
|
Reported Against
|
|
|
Release Fixed
|
|
|
State
|
7-Fix in Progress,
bug
|
|
Priority:
|
3-Medium
|
|
Related Bugs
|
|
|
Submit Date
|
17-APR-2007
|
|
Description
|
The word "(optional)" in exception specifications for
Collections Framework interfaces and classes
is too mysterious. It refers to a paragraph in the class javadoc
for Collection, but few readers will inhale the entire stack of
superinterfaces and superclasses for each Collections Framework
interface or class, and so the "(optional)" is likely to be
misinterpreted.
Posted Date : 2007-04-17 04:45:52.0
|
|
Work Around
|
N/A
|
|
Evaluation
|
Joe Bowbeer writes:
Here's what the fix would look like:
Collection.java
1. Add "optional-restrictions" anchor.
* <p><a name="optional-restrictions"/>
* Some collection implementations have restrictions on the elements that they
* may contain. For example, some implementations prohibit null elements,
2. Add links to the optional restrictions paragraph.
There are ten instances of "(optional)" -- resulting from five sets of
ClassCastException and NullPointerException. In each instance,
"(optional)" would be replaced by:
(<a href="#optional-restrictions">optional</a>)
Posted Date : 2007-04-17 04:45:53.0
|
|
Comments
|
PLEASE NOTE: JDK6 is formerly known as Project Mustang
|
|
|
 |