From 39b03fdf618f324999e35625fcfa6d121408121a Mon Sep 17 00:00:00 2001
From: eichehome <eichehome@gmx.de>
Date: Tue, 11 May 2021 15:53:39 +0200
Subject: [PATCH] Kommentierung von den Klassen der FIFO-Pipe und formatierung

---
 src/server/Element.java     |  1 +
 src/server/FifoPipe.java    | 29 ++++++++++++++++++-----------
 src/server/PipeElement.java | 33 +++++++++++++++++++++++++++------
 3 files changed, 46 insertions(+), 17 deletions(-)

diff --git a/src/server/Element.java b/src/server/Element.java
index 63baae3..7585075 100644
--- a/src/server/Element.java
+++ b/src/server/Element.java
@@ -17,6 +17,7 @@
 package server;
 
 /**
+ * Dummy für den inhalt der FIFO-Pipe
  *
  * @author eichehome
  */
diff --git a/src/server/FifoPipe.java b/src/server/FifoPipe.java
index 896fd36..b8c0c40 100644
--- a/src/server/FifoPipe.java
+++ b/src/server/FifoPipe.java
@@ -17,18 +17,20 @@
 package server;
 
 /**
+ * Diese Klasse stellt eine FIFO-Pipe dar.
  *
  * @author eichehome
  */
 public class FifoPipe {
-    
-    public PipeElement firstElement;
-    public PipeElement lastElement;
-    
-    public FifoPipe() {
-        
-    }
-    
+
+    private PipeElement firstElement;
+    private PipeElement lastElement;
+
+    /**
+     * Diese Funktion dient zum Einreihen von Elementen in die FIFO-Pipe
+     *
+     * @param element ein Element, welches eingereiht werden soll
+     */
     public void queuElement(Element element) {
         PipeElement pipeElement = new PipeElement(element);
         try {
@@ -39,7 +41,12 @@ public class FifoPipe {
             lastElement = pipeElement;
         }
     }
-    
+
+    /**
+     * Diese funktion gibt das erste Element der FIFO-Pipe zurück
+     *
+     * @return Erstes Element der FIFO-Pipe
+     */
     public PipeElement getNextElement() {
         PipeElement result = null;
         if (firstElement == null) {
@@ -55,9 +62,9 @@ public class FifoPipe {
                 PipeElement next = firstElement.getNext();
                 firstElement = next;
                 return result;
-                
+
             }
         }
     }
-    
+
 }
diff --git a/src/server/PipeElement.java b/src/server/PipeElement.java
index e318f68..edf8f75 100644
--- a/src/server/PipeElement.java
+++ b/src/server/PipeElement.java
@@ -17,29 +17,50 @@
 package server;
 
 /**
+ * Diese Klasse stellt eine Element aus der FIFO-Pipe dar.
  *
  * @author eichehome
  */
 public class PipeElement {
-    
+
     private PipeElement next;
     private Element data;
-    
+
+    /**
+     * Der Constructor, welcher ein neues Element erstellt
+     *
+     * @param el Der Inhalt, welcher in diesem Element gespeichert ist.
+     */
     public PipeElement(Element el) {
         data = el;
         next = null;
     }
-    
+
+    /**
+     * Diese Funktion gubt einen Zeiger auf das nächste Objekt zurück
+     *
+     * @return Einen Zeiger auf das nächste Objekt
+     */
     public PipeElement getNext() {
         return next;
     }
-    
+
+    /**
+     * Diese Funktion reiht ein Element nach diesem ein.
+     *
+     * @param element Das einzureihende Element
+     */
     public void setNextElement(PipeElement element) {
         next = element;
     }
-    
+
+    /**
+     * Eine Funktion, die den Inhalt diese Elements zurück gibt
+     *
+     * @return Inhalt diese Elements
+     */
     public Element getData() {
         return data;
     }
-    
+
 }