„README.md“ ändern

README.md

@@ -1,2 +1,6 @@
 # Robbie-Management-System
 
+Teammitglieder:
+
+1) Nico Piehl (2211320)
+2) Cedric Bienert (2210800)

Robbie-Management-System/.classpath

@@ -6,5 +6,6 @@
 		</attributes>
 	</classpathentry>
 	<classpathentry kind="src" path="src"/>
+	<classpathentry kind="con" path="org.eclipse.jdt.junit.JUNIT_CONTAINER/5"/>
 	<classpathentry kind="output" path="bin"/>
 </classpath>

Robbie-Management-System/Readme

@@ -0,0 +1,4 @@
+Teammitglieder:
+
+1) Nico Piehl (2211320)
+2) Cedric Bienert (2210800)

Robbie-Management-System/src/domain/C3PO.java

@@ -5,26 +5,52 @@ import exceptions.RobotIllegalStateException;
 import exceptions.RobotMagicValueException;
 import roboterSystem.Robot;
 
+/**
+ * Die Klasse repräsentiert das C3PO Modell.
+ *
+ * Der Roboter hat einen Konstruktor <code>C3PO(...)</code> welcher einen Namen, 
+ * eine iD und einen Zähler besitzt der die iD erhöht.
+ * 
+ * <code>think(...)</code> lässt den Roboter ein int Array absteigend sortieren
+ * und dann zurückgeben.
+ */
 public class C3PO extends Robotermodell implements Robot {
 	
-	private int zähler = 10000;
+	/**
+	 * Der Zähler repräsentiert die iD.
+	 */
+	private static int zähler = 10000;
 
+    /**
+     * Der Konstruktor des C3PO Roboters besitzt einen Namen, eine iD
+     * und einen Zähler.
+     * 
+     * @param String name der den Namen des Roboters repräsentiert.
+     */
 	public C3PO(String name) {
 		setName(name);
 		setiD(zähler);
 		zähler++;
 	}
 
+    /**
+     * Sortiert ein Array von Zahlen. Die Reihenfolge verläuft absteigend.
+     *
+     * @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.
+     */
 	@Override
 	public int[] think(int[] zahlen) throws RobotException {
 		try {
 			if (this.isPowerOn() == false) {
-				throw new RobotIllegalStateException();
+				throw new RobotIllegalStateException(this.getName());
 			}
 			
 			for (int i = 0; i < zahlen.length; i++) {
 				if (zahlen[i] == 42) {
-					throw new RobotMagicValueException();
+					throw new RobotMagicValueException(this.getName());
 				}
 			}
 			for (int i = 0; i < zahlen.length - 1; i++) {

Robbie-Management-System/src/domain/C3POTest.java

@@ -50,13 +50,13 @@ class C3POTest {
 		C3PO c = new C3PO("Test");
 		int[] zahlen = {42,4,3,1,6,5};
 		c.think(zahlen);
-		assertEquals("exceptions.RobotMagicValueException: Zahl 42 kommt vor - Roboter: \"Ihhhhh\"!", c.getLastException().toString());
+		assertEquals("exceptions.RobotMagicValueException: Test: Zahl 42 kommt vor - Roboter: \"Ihhhhh\"!", c.getLastException().toString());
 		c.speak(zahlen);
-		assertEquals("exceptions.RobotMagicValueException: Zahl 42 kommt vor - Roboter: \"Ihhhhh\"!", c.getLastException().toString());
+		assertEquals("exceptions.RobotMagicValueException: Test: Zahl 42 kommt vor - Roboter: \"Ihhhhh\"!", c.getLastException().toString());
 		c.triggerPowerSwitch();
 		c.think(zahlen);
-		assertEquals("exceptions.RobotIllegalStateException: Leider ist der Roboter aus und kann nichts machen!", c.getLastException().toString());
+		assertEquals("exceptions.RobotIllegalStateException: Test: Leider ist der Roboter aus und kann nichts machen!", c.getLastException().toString());
 		c.speak(zahlen);
-		assertEquals("exceptions.RobotIllegalStateException: Leider ist der Roboter aus und kann nichts machen!", c.getLastException().toString());
+		assertEquals("exceptions.RobotIllegalStateException: Test: Leider ist der Roboter aus und kann nichts machen!", c.getLastException().toString());
 	}
 }

Robbie-Management-System/src/domain/Nexus6.java

@@ -4,29 +4,69 @@ import exceptions.RobotException;
 import exceptions.RobotIllegalStateException;
 import roboterSystem.Robot;
 
+/**
+ * Die Klasse repräsentiert das Nexus6 Modell.
+ *
+ * Der Roboter hat einen privaten Konstruktor <code>Nexus6()</code> welcher einen 
+ * festen Namen, eine feste iD hat und der Roboter ist ausgestellt.
+ * 
+ * Damit auf den Singleton Roboter zugegriffen werden kann wird <code>getInstance()</code>
+ * diesen spezifischen Roboter zurückgeben.
+ * 
+ * Der Roboter ist immer ausgestellt, daher macht <code>triggerPowerSwitch()</code>
+ * nichts.
+ * 
+ * <code>think(...)</code> lässt den Roboter Exceptions werfen, macht allerdings
+ * nichts anderes.
+ */
 public class Nexus6 extends Robotermodell implements Robot {
+	
+	/**
+	 * Die private final Nexus6 Variable erzeugt immer einen Nexus6 Roboter 
+	 * und verhindert die erneute Erzeugung eines weiteren Nuxus6 Roboters.
+	 */
 	private static final Nexus6 NEXUS6 = new Nexus6();
 	
+    /**
+     * Der Konstruktor des Nexus6 Roboters besitzt einen Namen, eine iD
+     * und seine Power ist immer aus.
+     */
 	private Nexus6() {
 		setName("Pris");
 		setiD(19281982);
 		power = false;
 	}
 	
+    /**
+     * Gibt die einzige Instanz des Roboters zurück.
+     *
+     * @return Eine eindeutige Identifikation in Form des Objekts.
+     */
 	public static Nexus6 getInstance() {
 		return NEXUS6;
 	}
 	
+    /**
+     * Power ändern machts nichts, da der Roboter immer aus ist.
+     */
 	@Override
 	public void triggerPowerSwitch() {
 		//bleibt ausgeschaltet
 	}
 	
+    /**
+     * Macht rein gar nichts, außer die Exception zu werfen
+     *
+     * @param zahlen Zahlen, die in einer anderen Zeitlinie sortiert werden sollten.
+     * @return null, da nichts gemacht wird
+     * @throws RobotException wenn der Roboter in einem ungültigen Zustand ist,
+     *             oder das Array nicht seinen Vorstellungen entspricht.
+     */
 	@Override
 	public int[] think(int[] zahlen) throws RobotException {
 		try {
 			if (this.isPowerOn() == false) {
-				throw new RobotIllegalStateException();
+				throw new RobotIllegalStateException(this.getName());
 			}
 		} catch (RobotIllegalStateException rise) {
 			letzteException = rise;

Robbie-Management-System/src/domain/R2D2.java

@@ -5,26 +5,52 @@ import exceptions.RobotIllegalStateException;
 import exceptions.RobotMagicValueException;
 import roboterSystem.Robot;
 
+/**
+ * Die Klasse repräsentiert das R2D2 Modell.
+ *
+ * Der Roboter hat einen Konstruktor <code>R2D2(...)</code> welcher einen Namen, 
+ * eine iD und einen Zähler besitzt der die iD erhöht.
+ * 
+ * <code>think(...)</code> lässt den Roboter ein int Array aufsteigend sortieren
+ * und dann zurückgeben.
+ */
 public class R2D2 extends Robotermodell implements Robot {
 
-	private int zähler = 0;
+	/**
+	 * Der Zähler repräsentiert die iD.
+	 */
+	private static int zähler = 0;
 	
+    /**
+     * Der Konstruktor des R2D2 Roboters besitzt einen Namen, eine iD
+     * und einen Zähler.
+     * 
+     * @param String name der den Namen des Roboters repräsentiert.
+     */
 	public R2D2(String name) {
 		setName(name);
 		setiD(zähler);
 		zähler++;
 	}
 
+    /**
+     * Sortiert ein Array von Zahlen. Die Reihenfolge verläuft aufsteigend.
+     *
+     * @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.
+     */
 	@Override
 	public int[] think(int[] zahlen) throws RobotException {
 		try {
 			if (this.isPowerOn() == false) {
-				throw new RobotIllegalStateException();
+				throw new RobotIllegalStateException(this.getName());
 			}
 			
 			for (int i = 0; i < zahlen.length; i++) {
 				if (zahlen[i] == 42) {
-					throw new RobotMagicValueException();
+					throw new RobotMagicValueException(this.getName());
 				}
 			}
 			

Robbie-Management-System/src/domain/R2D2Test.java

@@ -50,13 +50,13 @@ class R2D2Test {
 		R2D2 r = new R2D2("Test");
 		int[] zahlen = {42,4,3,1,6,5};
 		r.think(zahlen);
-		assertEquals("exceptions.RobotMagicValueException: Zahl 42 kommt vor - Roboter: \"Ihhhhh\"!", r.getLastException().toString());
+		assertEquals("exceptions.RobotMagicValueException: Test: Zahl 42 kommt vor - Roboter: \"Ihhhhh\"!", r.getLastException().toString());
 		r.speak(zahlen);
-		assertEquals("exceptions.RobotMagicValueException: Zahl 42 kommt vor - Roboter: \"Ihhhhh\"!", r.getLastException().toString());
+		assertEquals("exceptions.RobotMagicValueException: Test: Zahl 42 kommt vor - Roboter: \"Ihhhhh\"!", r.getLastException().toString());
 		r.triggerPowerSwitch();
 		r.think(zahlen);
-		assertEquals("exceptions.RobotIllegalStateException: Leider ist der Roboter aus und kann nichts machen!", r.getLastException().toString());
+		assertEquals("exceptions.RobotIllegalStateException: Test: Leider ist der Roboter aus und kann nichts machen!", r.getLastException().toString());
 		r.speak(zahlen);
-		assertEquals("exceptions.RobotIllegalStateException: Leider ist der Roboter aus und kann nichts machen!", r.getLastException().toString());
+		assertEquals("exceptions.RobotIllegalStateException: Test: Leider ist der Roboter aus und kann nichts machen!", r.getLastException().toString());
 	}
 }

Robbie-Management-System/src/domain/RobotType.java

@@ -1,5 +1,10 @@
 package domain;
 
+/**
+ * Die Klasse repräsentiert alle Roboter Modelle die existieren.
+ *
+ * Die Roboter können vom Modell C3PO, R2D2 oder NEXUS6 sein.
+ */
 public enum RobotType {
 	C3PO, R2D2, NEXUS6;
 }

Robbie-Management-System/src/domain/Robotermodell.java

@@ -56,12 +56,12 @@ public abstract class Robotermodell implements Robot {
 		
 		try {
 			if (this.isPowerOn() == false) {
-				throw new RobotIllegalStateException();
+				throw new RobotIllegalStateException(name);
 			}
 			
 			for (int i = 0; i < zahlen.length; i++) {
 				if (zahlen[i] == 42) {
-					throw new RobotMagicValueException();
+					throw new RobotMagicValueException(name);
 				}
 			}
 			
@@ -73,7 +73,7 @@ public abstract class Robotermodell implements Robot {
 				hilfszeichen = ",";
 			} else {
 				//wird beim Nexus6 geworfen
-				throw new RobotIllegalStateException();
+				throw new RobotIllegalStateException(name);
 			}
 			
 			Arrays.stream(zahlen)

Robbie-Management-System/src/exceptions/RobotException.java

@@ -1,11 +1,28 @@
 package exceptions;
 
+/**
+ * Die Klasse repräsentiert die Exceptions der Roboter.
+ *
+ * Der Roboter hat einen Konstruktor <code>RobotException()</code> welcher nichts macht.
+ * 
+ * Der Roboter hat einen weiteren Konstruktor <code>RobotException(...)</code> welcher
+ * einen String übergeben bekommt und diesen an seine Superklasse übergibt.
+ */
 public class RobotException extends Exception{
 
+	/**
+	 * Der Konstruktor macht nichts.
+	 */
 	public RobotException() {
 		
 	}
 	
+	/**
+	 * Der Konstruktor bekommt einen String übergeben und gibt diesen an
+	 * seine Superklasse weiter.
+	 * 
+     * @param String fehlertext repräsentiert den Text den die Exception wirft.
+	 */
 	public RobotException(String fehlertext) {
 		super(fehlertext);
 	}

Robbie-Management-System/src/exceptions/RobotIllegalStateException.java

@@ -1,12 +1,32 @@
 package exceptions;
 
+/**
+ * Die Klasse repräsentiert die RobotIllegalStateException der Roboter.
+ *
+ * Der Roboter hat einen Konstruktor <code>RobotException()</code> welcher einen
+ * Fehlertext an seine Superklasse übergibt.
+ * 
+ * Der Roboter hat einen weiteren Konstruktor <code>RobotException(...)</code> welcher
+ * einen String übergeben bekommt und diesen an seine Superklasse übergibt.
+ */
 public class RobotIllegalStateException extends RobotException{
 
+	/**
+	 * Der Konstruktor erzeugt einen Fehlertext und übergibt diesen an
+	 * seine Superkalsse.
+	 */
 	public RobotIllegalStateException() {
 		super("Leider ist der Roboter aus und kann nichts machen!");
 	}
 	
-	public RobotIllegalStateException(String fehlertext) {
-		super(fehlertext);
+	/**
+	 * Der Konstruktor bekommt einen String (den Namen) übergeben und gibt diesen an
+	 * seine Superklasse weiter.
+	 * 
+     * @param String name repräsentiert den Namen des Roboters der die Exception wirft.
+	 */
+	public RobotIllegalStateException(String name) {
+		super(name + ": Leider ist der Roboter aus und kann nichts machen!");
 	}
+	
 }

Robbie-Management-System/src/exceptions/RobotMagicValueException.java

@@ -1,13 +1,32 @@
 package exceptions;
 
+/**
+ * Die Klasse repräsentiert die RobotMagicValueException der Roboter.
+ *
+ * Der Roboter hat einen Konstruktor <code>RobotException()</code> welcher einen
+ * Fehlertext an seine Superklasse übergibt.
+ * 
+ * Der Roboter hat einen weiteren Konstruktor <code>RobotException(...)</code> welcher
+ * einen String übergeben bekommt und diesen an seine Superklasse übergibt.
+ */
 public class RobotMagicValueException extends RobotException{
 
+	/**
+	 * Der Konstruktor erzeugt einen Fehlertext und übergibt diesen an
+	 * seine Superkalsse.
+	 */
 	public RobotMagicValueException() {
 		super("Zahl 42 kommt vor - Roboter: \"Ihhhhh\"!");
 	}
 	
-	public RobotMagicValueException(String fehlertext) {
-		super(fehlertext);
+	/**
+	 * Der Konstruktor bekommt einen String (den Namen) übergeben und gibt diesen an
+	 * seine Superklasse weiter.
+	 * 
+     * @param String name repräsentiert den Namen des Roboters der die Exception wirft.
+	 */
+	public RobotMagicValueException(String name) {
+		super(name + ": Zahl 42 kommt vor - Roboter: \"Ihhhhh\"!");
 	}
 	
 }

Robbie-Management-System/src/main/RobotFactory.java

@@ -5,8 +5,21 @@ import domain.R2D2;
 import domain.RobotType;
 import domain.Robotermodell;
 
+/**
+ * Die Klasse repräsentiert die RobotFactory.
+ *
+ * Mit <code>robotFactory(...)</code> werden die jeweiligen Modelle bzw. Instanzen
+ * der Roboter erzeugt.
+ */
 public class RobotFactory {
 
+    /**
+     * Erzeugt die jeweiligen Modelle der Roboter.
+     *
+     * @param RobotType modell stellt als Enum das Modell des Roboters dar.
+     * @param String name stellt den Namen des Roboters dar.
+     * @return Eine eindeutige Instanz in Form des Objekts oder eben null.
+     */
 	public static Robotermodell robotFactory (RobotType modell, String name) {
 		switch(modell) {
 			case C3PO: