Beschreibung einer Klasse

Die Dokumentation beschreibt die Daten (Objektvariablen) und Methoden, die in Point-Objekten enthalten sind. Ebenso wie die Konstruktormethoden, die solche Objekte erzeugen. Objektvariablen werden manchmal auch als Felder bezeichnet (wie hier). Die zwei Objektvariablen haben den Namen x und y und sind vom Typ int.

Beide Objektvariablen haben den Zugriffsmodifizier public. Das bedeutet der direkte Zugriff auf diese Objektvariablen ist explizit erlaubt.

Die Java Dokumentation beschreibt die Klasse Point. Hier befinden sich die Beschreibungen der einzelnen Klassen. Die Dokumentation für Point befindet sich im Modul java.desktop und dort im Paket (Package) java.awt. Um die Dokumentation zu sehen, gebt Ihr in einer Suchmaschine z.B. "java api 21" ein. (API ist die Abkürzung für Application Programming Interface) und klickt dann auf einen Link wie Overview (Java SE 21 & JDK 21) - Oracle Help Center. Gebt dann im Suchfenster oben rechts "point" ein. Dort werden wir ungefähr folgendes sehen:

Hinweis: Das die Objektvariablen x und y public sind, seht Ihr erst, wenn Ihr in der Dokumentation der Klasse Point nach unten scrollt unter Field Details.

public class java.awt.Point

// Felder
int x;
int y;

// Konstruktoren
Point();                 // erzeugt ein Point-Objekt bei (0,0)
Point(int  x, int  y);   // erzeugt ein Point-Objekt bei (x,y)
Point( Point pt );       // erzeugt ein Point-Objekt an der Stelle von pt

// Methoden
boolean equals(Object  obj);  // Überprüft, ob zwei Point-Objekte
                              // äquivalente Daten enthalten.
void move(int  x, int  y);    // Ändert die (x,y) Daten eines Point-Objekts.
String toString();            // Gibt Character-Daten zurück,
                              // die ausgegeben werden können.

(Methoden, die wir nicht verwenden, wurden ausgelassen.)

Die Dokumentation zeigt

• die Daten (Variablen), die ein Objekt dieser Klasse enthält;
• die Methoden, die verwendet werden, um diese Daten zu manipulieren, und
• die Konstruktoren, die verwendet werden, um ein Objekt der Klasse zu erzeugen:

Manchmal (wie hier) werden die Variablen auch als Felder bezeichnet. Die zwei Variablen werden x und y genannt und sind vom Typ int.