From 4e82b873e672e39bc3de84b38d59d121fcad64f0 Mon Sep 17 00:00:00 2001
From: Dennis Eisold <de@roadit.de>
Date: Wed, 30 Oct 2019 19:44:43 +0100
Subject: [PATCH] Added documentation to Lager.java
---
src/de/itstall/Lager.java | 43 ++++++++++++++++++++++++---------------
1 file changed, 27 insertions(+), 16 deletions(-)
diff --git a/src/de/itstall/Lager.java b/src/de/itstall/Lager.java
index 8858251..4887dd9 100644
--- a/src/de/itstall/Lager.java
+++ b/src/de/itstall/Lager.java
@@ -1,7 +1,6 @@
package de.itstall;
import java.util.ArrayList;
-import java.util.function.Predicate;
/**
* Klasse zur Verwaltung der Lager
@@ -42,13 +41,13 @@ public class Lager {
*/
public void addRegal() {
this.lagerListe.add(new Regal());
- System.out.println("Neues Regal wurde gebaut.");
+ System.out.println("Neues Regal wurde gebaut.");
}
/**
* Sucht auf den Lagerplaetzen nach einem Objekt und gibt den Lagerplatz zurueck
- * <p>
- * //@param o : Object : Das zu suchende Object
+ *
+ * @param bezeichnung : String : Der zu suchende Bezeichner des Objektes
*
* @return Object : Lagerplatz
*/
@@ -65,33 +64,45 @@ public class Lager {
return null;
}
+ /**
+ * Lagert ein Objekt vom Typ "Karton" ins Lager ein
+ *
+ * @param karton : Karton<>
+ * @return boolean
+ */
public boolean einlagern(Karton<?> karton) {
- for (Regal regal : lagerListe) {
+ for (Regal regal : lagerListe) {
if (regal.lagerplaetzListe.size() <= this.regalLagerplaetze) {
regal.lagerplaetzListe.add(karton);
return true;
} else {
- this.addRegal();
- this.einlagern(karton);
+ this.addRegal();
+ this.einlagern(karton);
- return true;
- }
+ return true;
+ }
}
- return false;
+ return false;
}
+ /**
+ * Nimmt ein Objekt vom Typ "Karton" aus dem Lager heraus
+ *
+ * @param bezeichnung : String : Sucht nach dem bezeichner des Karton Objektes
+ * @return boolean
+ */
public boolean entnehmen(String bezeichnung) {
for (Regal regal : lagerListe) {
- if(regal.lagerplaetzListe.removeIf(karton -> karton.getBezeichnung().equals(bezeichnung))) {
+ if (regal.lagerplaetzListe.removeIf(karton -> karton.getBezeichnung().equals(bezeichnung))) {
- return true;
- }
- }
+ return true;
+ }
+ }
- return false;
- }
+ return false;
+ }
/**
* Klasse zur Verwaltung der Regale
--
GitLab