Programmieren nach API Info?!

[java__neuling]

Hallo leibe Programmiergemeinde... ;-),

ist zwar schon wieder etwas her als ich das letze mal ein topic eröffnet habe aber immer wenn es neue
themen gibt "muss" (bzw. gott sei dank kann ich das hier) ich mich hier erkundigen wie es funktioniert.

ich habe hier den auszug aus einer api: (schreibe das jetzt einfach mal in javacode...ist so übersichtlicher)

ausgabe

public static boolean ausgabe(Form2dModell dieform)
                       throws java.lang.NullPointerException

    Die Methode "ausgabe" gibt die Daten einer Instanz eines Form2dModell auf der Systemkonsole aus. Wenn das Form2dModell nicht initialisiert ist, so wird eine NullPointerException geworfen. Etwaige auftretende Ein und Ausgabe-Ausnahmen werden intern abgehandelt.

    Parameters:
        dieform - - ein Objekt einer Klasse, die die Klasse "Form2dModell" erweitert. 
    Returns:
        false - wenn nichts ausgebeben werden kann 
    Throws:
        java.lang.NullPointerException - - wenn an "dieform" kein Objekt gebunden ist.

also eigentlich klingt das ja gar nicht sooo schwierig aber irgendwie habe ich zur zeit keine ahnung was ich machen muss.

gut, wenn die methode aufgerufen wird, wird irgendetwas ausgebebn.
sollte nichts zum ausgeben vorhanden sein gibt es ein "return false;". oder?

und wenn an die form "dieform" kein objekt gebunden ist dann wird eine nullpointer exception geworfen.
wahrscheinlich gibt es dort dann eine art if abfrage....aber worauf prüft die ??
if(dieform==leer) ??

eventuell könnt ihr mir weiterhelfen? oder braucht ihr weitere infos!

danke und gruß
java__neuling!

 

[Haave]

und wenn an die form "dieform" kein objekt gebunden ist dann wird eine nullpointer exception geworfen.
wahrscheinlich gibt es dort dann eine art if abfrage....aber worauf prüft die ??
if(dieform==leer) ??

Vermutung:

if(dieform == null) throw new NullPointerException();

 

[java__neuling]

erstmal vielen dank!

sonst niemand eine idee? :shock:

Danke!

 

[Haave]

So eine API-Dokumentation ist eigentlich dazu gedacht, dass man als Anwender der API nicht wissen braucht, wie eine Klasse oder Methode intern implementiert ist. Deshalb sollte es eigentlich keine Rolle spielen, was da nun bei ausgabe() im Code selbst steht, denn man will die Methode ja nur anwenden.

Aber was ist jetzt deine Frage? Musst du diese Dokumentation erläutern oder die Methode irgendwo verwenden und weißt nicht, wie, oder worum geht es?

 

[tuxedo]

Wo ist das Problem ???:L

Selbst wenn man keinen Plan hat was die Methode genau macht: So viel Inputmöglichkeiten scheint es nicht zu geben:

Möglichkeit 1: dieform == null
Möglichkeit 2: dieform != null

Also beides zur Not einfach ausprobieren und schauen was passiert.

Aber mal davon abgesehen: Die Doku zu der Methode ist doch sehr eindeutig -mal abgesehen von der etwas seltsamen Formulierung "wenn an "dieform" kein Objekt gebunden ist":

Die Methode "ausgabe" gibt die Daten einer Instanz eines Form2dModell auf der Systemkonsole aus.

Gut. Ich geb was rein und ich bekomm dafür eine Ausgabe auf der Konsole. Einleuchtend.

Wenn das Form2dModell nicht initialisiert ist, so wird eine NullPointerException geworfen

Okay, "nicht initialisiert" ist etwas schwammig formuliert. Könnte auch bedeuten dass es zwar eine tatsächliche Objektinstanz ist, aber deren Instantzvariablen noch nicth gesetzt sind.
Da es hier aber um das werfen einer NullPointerException geht, ist davon auszugehen, dass die NPE geworfen wird, wenn das Argument der Methode "ausgabe" selbst null ist.

Etwaige auftretende Ein und Ausgabe-Ausnahmen werden intern abgehandelt.

Heisst so viel wie: Um alles andere muss ich mir keine sorgen machen. Entweder es funktioniert wie erwartet, oder es funktioniert nicht. Aber dann geht auch nix kaputt.

Returns:
false - wenn nichts ausgebeben werden kann

Wenn also alles klappt, dann kommt hier ein true zurück. Wenn "Etwaige auftretende Ein und Ausgabe-Ausnahmen" auftreten, dann wird unter Umständen nichts ausgegeben und es kommt ein false zurück.

Throws:
java.lang.NullPointerException - - wenn an "dieform" kein Objekt gebunden ist.

Okay, hatten wir ja schon. Nur dieses mal etwas präziser und bestätigt auch die obige Annahme dass das oObjekt selbst null ist, und nicht nur dessen Instanzvariablen.