How to use the documentation for the Java SE API

  Click here to read full story

How to use the documentation for the Java SE API

When you write Java code, you'll often need to look up information about the Application Program Interface (API) for the Java SE. The API provides the Java classes that you can use as you build your Java applications. Since Sun provides HTML-based documentation for the Java SE API, you can browse this documentation with any web browser to get the detailed information you need about any Java class.

How to install the API documentation

Although you can use your browser to view the documentation for the Java SE API from the Java web site, you will want to install this documentation on your hard drive instead. That way, you can browse the documentation more quickly, and you can browse it even if you aren't connected to the Internet.

To download and install this documentation, you can use the procedure shown in figure 1-15. Since the documentation comes in a compressed format called a zip file, you need to use an unzip tool to extract the HTML pages from the zip file. When you use this tool, it creates a docs directory that contains many files and subdirectories. Although you can store the docs directory anywhere you like, it's common to store it as a subdirectory of the JDK directory.

If your operating system doesn't include a tool for working with zip files, you can download one from the web. For example, WinZip is a popular program for working with zip files. You can download a free evaluation copy fromwww.winzip.com.

How to download the API documentation

1. Go to the Java web site (java.sun.com).
2. Go to the download page for the version of the JDK that you're using (see figure 1-4) and find the hyperlink for the Java SE 6 documentation download.
3. Follow the instructions for the download and save the zip file to your hard drive.

How to install the API documentation

• Extract all files in the zip file to your hard drive. This will create a directory named docs that contains several files and subdirectories.
• Although it's common to store the API documentation in the JDK directory (usually C:\Program Files\Java\jdk1.6.0 for version 6), you can store it anywhere you like.

Description

• The Application Programming Interface, or API, provides all the classes that are included as part of the JDK. To learn about these classes, you can use the API documentation.
• You can view the API documentation from the Java web site, or you can download and install it on your system.

Notes

• If you're using an older operating system that doesn't automatically work with zip files, you may need to use a tool such as WinZip to extract the files from the zip file. To download a free evaluation copy of WinZip, go to www.winzip.com.
  

Introduction to Java ...................................................................... 4
Toolkits and platforms ....................................................................... 4
Java compared to C++ ...................................................................... 4
Java compared to C# ........................................................................ 4
Applications, applets, and servlets ....................................................... 6
How Java compiles and interprets code ................................................ 8
How to prepare your system for using Java .................................. 10
How to install the JDK ..........................................................................10
A summary of the directories and files of the JDK ...................................12
How to set the command path ...............................................................14
How to set the class path ..................................................................... 16
How to use TextPad to work with Java ........................................... 18
How to install TextPad ......................................................................... 18
How to use TextPad to save and edit source code ................................... 20
How to use TextPad to compile source code ........................................... 22
How to use TextPad to run an application ............................................... 22
Common error messages and solutions ................................................. 24
How to use the command prompt to work with Java ...................... 26
How to compile source code ................................................................. 26
How to run an application ..................................................................... 26
How to compile source code with a switch .............................................. 28
Essential DOS skills for working with Java ............................................. 30
How to use the documentation for the Java SE API ....................... 32
How to install the API documentation ..................................................... 32
How to navigate the API documentation ................................................. 34
Introduction to Java IDEs ................................................................ 36
The Eclipse IDE for Java ....................................................................... 36
The NetBeans IDE ................................................................................ 38
The BlueJ IDE ...................................................................................... 38
Perspective ....................................................................................... 40

8480 bytes more | comments? |    | Score: 0

How to get started with Java: How to navigate the API documentation

  Click here to read full story

How to navigate the API documentation

Figure 1-16 shows how to navigate the documentation for the Java SE API. To start, you point your web browser to the index page that's stored in the docs\api directory. To do that for the first time, use the Windows Explorer to navigate to the docs\api directory and double-click on the index.html file, or enter the location of this page into the address area of your web browser:

C:\Program Files\Java\jdk1.6.0\docs\api\index.html

Since you'll need to access this page often as you learn about Java, you should use your web browser's favorites or bookmark feature to mark this page. Then, the next time you need to use this page, you can go right to it.

To browse the Java documentation, you need to know that all the classes in the Java API are organized into packages. As a result, the index page for the documentation provides a way to navigate through packages and classes. To start, you can select a package from the upper left frame. When you do, the lower left frame displays all the classes in that package. Then, you can select a class to display information about that class in the right frame.

As you progress through this book, you'll learn about many different packages and classes, and you'll learn much more about how packages and classes work. Along the way, you can always use the documentation for the Java API to help clarify the discussion or further your knowledge.

The index for the documentation

Description

• If you've installed the API documentation on your hard drive, you can display an index like the one shown above by using your web browser to go to the index.html file in the docs\api directory. If you haven't installed the documentation, you can browse through it on the Java web site.
• Related classes in the Java API are organized into packages, which are listed in the upper left frame of the documentation page. When you select a package, all the classes for that package are listed in the lower left frame.
• You can select a class from the lower left frame to display the documentation for that class in the right frame. You can also select the name of the package at the top of the lower left frame to display information about the package and the classes it contains.
• Once you display the documentation for a class, you can scroll through it or click on a hyperlink to get more information.
• The documentation for a class usually provides a wide range of information, including a summary of all of its methods. You'll learn more about methods and how they're used throughout this book.
• To make it easier to access the API documentation, you should bookmark the index page. To do that with the Internet Explorer, select the Add To Favorites command from the Favorites menu and accept the default name for the page or assign your own name to it. Then, you can redisplay this page later by selecting it from the Favorites menu.

Introduction to Java ...................................................................... 4
Toolkits and platforms ....................................................................... 4
Java compared to C++ ...................................................................... 4
Java compared to C# ........................................................................ 4
Applications, applets, and servlets ....................................................... 6
How Java compiles and interprets code ................................................ 8
How to prepare your system for using Java .................................. 10
How to install the JDK ..........................................................................10
A summary of the directories and files of the JDK ...................................12
How to set the command path ...............................................................14
How to set the class path ..................................................................... 16
How to use TextPad to work with Java ........................................... 18
How to install TextPad ......................................................................... 18
How to use TextPad to save and edit source code ................................... 20
How to use TextPad to compile source code ........................................... 22
How to use TextPad to run an application ............................................... 22
Common error messages and solutions ................................................. 24
How to use the command prompt to work with Java ...................... 26
How to compile source code ................................................................. 26
How to run an application ..................................................................... 26
How to compile source code with a switch .............................................. 28
Essential DOS skills for working with Java ............................................. 30
How to use the documentation for the Java SE API ....................... 32
How to install the API documentation ..................................................... 32
How to navigate the API documentation ................................................. 34
Introduction to Java IDEs ................................................................ 36
The Eclipse IDE for Java ....................................................................... 36
The NetBeans IDE ................................................................................ 38
The BlueJ IDE ...................................................................................... 38
Perspective ....................................................................................... 40

9538 bytes more | comments? |    | Score: 0