JDK-6585544 : "Internal in-memory implementation" image written in ASCII characters is difficult to understand.
  • Type: Enhancement
  • Component: core-libs
  • Sub-Component: java.net
  • Affected Version: 6
  • Priority: P4
  • Status: Open
  • Resolution: Unresolved
  • OS: generic
  • CPU: generic
  • Submitted: 2007-07-26
  • Updated: 2010-11-17
Related Reports
Relates :  
Description
In java.net.CookieManager's API doc, the "Internal in-memory implementation" image (see below) is written in ASCII characters. It's a bit artless and very difficult to understand, especially, in translated doc.
It would be great if the fake image could be replaced with a real image.

--------------------------------------------------------------------------
                  use
 CookieHandler <------- HttpURLConnection
       ^
       | impl
       |         use
 CookieManager -------> CookiePolicy
             |   use
             |--------> HttpCookie
             |              ^
             |              | use
             |   use        |
             |--------> CookieStore
                            ^
                            | impl
                            |
                  Internal in-memory implementation

Comments
EVALUATION Part of the idea of javadoc is that the documentation is readable when you're looking at the source code, so embedding an image (GIF, PNG or other) could be a bit of an issue. But point is taken that ascii graphics don't always work. Will try to improve this in the future since we have plans to change things in the default cookie manager.
07-01-2008