From 32fcefabb0734b5b012fb706787af82c51dc350b Mon Sep 17 00:00:00 2001
From: 2120940 <2120940@stud.hs-mannheim.de>
Date: Tue, 27 Dec 2022 11:03:00 +0100
Subject: [PATCH] Interfaces initialisiert

---
 .../tpe/exceptions/roboter/RobotControl.java  | 71 ++++++++++++++++++-
 .../exceptions/roboter/RobotInstructions.java | 46 +++++++++++-
 2 files changed, 115 insertions(+), 2 deletions(-)

diff --git a/Roboter/tpe/exceptions/roboter/RobotControl.java b/Roboter/tpe/exceptions/roboter/RobotControl.java
index bde66c3..814f272 100644
--- a/Roboter/tpe/exceptions/roboter/RobotControl.java
+++ b/Roboter/tpe/exceptions/roboter/RobotControl.java
@@ -1,5 +1,74 @@
 package tpe.exceptions.roboter;
 
+import tpe.exceptions.roboter.exceptions.RobotException;
+
+/**
+ * Das Interface repräsentiert einen einfachen Roboter mit seinen Funktionen.
+ *
+ * Jeder produzierte Roboter hat einen Namen, der vom Besteller frei gewählt
+ * werden kann. Der Name bleibt über die gesamte Lebensdauer des Roboters
+ * unveränderlich. Man kann einen Roboter jederzeit über die
+ * <code>getName()</code>-Methode nach seinem Namen fragen.
+ *
+ * Zusätzlich zum frei gewählten Namen, hat jeder Roboter noch eine
+ * Seriennummer. Diese wird bei der Produktion festgelegt und hat einen vom
+ * Roboter-Typ abhängigen Bereich möglicher Werte. Innerhalb des Bereiches wird
+ * die Seriennummer zufällig vergeben. Die Seriennummer kann auch bei
+ * ausgeschalteten Roboter über <code>getId()</code>gelesen werden.
+ *
+ * Ein Roboter hat einen Hauptschalter, der mithilfe der
+ * <code>triggerPowerSwitch()</code>-Methode bedient werden kann. Direkt nach
+ * der Produktion ist der Roboter ausgeschaltet. Drückt man einmal auf den
+ * Schalter, wird er eingeschaltet. Ein weiterer Druck schaltet ihn wieder aus, usw.
+ *
+ * Die aktuelle Position des Hauptschalters kann man mit der Methode
+ * <code>isPowerOn()</code> abfragen. Hierbei bedeutet <code>true</code>, dass
+ * der Roboter eingeschaltet ist und <code>false</code>, dass er nicht
+ * eingeschaltet ist.
+ *
+ * Falls ein Fehler auftritt, kann der Nutzer des Roboters den letzten
+ * aufgetretenen Fehler über eine Blackbox (Fehlerspeicher) auslesen. Dies
+ * geschieht mithilfe der <code>getLastException()</code>-Methode. Der
+ * Fehlerspeicher kann auch bei ausgeschaltetem Roboter benutzt werden. Gab es
+ * noch keinen Fehler, ist der Fehlerspeicher leer (<code>null</code>).
+ *
+ * Alle Methoden dieses Interfaces können auch auf einem Roboter aufgerufen
+ * werden, der ausgeschaltet ist (d.h. wenn <code>isPowerOn()</code> == false).
+ */
 public interface RobotControl {
 
-}
+    /**
+     * Gibt die ID (Seriennummer) des Roboters zurück.
+     *
+     * @return Eine eindeutige Identifikation in Form einer Zahl.
+     */
+    public int getId();
+
+    /**
+     * Gibt den Namen des Roboter-Exemplars zurück.
+     *
+     * @return Der Name des Roboters.
+     */
+    public String getName();
+
+    /**
+     * Betätigen den An-/Ausschaltknopf.
+     */
+    public void triggerPowerSwitch();
+
+    /**
+     * Prüft ob der Roboter eingeschaltet ist.
+     *
+     * @return <code>true</code> bedeutet, dass der Roboter eingeschaltet ist,
+     *      <code>false</code>, dass er nicht eingeschaltet ist.
+     */
+    public boolean isPowerOn();
+
+    /**
+     * Ruft die zuletzt aufgetretene Ausnahme aus der Blackbox ab.
+     *
+     * @return zuletzt aufgetretene Ausnahme oder <code>null</code> falls noch
+     *         keine aufgetreten ist.
+     */
+    public RobotException getLastException();
+}
\ No newline at end of file
diff --git a/Roboter/tpe/exceptions/roboter/RobotInstructions.java b/Roboter/tpe/exceptions/roboter/RobotInstructions.java
index 692e9a5..dd3ccf6 100644
--- a/Roboter/tpe/exceptions/roboter/RobotInstructions.java
+++ b/Roboter/tpe/exceptions/roboter/RobotInstructions.java
@@ -1,5 +1,49 @@
 package tpe.exceptions.roboter;
 
+import tpe.exceptions.roboter.exceptions.RobotException;
+import tpe.exceptions.roboter.exceptions.RobotIllegalStateException;
+import tpe.exceptions.roboter.exceptions.RobotMagicValueException;
+
+/**
+ * Das Interface repräsentiert den Befehlssatz eines einfachen Roboters.
+ *
+ * Jeder Roboter kann zwei grundlegende Operationen durchführen: das Umwandeln
+ * einer Menge von Zahlen in einen String (<code>speak(...)</code>) und das
+ * sortieren eines Arrays von Zahlen (<code>think(...)</code>). Wie genau das
+ * Sortieren oder die Umwandlung erfolgt, hängt vom jeweiligen Typ des Roboters ab.
+ *
+ * Zu beachten ist, dass die Methoden dieses Interfaces nur auf Robotern benutzt
+ * werden können, die eingeschaltet sind. Versucht man sie auf einem
+ * ausgeschalteten Roboter zu benutzen, werfen sie eine {@link RobotIllegalStateException}.
+ *
+ * Weiterhin haben alle Roboter einen kleinen technischen Defekt, der dazu führt
+ * dass die Methoden dieses Interfaces abstürzen, wenn in den Eingabedaten ein
+ * spezieller Wert vorkommt. Immer wenn (<code>speak(...)</code>) oder (
+ * <code>think(...)</code>) mit einem Array aufgerufen werden, das irgendwo die
+ * Zahl {@literal 42} enthält, verweigern sie ihren Dienst und werfen eine
+ * {@link RobotMagicValueException}.
+ */
 public interface RobotInstructions {
 
-}
+    /**
+     * Gibt ein Array von Zahlen als String zurück. Die Zahlen werden
+     * <b>nicht</b> sortiert.
+     *
+     * @param zahlen Zahlen, die ausgegeben werden sollen.
+     * @return Zahlen als String
+     * @throws RobotException wenn der Roboter in einem ungültigen Zustand ist,
+     *             oder das Array nicht seinen Vorstellungen entspricht.
+     */
+    public String speak(int[] zahlen) throws RobotException;
+
+    /**
+     * Sortiert ein Array von Zahlen. Die Reihenfolge hängt von dem Typ des
+     * Roboters ab.
+     *
+     * @param zahlen Zahlen, die sortiert werden sollen.
+     * @return Sortierte Zahlen
+     * @throws RobotException wenn der Roboter in einem ungültigen Zustand ist,
+     *             oder das Array nicht seinen Vorstellungen entspricht.
+     */
+    public int[] think(int[] zahlen) throws RobotException;
+}
\ No newline at end of file