Java ist auch eine Insel – 3.4 Die API-Dokumentation

Java ist auch eine Insel von Christian Ullenboom
Programmieren für die Java 2-Plattform in der Version 5 (Tiger-Release)

Kapitel 3 Klassen und Objekte
	3.1 Objektorientierte Programmierung
		3.1.1 Warum überhaupt OOP?
		3.1.2 Modularität und Wiederverwertbarkeit
	3.2 Klassen benutzen
		3.2.1 Die Klasse Point
		3.2.2 Etwas über die UML
		3.2.3 Anlegen eines Exemplars einer Klasse mit new
		3.2.4 Zugriff auf Variablen und Methoden mit dem ».«
		3.2.5 Konstruktoren
	3.3 Import und Pakete
	3.4 Die API-Dokumentation
	3.5 Mit Referenzen arbeiten
		3.5.1 Die null-Referenz
		3.5.2 Zuweisungen bei Referenzen
		3.5.3 Funktionen mit nichtprimitiven Parametern
		3.5.4 Gleichheit von Objekten und die Methode equals()
	3.6 Arrays
		3.6.1 Deklaration von Arrays
		3.6.2 Arrays mit Inhalt
		3.6.3 Die Länge eines Arrays über das Attribut length
		3.6.4 Zugriff auf die Elemente
		3.6.5 Array-Objekte erzeugen
		3.6.6 Fehler bei Arrays
		3.6.7 Arrays mit nicht-primitiven Elementen
		3.6.8 Initialisierte Array-Objekte
		3.6.9 Die erweiterte for-Schleife
		3.6.10 Mehrdimensionale Arrays
		3.6.11 Die Wahrheit über die Array-Initialisierung
		3.6.12 Mehrere Rückgabewerte
		3.6.13 Argument per Referenz übergeben
		3.6.14 Arrays klonen
		3.6.15 Feldinhalte kopieren
		3.6.16 Die Klasse Arrays zum Vergleichen, Füllen, Suchen
		3.6.17 Methode mit variabler Argumentanzahl (vararg)
	3.7 Der Einstiegspunkt für das Laufzeitsystem main()
		3.7.1 Kommandozeilen-Parameter ausgeben
		3.7.2 Der Rückgabewert von main() und System.exit()
		3.7.3 Parser der Kommandozeilenargumente Apache CLI
	3.8 Eigene Pakete schnüren
		3.8.1 Die package-Anweisung
		3.8.2 Importieren von Klassen mit import
		3.8.3 Paketnamen
		3.8.4 Hierarchische Strukturen und das Default-Package
		3.8.5 Klassen mit gleiche Namen in unterschiedlichen Paketen
		3.8.6 Statische Imports
		3.8.7 Eine Verzeichnisstruktur für eigene Projekte

3.4 Die API-Dokumentation

Die wichtigste Informationsquelle für Programmierer ist die API-Dokumentation von Sun. Über unseren Punkt können wir dort entnehmen, dass dieser eine Funktion setLocation() besitzt, eine Variable x und y definiert und einen Konstruktor anbietet, der zwei Ganzzahlen annimmt.

Die Dokumentation muss extra von der Sun-Seite bezogen werden (http://java.sun.com/docs/) und gehört nicht zu einer Standardinstallation einer Laufzeitumgebung dazu. Wer permanente Internetverbindung besitzt, kann die Dokumentation auch online unter http://java.sun.com/j2se/1.5.0/docs/api/index.html lesen.

Die Sun-Dokumentation in der HTML-Form hat einen Nachteil, der sich im Programmieralltag bemerkbar macht: Die Dokumentation lässt sich nur ungenügend durchsuchen, da die Webseiten statisch sind. Wenn wir einfach nach Methoden suchen wollen, die auf »listener« enden, geht das so nicht. Hier kommt die Arbeit des Franzosen Franck Allimant ins Spiel. Er übersetzt regelmäßig die HTML-Dokumentation von Sun in das Windows-Hilfe-Format HTMLHelp und WinHelp. Unter http://www.allimant.org/javadoc/javadoce.html lassen sich die komprimierten Hilfe-Dateien beziehen. Unter anderem liegt auf der Webseite auch die Sprach- und JVM-Spezifikation sowie die API-Dokumentation der Enterprise Edition und der Servlets im Speziellen. Der Screenshot zeigt die Windows-Hilfe.

Hier klicken, um das Bild zu Vergrößern

<< zurück

<top>

vor >>