Kapitel: Methodendesign

• Fokus: Benutzerfreundlichkeit, Robustheit und Flexibilität im Methodendesign.
• Abdeckung: Parameter- und Rückgabewertbehandlung, Methodensignaturdesign und Dokumentation.

Punkt 49: Parametergültigkeit prüfen

– Einschränkungen für Parameter:
Methoden und Konstruktoren unterliegen im Allgemeinen Einschränkungen hinsichtlich der Parameterwerte (z. B. nicht negative Indizes, Nicht-Null-Referenzen).
Diese Einschränkungen müssen zu Beginn der Methode dokumentiert und überprüft werden.

– Bedeutung der Verifizierung:
Erkennen Sie Fehler so früh wie möglich, um unerwartete Ausfälle oder Fehlverhalten der Methode zu vermeiden.
Methoden, die ihre Parameter nicht überprüfen, können schwer zu debuggende Abstürze verursachen.

- Ausnahmedokumentation:
Verwenden Sie das Javadoc-Tag @throws, um Ausnahmen zu dokumentieren, die bei Verstößen gegen Einschränkungen ausgelöst werden.
Häufige Ausnahmen: IllegalArgumentException, IndexOutOfBoundsException, NullPointerException.

Beispiel für Parameterprüfung:

public static int mod(int x, int y) {
    if (y 



- Verwendung von Objekten.requireNonNull:

Es wurde in Java 7 eingeführt und dient zur Überprüfung der NULL-Zulässigkeit von Objekten.

Gibt den nach der Überprüfung übergebenen Wert zurück: 



this.m = Objects.requireNonNull(m, "Parâmetro 'm' não pode ser nulo");





 – Bereichsprüfung (Java 9):

checkFromIndexSize-, checkFromToIndex- und checkIndex-Methoden zum Überprüfen von Indizes in Listen und Arrays.

Weniger flexibel, wird hauptsächlich für Sammlungen verwendet.

**

• Parameterprüfung in nicht öffentlichen Methoden:** Verwenden Sie für nicht exportierte Methoden Assertionen, um Parameter zu überprüfen:

assert x > 0 : "Valor de x deve ser positivo";

- Sonderfälle:
Entwickler sollten immer die Gültigkeit der gespeicherten Parameter für die spätere Verwendung überprüfen.
Ausnahmen können für kostspielige Prüfungen gemacht werden, bei denen die Prüfung implizit in die Berechnung einbezogen wird.

– Beispiel für implizite Überprüfung:
Collections.sort(List) geht davon aus, dass Objekte untereinander vergleichbar sind. Die Überprüfung erfolgt während des Sortiervorgangs.

- Übersetzung von Ausnahmen:
Wenn die implizite Prüfung die falsche Ausnahme auslöst, verwenden Sie „Ausnahmeübersetzung“, um die richtige Ausnahme auszulösen.

- Flexibilität bei Einschränkungen:
Methoden sollten so allgemein wie möglich gestaltet sein und so wenig Einschränkungen wie nötig auferlegen.

- Abschluss:
Dokumentieren und implementieren Sie Parametergültigkeitsprüfungen für Methoden und Konstruktoren. Übung ist wichtig, um zukünftige Fehler zu vermeiden und das Debuggen zu erleichtern.