API Dokumentation (Java)

Aus Byte-Welt Wiki
Wechseln zu: Navigation, Suche

Das Java Runtime Environment (kurz JRE) bietet viele tausend Klassen, und nochmehr Methoden. Es ist nur schwer möglich, den Überblick über so viele Informationen zu behalten, wenn man nur den Quellcode zur Verfügung hat.

Deshalb wurde die "API Dokumentation" geschrieben.

Die API Dokumentation, kurz API-Doc (manchmal auch nur API), kann man bei Oracle herunterladen. Für die aktuelle Java-Version gibt es immer auch auch eine Onlineversion der Java-API Dokumentation.

Aufbau der API Dokumentation

API-Doc in a window

Die API-Doc besteht aus 3 Fenstern:

  • Oben links sind sämtliche Packages aufgeführt
  • Unten links sind die Klassen des aktuell gewählten Packages aufgelistet
  • Rechts ist ein Multifunktionsfenster

Zusätzlich gibt es einige Demonstrationen und Tutorials in der API Dokumentation zu finden.

Das Multifunktionsfenster

Das Fenster auf der rechten Seite der API-Doc hat 8 Funktionen, welche in den Leisten oben und unten ausgewählt werden können. Die Funktionen sind:

Overview

Eine Liste aller verfübgarer Packages. Auf der linken Seite der Tabelle befindet sich der Name des Packages, rechts eine Beschreibung, für was die Klassen des Packages verwendet werden.

Package

Eine Liste aller Elemente welche in einem Package sind. Für jedes Element gibt es eine kurze Beschreibung, wofür es verwendet wird. Elemente können Interfaces, Klassen, Exceptions, Errors, Enumerationen oder Annotations sein.

=Class

Diese Ansicht wird verwendet um Elemente eines Packages genauer zu beschreiben. Hauptsächlich sind dies Klassen, aber auch Interfaces, Enumerationen o.ä. wird hier angezeigt.

Diese Ansicht besteht aus 3 Sektionen:

  • Beschreibung: Eine Beschreibung des aktuellen Elementes. Dies beinhaltet die Vererbungshierarchie und einen längeren Text.
  • Zusammenfassung: Eine Liste aller inneren Klassen, Variablen, Konstruktoren und Methoden.
  • Details: Für jeden Eintrag in der Zusammenfassung gibt es noch eine detailierte Beschreibung.

Use

Use zeigt an, wo ein Element (Klasse, Interface, Enumeration, etc.) benutzt wird. Sortiert nach Packages wird gezeigt, wer von dem Element erbt, wer das Element als Variable benutzt, wo das Element als Argument oder Rückgabewert einer Methode vorkommt, etc.

Tree

Hier wird die komplette Vererbungshierarchie entweder aller Klassen überhaupt, oder aller Klasen eines Packages, angezeigt.

Deprecated

Eine Liste aller Klassen, Interfaces, Methoden, etc. welche Deprecated (veraltet) sind.

Index

Index ist eine alphabetische Liste aller Elemente welche in der API Dokumentation gefunden werden können.

Help

Eine Hilfe welche dasselbe erzählt, was auch auf dieser Page steht.