From 167949c1c206d3d565300629fc80e98dd5b62075 Mon Sep 17 00:00:00 2001
From: Sebastian Kacza <Sebastian.Kacza@stud.htwk-leipzig.de>
Date: Mon, 14 Dec 2020 20:27:51 +0100
Subject: [PATCH] Kommentierung/JavaDoc erweitert

---
 src/de/jaujau/daten/Texturenpaket.java  | 37 +++++++++++++++++++------
 src/de/jaujau/daten/Texturenpakete.java | 16 ++++++-----
 2 files changed, 38 insertions(+), 15 deletions(-)

diff --git a/src/de/jaujau/daten/Texturenpaket.java b/src/de/jaujau/daten/Texturenpaket.java
index 5908d75..211a369 100755
--- a/src/de/jaujau/daten/Texturenpaket.java
+++ b/src/de/jaujau/daten/Texturenpaket.java
@@ -11,8 +11,28 @@ import java.util.zip.ZipFile;
 import javax.imageio.ImageIO;
 
 
+/*ToDo: 
+ * lesen von Datein aus Zip in eigene Methoden auslagern
+ * Paket name wird nicht richtig eingelsen wenn Leerzeichen enthalten sind
+ * Fehlerprüfung nicht obtimal
+ */
+
 /**
- * Verwaltet ein Texturenpackt
+ * Verwaltung eines Texturenpaketes
+ * zu jedem Paket werden folgende Informationen gespeichert:
+ * Name
+ * mindes Level
+ * Pfad zu der Zip-Datei
+ * 
+ * Aufbau eines Texturenpaketes:
+ * name.zip
+ * - paket.txt
+ *   - name:NAME
+ *   - level:LEVEL als Integer
+ * - 0.png
+ * - ...
+ * - 31.png
+ * 
  * @author Sebastian Kacza
  *
  */
@@ -25,7 +45,7 @@ public class Texturenpaket {
 	
 	/**
 	 * Erstellt ein neues Texturenpackt
-	 * @param Pfad zu der Zip-Datei des Texturenpacketes
+	 * @param Pfad zu der Zip-Datei des Texturenpaketes
 	 */
 	public Texturenpaket(String Pfad) {
 		name = "Nicht geladen";
@@ -35,8 +55,8 @@ public class Texturenpaket {
 	
 	
 	/**
-	 * Läd die Packetinformationen und Testet das Packet auf Vollständigkeit
-	 * @return Paket vollständig laden, true/false
+	 * Läd die Packetinformationen in die lokalen Variablen und Testet das Packet auf Vollständigkeit
+	 * @return Paket vollständig geladen, true/false
 	 */
 	public boolean ladePacket() {
 		System.out.println("TEXTURENPAKET: Lade Paket");
@@ -88,8 +108,8 @@ public class Texturenpaket {
 	
 	
 	/**
-	 * Gibt alle Bilddatein für ein Texturen Paket zurück
-	 * @return Image der Texturen des Peketes als Image Array
+	 * Gibt alle Bilddatein von dem Texturenpaket als Image Array zurück
+	 * @return Image Array der Texturen des Paketes
 	 */
 	public Image[] getTexturen() {
 		if(testePaket()) {
@@ -142,7 +162,7 @@ public class Texturenpaket {
 	 * @return Paket vollständig, true/false
 	 */
 	private boolean testePaket() {
-		System.out.println("TEXTURENPAKET: Teste Paket:");
+		System.out.println("TEXTURENPAKET: Paket auf Fehler untersuchen:");
 		//Testen ob Zip-Datei vorhanden und lesabar ist
 		File zipDatei = new File(pfad);
 		if(zipDatei.exists() || zipDatei.canRead()) {
@@ -160,7 +180,7 @@ public class Texturenpaket {
 				while(scanner.hasNext()) {
 					//Prüfen ob Konfigurations Datei die Einträge "name" und "level" enthält	
 					String Zeile = scanner.next();
-					System.out.println("TEXTURENPAKET: " + Zeile);
+					System.out.println("TEXTURENPAKET: Konfigzeile:" + Zeile);
 					if(Zeile.contains("name:")) {
 						PaketName = true;
 					}
@@ -184,6 +204,7 @@ public class Texturenpaket {
 						System.out.println("TEXTURENPAKET: Datei: " + i + ".png nicht gefunden");
 						return false;
 					}
+					System.out.println("TEXTURENPAKET: Datei: " + i + ".png OK!");
 				}
 				
 				paketDatei.close();
diff --git a/src/de/jaujau/daten/Texturenpakete.java b/src/de/jaujau/daten/Texturenpakete.java
index e87bab1..e30b392 100644
--- a/src/de/jaujau/daten/Texturenpakete.java
+++ b/src/de/jaujau/daten/Texturenpakete.java
@@ -65,27 +65,29 @@ public class Texturenpakete {
 	
 	
 	/**
-	 * Setzt das aktive Paket
+	 * Legt fest welches Texturenpaket das Aktive sein soll
+	 * Die Bilder des Aktiven Textuenpaketes werden nur Pufferung in eine Array geladen.
+	 * Dies soll Dateizugriffe beim Anzeigen der Bilder reduzieren
 	 * @param PaketNr des Paketes
 	 * @return Setzen erfolgreich true/false
 	 */
 	public boolean setAktivesPaket(int PaketNr) {
 		if((PaketNr >= 0) && (PaketNr < TexturenpaketListe.size())) {
 			AktivesPaket = PaketNr;
-			
-			//Texturen Laden
 			Texturen = TexturenpaketListe.get(PaketNr).getTexturen();
 			return true;
+			//ToDo: Wenn für ein Bild ein Null Objekt zurückgegebn soll das Bild ausgetauscht werden?
 		}
 		return false;
 	}
 	
 	
 	/**
-	 * Fügt ein Neues Testuren Paket hinzu
-	 * Das Paket wird vor dem einfügen auf Vollständfigkeit geprüft
-	 * @param Pfad
-	 * @return
+	 * Es wird ein neues Texturenpaket zu der Liste hinzugefügt
+	 * Das Paket wird vor dem einfügen auf Vollständfigkeit geprüft.
+	 * Wenn es unfolständig ist wird es nicht hinzugefügt
+	 * @param Pfad zu der Texturenpaket Datei (.zip)
+	 * @return Ob das Paket erfolgreich hinzu gefügt wurde, true/false
 	 */
 	public boolean addPaket(String Pfad) {
 		Texturenpaket NeuesPaket = new Texturenpaket(Pfad);