Java Docs

 

The BEA eLink Java Adapter for Mainframe WLS Edition (JAM) product comes with HTML pages that document the JAM Java classes. These also are referred to as "javadoc" files. They are located in the jamdoc.jar file, found in the JAM installation directory.

Issue the following command to extract the javadoc HTML files from the jar file:

jar -xvf jamdoc.jar

where:

jar

is the Java archive command.

-xvf

is the extract file(s) parameter.

v

is the verbose parameter to list the files.

f

is the option which designates the next parameter as the jar file name.

jamdoc.jar

is the name of the JAM javadoc file.

This command extracts all of the files contained in the jar file into the current directory. The HTML documentation files are placed in a newly created subdirectory named classdocs in the current directory.

To view an HTML documentation file, open your web browser and specify the file name of the javadoc you want to view, taken from the classdocs directory. Any of the following files are good for getting started:

• classdocs/AllNames.html

• classdocs/packages.html

• classdocs/tree.html