Andrew McIntyre wrote:
When looking through the published api javadoc recently, I noticed
that there are two tools classes, JDBCDisplayUtil and URLCheck, that
are in the public tools package (org.apache.derby.tools) but not in
the published api javadoc.
JDBCDisplayUtil is used all over the tests, and I notice it is now
also used in the scores demo, and it is a handy tool for dumping the
contents of a result set. If we're going to add it to the published
api javadoc, though, it would be good to clean up the javadoc comments
in the class.
URLCheck is only used internally in ij, and is of limited utility
externally, so I think this one should be moved into impl.tools.ij.
Opinions? If no one objects, I'll move URLCheck and open a JIRA for
adding JDBCDisplayUtil to the public javadoc.
-0.9 on making JDBCDisplayUtil part of the public api
As a utility class it's not that well written, it maintains some state
in static variables, which means multiple applications and/or threads
using it have the potential to affect each other and thus produce
unexpected results. It also would need cleanup to be able to run in a
restricted SecurityManager environment.
When the code was originally contributed I removed it from the public
api javadoc to avoid it being used, at the time I didn't realise the
tests used it so much.
I'm also not sure how many real database applications are out there that
need to write ResultSet output to standard out in such a primitive form.
I would guess most applications are feeding their output into HTML
tables with hyperlinks or projects like BIRT that produce reports
against data.
Dan.
