Frequently Asked Questions
How do I search for a particular Class?
Click on the "Class" search button and type the name of the class in.
JDocs.com will show you a list of matching classes after you've typed at least 2
characters. For e.g., if you type Str you will see a list of classes that begin
with the words Str (such as String, StringBuffer, etc.). Only the first 15
matches are shown. If there are more matches, the bottom of the list has a
"more" link that will show the full list of matches.
You can use wildcards (*) in your keyword to control the matches.
How do I search for packages and methods?
You can search for packages and methods by selecting the respective search button
and typing the name of the package or method in. You can use wildcards to match
packages and methods as well.
How do I browse a particular library?
To browse through the contents of a library, click on the "API List" button and
simply type the name of the library into the search box. Click on the link to
navigate to the page for the library.
Why can't I see classes of library XYZ that is available through JDocs.com in my search results?
By default the search results are limited to the favorite libraries (by default
JDK 1.5 implemented by Apache Harmony, Spring, Hibernate and Log4j). This is
necessary so that a) you don't get results from libraries that you are not
using and hence irrelevant and b) you don't get multiple results from
different versions of the same library. Click on the Favorites button to select
libraries you want included in your favorites or uncheck the button that restricts
searches to your favorites. You can save your favorite libraries by registering
an account with the site.
How do I limit the search to only those libraries that I use?
Set your favorite libraries (by clicking on the Favorites button) to the libraries you use and
check the box that says "Limit search to favorites." You can also save the favorites by
creating an account.
What information can I access from the page that displays class detail information?
The class detail page gives you a wealth of information. The top header bar
gives you links to the library and package the class belongs to. There are
also shortcut links [LIST] to quickly view the list of classes in the same
package or list of packages in the same library as the class.
The detail page then displays the signature of the class including annotation
and generics. Below this are a set of tabs.
The first tab displays the description for the class as
provided in the Javadoc. The second tab shows you inheritance information
(going all the way to java.lang.Object). It also shows you a list of direct
derivatives and a link to see all derived classes (to any degree of derivation).
The Members tab shows all the members along with relevant javadocs. There is
also a link to the line of source where the member appears. A member navigator
window allows you to quickly jump to any member's description. The member
navigator also has a "inherited members" panel that shows you all inherited
methods with links to definitions of those methods in the parent classes. The
Usage tab shows you the use of the class across all libraries in your profile.
This includes information such as constructors that take the class as a
parameter, methods that return the class, etc. The Source tab shows you the
source code (where available). The source tab also has a navigator window to
enable you to jump to member definitions with ease. The last tab, Notes allows
you to leave publicly viewable notes about the class.
Why don't you have earlier versions of Sun's JDK? (version 1.4, 1.5, 1.5)
The Sun JDK documentation are copyrighted and Sun is not licensing it to external
websites. However, begining with Sun JDK 1.7, an open source release is available under the
Open JDK project. This version and all future versions that are also open-sourced will be
available through JDocs.
I use a library that is not available on JDocs.com. How can I add it?
Our next release will include functionality to allow end users to upload
libraries. For now, send us an e-mail
and we will be
glad to add your library in.