Win a copy of Re-engineering Legacy Software this week in the Refactoring forum
or Docker in Action in the Cloud/Virtualization forum!
  • Post Reply
  • Bookmark Topic Watch Topic
  • New Topic

Finding stuff in the JSDK API docs

 
Tom McCann
Ranch Hand
Posts: 31
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Something I haven't got my head around yet...

If I want to look up a class in the API docs (e.g. the Exception class), how do I find it ? The index page has a pretty diagram showing the major libraries (Util, I/O, beans, etc) but as a newbie, I really don't know where to look.

I could use the online-search (which frequently gives too many results) but often I work off-line while travelling.

Am I missing a trick, or does familiarity come with use ?
 
marc weber
Sheriff
Posts: 11343
Java Mac Safari
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Familiarity does come with use, but...

By default, the lower left frame is an alphabetical listing of all classes, and I usually find what I'm looking for just scrolling there.
 
marc weber
Sheriff
Posts: 11343
Java Mac Safari
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Originally posted by Tom McCann:
... The index page has a pretty diagram showing the major libraries (Util, I/O, beans, etc)...

Oh, I just realized... You're probably looking at docs/index.html (where the diagram is). I think you want to be in a little deeper, at docs/api/index.html. Then use the lower left frame to find whatever class you want.
[ February 15, 2006: Message edited by: marc weber ]
 
Jeff Albertson
Ranch Hand
Posts: 1780
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Bookmark it! http://java.sun.com/j2se/1.5.0/docs/api/

A quick way to find a class is to search in the lower-left "all classes" page.

Way back when I taught, whenever I was asked "what package is (say) ImageIcon in?", I didn't reply "javax.swing", but instead I showed how to find it out in a few clicks. Often, the student would later ask about another class and I would show them how to search *again*. Around the third time they would start to ask, pull up short and say "are you just going to show me how to search for it?" Hmmm...
 
Christophe Verré
Sheriff
Posts: 14691
16
Eclipse IDE Ubuntu VI Editor
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
You can even find some in Windows Help format, if you prefer.
(I have not tried to download them)
http://www.allimant.org/javadoc/jdk15e.html
 
Tom McCann
Ranch Hand
Posts: 31
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Thanks guys. I've found the alphabetical index and updated my bookmark. I think I'll try the Windows version of the doc also.
 
Sri Ram
Ranch Hand
Posts: 118
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
hey user CTRL+F and search for the className u want to find.
 
Stan James
(instanceof Sidekick)
Ranch Hand
Posts: 8791
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Re Ctrl-F ... does FireFox always start searching at the top level and then down into the frames? Seems like IE (haven't opened it on purpose for a long time) searched the "current" frame based on cursor position or mouse click or some such thing.

Oh, and don't forget the "index" link at the top of the JavaDoc. If you vaguely remember a method called "doSomething" you can find classes that have it.
[ February 16, 2006: Message edited by: Stan James ]
 
  • Post Reply
  • Bookmark Topic Watch Topic
  • New Topic