Wie dieses API-Dokument organisiert ist

Dieses API-Dokument (Application Programming Interface) enthält Seiten, die den Elementen in der Navigationsleiste entsprechen und wie folgt beschrieben werden.

Übersicht

Die Seite Übersicht ist die Titelseite dieses API-Dokuments und bietet eine Liste aller Pakete mit einer Zusammenfassung für jedes. Diese Seite kann auch eine allgemeine Beschreibung der Paketmenge enthalten.

Paket

Jedes Paket hat eine Seite, die eine Liste seiner Klassen und Schnittstellen mit einer Zusammenfassung für jedes enthält. Diese Seiten können sechs Kategorien enthalten:

• Interfaces
• Klassen
• Enums
• Ausnahmen
• Fehler
• Annotationstypen

Klasse oder Schnittstelle

Jede Klasse, Schnittstelle, verschachtelte Klasse und verschachtelte Schnittstelle hat ihre eigene separate Seite. Jede dieser Seiten besteht aus drei Abschnitten: einer Klassen-/Schnittstellenbeschreibung, Zusammenfassungstabellen und detaillierten Mitgliederbeschreibungen.

• Klassenvererbungdiagramm
• Direkte Unterklassen
• Alle bekannten Unter-Schnittstellen
• Alle bekannten implementierenden Klassen
• Klassen- oder Schnittstellendeklaration
• Klassen- oder Schnittstellenbeschreibung

• Zusammenfassung der verschachtelten Klassen
• Zusammenfassung der Felder
• Eigenschaftszusammenfassung
• Konstruktorübersicht
• Zusammenfassung der Methoden

• Detail der Felder
• Eigenschaftendetails
• Konstruktor-Detail
• Detail der Methoden

Jeder Zusammenfassungseintrag enthält den ersten Satz aus der detaillierten Beschreibung für dieses Element. Die Zusammenfassungseinträge sind alphabetisch sortiert, während die detaillierten Beschreibungen in der Reihenfolge erscheinen, in der sie im Quellcode auftreten. Dies bewahrt die vom Programmierer festgelegten logischen Gruppierungen.

Annotationstyp

Jeder Annotationstyp hat eine eigene separate Seite mit folgenden Abschnitten:

• Annotationstyp-Deklaration
• Annotationstyp-Beschreibung
• Zusammenfassung der erforderlichen Elemente
• Zusammenfassung der optionalen Elemente
• Elementdetails

Aufzählung

Jede Aufzählung hat eine eigene separate Seite mit folgenden Abschnitten:

• Aufzählung-Deklaration
• Aufzählung-Beschreibung
• Zusammenfassung der Enum-Konstanten
• Detail der Enum-Konstanten

Baumstruktur (Klassen-Hierarchie)

Es gibt eine Seite Klassen-Hierarchie für alle Pakete, plus eine Hierarchie für jedes Paket. Jede Hierarchie-Seite enthält eine Liste von Klassen und eine Liste von Schnittstellen. Klassen sind nach ihrer Vererbungsstruktur organisiert, beginnend mit java.lang.Object. Schnittstellen erben nicht von java.lang.Object.

• Wenn die Seite "Übersicht" angezeigt wird, zeigt ein Klick auf "Baumstruktur" die Hierarchie für alle Pakete an.
• Wenn eine bestimmte Paket-, Klassen- oder Schnittstellenseite angezeigt wird, zeigt ein Klick auf "Baumstruktur" die Hierarchie nur für dieses Paket an.

Veraltete API

Die Seite Veraltete API listet alle APIs auf, die als veraltet markiert wurden. Eine veraltete API wird nicht zur Verwendung empfohlen, im Allgemeinen aufgrund von Verbesserungen, und es wird normalerweise eine Ersatz-API angegeben. Veraltete APIs können in zukünftigen Implementierungen entfernt werden.

Index

Der Index enthält einen alphabetischen Index aller Klassen, Schnittstellen, Konstruktoren, Methoden und Felder sowie Listen aller Pakete und aller Klassen.

Alle Klassen

Der Link Alle Klassen zeigt alle Klassen und Schnittstellen außer nicht-statischen verschachtelten Typen an.

Serialisierte Form

Jede serialisierbare oder externalisierbare Klasse enthält eine Beschreibung ihrer Serialisierungsfelder und -methoden. Diese Informationen sind für Re-Implementierer interessant, nicht für Entwickler, die die API verwenden. Obwohl es keinen Link in der Navigationsleiste gibt, können Sie auf diese Informationen zugreifen, indem Sie zu einer beliebigen serialisierten Klasse gehen und in der "Siehe auch"-Sektion der Klassenbeschreibung auf "Serialisierte Form" klicken.

Konstante Feldwerte

Die Seite Konstantenfeldwerte listet die statischen finalen Felder und ihre Werte auf.

Suche

Sie können nach Definitionen von Modulen, Paketen, Typen, Feldern, Methoden und anderen in der API definierten Begriffen suchen, indem Sie einen Teil oder den gesamten Namen verwenden. "Camel-case"-Abkürzungen werden unterstützt: z.B. findet "InpStr" "InputStream" und "InputStreamReader".

Diese Hilfedatei gilt für API-Dokumentationen, die vom Standard-Doclet generiert wurden.