Two Laptop Bag*
The moose likes Beginning Java and the fly likes API Big Moose Saloon
  Search | Java FAQ | Recent Topics | Flagged Topics | Hot Topics | Zero Replies
Register / Login
JavaRanch » Java Forums » Java » Beginning Java
Bookmark "API" Watch "API" New topic
Author

API

Mark Covert
Greenhorn

Joined: Feb 19, 2001
Posts: 22
Hi all,
How do I get the API to work?
Is the API normally downloaded or do you look at it on the Sun Website?
Do you have to have an internet connection to view the API?
Can I do something to view the API directly from TextPad?
Mark
Frank Carver
Sheriff

Joined: Jan 07, 1999
Posts: 6920
I'm not sure what you are asking. API is an abbreviation for "Application Programming Interface". Any product (particularly software products) can provide an API so that other software may make use of it.
The Java SDK (SOftware Development Kit) includes a Java Virtual Machine to run class files, some tools for compilation etc., and some jars containing classes which provide an API for your Java programs to use. Whenever you use a class provided as part of the SDK you are accessing an API.
There are also a lot of other APIs available, both "standard extensions" such as the Servlet API and the Java Mail API, and "third party APIs" such as control APIs provided by database and server applications.
Which API(s) are you interested in, and what would you like to do with them?


Read about me at frankcarver.me ~ Raspberry Alpha Omega ~ Frank's Punchbarrel Blog
Mark Covert
Greenhorn

Joined: Feb 19, 2001
Posts: 22
Hi Frank,
I'm talking about the HTML pages where you can go in an look at the classes, their different methods and all that jazz. I don't remember how to view it.
I was thinking I had to go to the sun website to do it, but perhaps it is integral to the SDK? Basically, I just want to know how you would display this information. How do I get the HTML pages to come up?
Mark
Grant Crofton
Ranch Hand

Joined: Nov 08, 2000
Posts: 154
I can't remember if you get them automatically, but if you don't you can download them from sun's site.
On my 'puter they're on C:\jdk1.3\docs\api\index.html
Mark Covert
Greenhorn

Joined: Feb 19, 2001
Posts: 22
Okay. . .
so do you have to go into the directory in Winexplorer and double click on the file index.html or what do you do when you are looking for something?
Isn't there some way to look into the html through TextPad?
I was thinking there was a way to display the html inside one of the TextPad windows, but I am getting older so maybe I'm just starting to remember things funny.
Frank Carver
Sheriff

Joined: Jan 07, 1999
Posts: 6920
The API documents are usually a separate download. They are designed for viewing using a browser, although you can, of course load the individual pages into an editor or other HTML development environment if you feel you need to search or modify them.
What is the problem with looking at them using a browser? What do you want/need to do with these API documents?
Nathan Pruett
Bartender

Joined: Oct 18, 2000
Posts: 4121

Mark,
With TextPad you can just have a browser window open in the background with the api docs in it... in JEDPlus (a freeware editor alot like TextPad) a button is provided on the toolbar that will launch the api docs in a new browser window. I don't know if the same functionality is provided somewhere in TextPad, but if I were you I would just download the api docs from Sun and make a shortcut on your desktop to open them... then if you ever needed to view them you could minimize TextPad, launch the docs and switch windows (or tile them, or whatever) to browse them while you code.
HTH,
-Nate


-Nate
Write once, run anywhere, because there's nowhere to hide! - /. A.C.
Mark Covert
Greenhorn

Joined: Feb 19, 2001
Posts: 22
Hi Frank,
There is probably no problem looking at the html through the browser. I just couldn't remember how I had accessed the pages before.
Maybe it is not the API that I am thinking of. What I was thinking of was these html pages where you can look at the different Java classes and the methods that they use. It's like a reference. It was very helpful if you were looking for a method to perform a function, but didn't know the syntax or if you wanted to see what class belonged to a particular superclass, etc.
I get lost fast at the sun site. They've got so many products and APIs. I just keep jumping from link to link getting more and more confused about which product I should be using. I have no idea what sun calls these html pages.
I thought maybe I needed to download them.
Wait! I just found it. Its at: http://java.sun.com/j2se/1.3/docs/api/index.html
This is what I'm talking about.
Is this the right one for the Java� 2 Standard Edition Runtime Environment?
Sorry for the silly questions. I'm just confused about all of the products.
I was just looking at my D: drive and realised (realized) I have about four bin folders. I have installed and uninstalled so many products since I started that I no longer know what is what.
Mark
[This message has been edited by Mark Covert (edited February 26, 2001).]
Cindy Glass
"The Hood"
Sheriff

Joined: Sep 29, 2000
Posts: 8521
Just to clarify for all, the API documentation can be viewed online directly from the sun site as Mark points out at
http://java.sun.com/j2se/1.3/docs/api/index.html
It can ALSO be downloaded from this page to use when you are not hooked up to your ISP:
http://java.sun.com/j2se/1.3/docs.html
Of course the best way to view them is through a browser. If you have IE or Netscape they will display without going through the internet.
If you ONLY have AOL you might have to sign on to view them either way. (I have BOTH AOL and IE at home so when I'm not on AOL I can still use my download).

"JavaRanch, where the deer and the Certified play" - David O'Meara
John M. Gabriele
Ranch Hand

Joined: Feb 18, 2001
Posts: 232
mark,
you can get 3 different java development environments,
they're all called java2:
standard edition --- the one you want, and the one (i'd guess)
that most folks in this beginner section use.
enterprise edition --- i think this is more for experienced
people writing java server pages and servlets--server-side stuff.
i think you have to pay big bucks for this one.
micro edition --- for use on appliances or cell phones
or their kin. you likely have no use for this now.
the documentation is a separate download entirely with it's
own install procedure (it's supposed to end up in the jdk1.3
directory in a new "doc" (or maybe "docs") folder).
most folks sit at their computer and program with both the
editor and the internet browser open (browser aimed at
c:\jdk1.3\docs\index.html or whatever) and switch
back and forth as necessary.
Grant Crofton
Ranch Hand

Joined: Nov 08, 2000
Posts: 154
When you do have the documents downloaded, just find the directory (as above) in windows explorer and double-click on index.html. It should load in your default browser.
 
I agree. Here's the link: http://aspose.com/file-tools
 
subject: API
 
Similar Threads
How to view the Soap Message
List of classes which override equals method
Robot class
API?
How to change the screen in android application?