Blatt 07: Torch-Riddle und Katzen-Café (Streams, JUnit, Optional, Visitor)

(1 Punkt)

A07.1: DevDungeon: Fackeln im Sturm (Streams, Optional) (30%)

Klonen Sie das Projekt DevDungeon und laden Sie es in Ihrer IDE als Gradle-Projekt. Betrachten Sie das Sub-Projekt "devDungeon". Dies ist ein von einem Studierenden (@Flamtky) erstelltes Spiel mit mehreren Leveln, in denen Sie spielerisch verschiedene Aufgaben in-game und ex-game lösen müssen.

Starten Sie den DevDungeon mit ./gradlew devDungeon:runDevDungeon. Spielen Sie sich für diese Aufgabe durch das zweite Level ("Torch Riddle")1.

Sie befinden sich in einem Raum mit Fackeln, welche Sie per Interaktion an- und ausschalten können. Neben jeder Fackel ist ein Briefkasten, der der Fackel einen Zahlenwert zuordnet. Irgendwo führt eine Tür zu einem zunächst versteckten Raum mit einer Belohnung - aber diese Tür geht erst auf, wenn Sie (a) die richtigen Fackeln an- bzw. ausgeschaltet haben, und wenn Sie (b) die defekte Methode TorchRiddleRiddleHandler#getSumOfLitTorches (im Package level.devlevel.riddleHandler) korrekt implementiert haben. Beachten Sie die entsprechenden Hinweise im Javadoc der Methode.

Das Tor zum nächsten Level geht unabhängig davon erst auf, wenn Sie den Boss-Gegner2 in diesem Level besiegt haben ... Hierzu ist keine Programmierung notwendig, lediglich geschicktes Spielen und gegebenenfalls rechtzeitiges Trinken von (dann hoffentlich vorhandenen) Heil-Tränken.

Hinweis: Aktuell ist das Projekt DevDungeon an einigen Stellen noch Work-in-Progress, beispielsweise fehlt häufig noch die Javadoc. Alle Gradle-Tasks, die von Checkstyle-Tasks abhängen (checkstyleMain, check, build, ...) werden deshalb fehlschlagen. Sie können den DevDungeon aber wie oben beschrieben mit ./gradlew devDungeon:runDevDungeon (bzw. über den Task devDungeon:runDevDungeon aus der IDE heraus) starten.

WICHTIG: Achten Sie bitte darauf, dass im Projektpfad keine Leerzeichen und keine Sonderzeichen (Umlaute o.ä.) vorkommen! Dies kann zu seltsamen Fehler führen. Bitte auch darauf achten, dass Sie als JDK ein Java SE 21 (LTS) verwenden.

Katzen-Café

Forken Sie das "Cat-Cafe"-Repo und erzeugen Sie sich eine lokale Arbeitskopie von Ihrem Fork.

Bearbeiten Sie die folgenden Teilaufgaben jeweils in einem eigenen Branch. Pushen Sie Ihre Änderungen in Ihren Fork zurück und erstellen Sie dort je einen Pull-Request auf Ihren eigenen master-Branch.

Bitte lassen Sie die Pull-Requests bis zur Vorstellung im Praktikum offen.

Achten Sie darauf, alle Schritte nachvollziehbar in Ihrer Arbeitskopie per Git-Commit festzuhalten. Demonstrieren Sie im Praktikum, wie Sie mit den Pull-Requests arbeiten.

Ihr Code soll einheitlich formatiert und dokumentiert sein. Sie können beides prüfen: ./gradlew spotlessCheck für die Formatierung und ./gradlew checkstyleMain für die Dokumentation3 mit Javadoc.4 Während Sie die Dokumentation bei Fehlern manuell anpassen müssen (siehe Lektion “Javadoc”), können Sie mit ./gradlew spotlessApply den Code automatisch formatieren lassen - tun Sie das am besten vor jedem Commit.

A07.2: Code-Analyse (10%)

Analysieren Sie die Modellierung des Binärbaums (Tree, Empty, Node) und erklären Sie die Funktionsweise:

  • Was sind Vorteile, was sind Nachteile dieser Modellierung?
  • Was musste getan werden, um die selbst implementierten Bäume in Schleifen (Tree<X> mytree; for (Tree<X> t: mytree) {...}) und in Streams Tree<X> mytree; mytree.stream(). ... nutzen zu können?
  • Wie funktioniert der TreeIterator?

A07.3: Optional (10%)

Bauen Sie die beiden Methoden CatCafe#getCatByName und CatCafe#getCatByWeight so um, dass ein passendes Optional zurückgeliefert wird. Passen Sie die entsprechenden Methodenaufrufe in Main#main entsprechend an.

In der Klasse CatCafe in der Vorgabe fehlen die Javadoc-Kommentare. Korrigieren Sie dies und ergänzen Sie hier die fehlenden Javadoc-Kommentare.

Tipp: Stellen Sie in den beiden Methoden auf die Java-Stream-API um, dann ergibt sich die Nutzung von Optional fast von selbst.

A07.4: JUnit (30%)

Erstellen Sie mit JUnit 4 oder 5 mindestens 10 unterschiedliche Testfälle für die Klasse CatCafe. Dokumentieren Sie Ihre Testfälle mit Javadoc.

Tipp: In der Gradle-Konfiguration der Vorgabe ist bereits JUnit5 konfiguriert, d.h. die entsprechenden Abhängigkeiten werden durch Gradle aufgelöst. Wenn Sie die Vorgaben als Gradle-Projekt in Ihrer IDE öffnen, dann steht Ihnen dort auch die JUnit5-Bibliothek automatisch zur Verfügung. Wenn Sie JUnit4 nutzen möchten, müssten Sie bitte die Gradle-Konfiguration entsprechend anpassen. Mit ./gradlew test können Sie entsprechende Testfälle ausführen.

A07.5: Visitor-Pattern (20%)

Die Klasse CatCafe hat eine Methode CatCafe#accept, die einen Visitor mit dem parametrischen Typ TreeVisitor an das intern genutzte Feld Tree<FelineOverLord> clowder weiterleitet.

Implementieren Sie das Visitor-Pattern für den Baum (Tree), indem Sie das Interface TreeVisitor implementieren:

  1. Erstellen Sie einen konkreten Visitor InOrderVisitor, der den Baum inorder traversiert.
  2. Erstellen Sie einen weiteren konkreten Visitor PostOrderVisitor, der den Baum postorder traversiert.

Beim Besuch eines Knotens soll jeweils die Methode toString() für den Datenanteil aufgerufen werden und passend mit den Ergebnissen der Traversierung der linken und rechten Teilbäume konkateniert werden und der resultierende String zurückgeben werden.

Fügen Sie passende Aufrufe der beiden Visitoren in Main#main hinzu.

  1. Das zweite richtige Level, also das zweite Level nach dem Demo-Level. Oder eben das dritte Level, wenn man das Demo-Level mitzählt :-) ↩︎

  2. ... sieht aus wie eine wandelnde Kerze ... ↩︎

  3. zumindest für den syntaktischen Aspekt ... ↩︎

  4. Sie können auch beides zusammen per ./gradlew check prüfen lassen. ↩︎