From 4d68014a25b6ab2b1924f0589d2331970d30b1e7 Mon Sep 17 00:00:00 2001 From: Robin Cheney Date: Fri, 7 Nov 2025 10:54:57 +0100 Subject: [PATCH] added javadoc comments --- .../tankstelle/GrosseTankstelle.java | 25 +++++++++++++++++ .../tankstelle/KleineTankstelle.java | 27 +++++++++++++++++++ .../diejungsvondertanke/tankstelle/Main.java | 1 - .../tankstelle/MittlereTankstelle.java | 17 ++++++++++-- .../tankstelle/Tankstelle.java | 13 +++++---- .../tankstelle/Treibstoff.java | 2 +- 6 files changed, 76 insertions(+), 9 deletions(-) diff --git a/src/main/java/de/diejungsvondertanke/tankstelle/GrosseTankstelle.java b/src/main/java/de/diejungsvondertanke/tankstelle/GrosseTankstelle.java index 9572d5a..61155c5 100644 --- a/src/main/java/de/diejungsvondertanke/tankstelle/GrosseTankstelle.java +++ b/src/main/java/de/diejungsvondertanke/tankstelle/GrosseTankstelle.java @@ -1,8 +1,22 @@ package de.diejungsvondertanke.tankstelle; +/** + * Große Tankstelle + */ public class GrosseTankstelle extends Tankstelle { + /** + * Betreiberfirma des integrierten Supermarkts + */ private String betreiberfirma_supermarkt; + /** + * Konstruktor für große Tankstellen + * + * @param betreiberfirma_supermarkt Betreiberfirma des integrierten Supermarkts + * @see de.diejungsvondertanke.tankstelle.GrosseTankstelle#betreiberfirma_supermarkt + * betreiberfirma_supermarkt + * @see de.diejungsvondertanke.tankstelle.Tankstelle Tankstelle + */ public GrosseTankstelle(String betreiberfirma_supermarkt) { Treibstoff[] treibstoffe = { new Treibstoff(Treibstofftyp.SUPER, 8000f, 0f, 16000), new Treibstoff(Treibstofftyp.SUPER_E10, 8000f, 0f, 16000), @@ -13,6 +27,17 @@ public class GrosseTankstelle extends Tankstelle { this.betreiberfirma_supermarkt = betreiberfirma_supermarkt; } + /** + * Konstruktor für große Tankstellen inklusive Mitarbeiteranzahl + * + * @param betreiberfirma_supermarkt Betreiberfirma des integrierten Supermarkts + * @param mitarbeiterzahl Mitarbeiteranzahl + * @see de.diejungsvondertanke.tankstelle.GrosseTankstelle#betreiberfirma_supermarkt + * betreiberfirma_supermarkt + * @see de.diejungsvondertanke.tankstelle.Tankstelle Tankstelle + * @see de.diejungsvondertanke.tankstelle.Tankstelle#mitarbeiterzahl + * mitarbeiterzahl + */ public GrosseTankstelle(String betreiberfirma_supermarkt, byte mitarbeiterzahl) { Treibstoff[] treibstoffe = { new Treibstoff(Treibstofftyp.SUPER, 8000f, 0f, 16000), new Treibstoff(Treibstofftyp.SUPER_E10, 8000f, 0f, 16000), diff --git a/src/main/java/de/diejungsvondertanke/tankstelle/KleineTankstelle.java b/src/main/java/de/diejungsvondertanke/tankstelle/KleineTankstelle.java index be7baeb..feaf67d 100644 --- a/src/main/java/de/diejungsvondertanke/tankstelle/KleineTankstelle.java +++ b/src/main/java/de/diejungsvondertanke/tankstelle/KleineTankstelle.java @@ -1,8 +1,23 @@ package de.diejungsvondertanke.tankstelle; +/** + * Kleine Tankstelle + */ public class KleineTankstelle extends Tankstelle { + /** + * Anzahl der Getränkeautomaten in dieser Tankstelle + */ private short anzahl_getraenkeautomaten; + /** + * Konstruktor für kleine Tankstellen + * + * @param anzahl_getraenkeautomaten Anzahl der Getränkeautomaten in dieser + * Tankstelle + * @see de.diejungsvondertanke.tankstelle.KleineTankstelle#anzahl_getraenkeautomaten + * anzahl_getraenkeautomaten + * @see de.diejungsvondertanke.tankstelle.Tankstelle Tankstelle + */ public KleineTankstelle(short anzahl_getraenkeautomaten) { Treibstoff[] treibstoffe = { new Treibstoff(Treibstofftyp.SUPER, 4000f, 0f, 8000), new Treibstoff(Treibstofftyp.DIESEL, 4000f, 0f, 8000) }; @@ -10,6 +25,18 @@ public class KleineTankstelle extends Tankstelle { this.anzahl_getraenkeautomaten = anzahl_getraenkeautomaten; } + /** + * Konstruktor für kleine Tankstellen inklusive Mitarbeiteranzahl + * + * @param anzahl_getraenkeautomaten Anzahl der Getränkeautomaten in dieser + * Tankstelle + * @param mitarbeiterzahl Mitarbeiteranzahl + * @see de.diejungsvondertanke.tankstelle.KleineTankstelle#anzahl_getraenkeautomaten + * anzahl_getraenkeautomaten + * @see de.diejungsvondertanke.tankstelle.Tankstelle Tankstelle + * @see de.diejungsvondertanke.tankstelle.Tankstelle#mitarbeiterzahl + * mitarbeiterzahl + */ public KleineTankstelle(short anzahl_getraenkeautomaten, byte mitarbeiterzahl) { Treibstoff[] treibstoffe = { new Treibstoff(Treibstofftyp.SUPER, 4000f, 0f, 8000), new Treibstoff(Treibstofftyp.DIESEL, 4000f, 0f, 8000) }; diff --git a/src/main/java/de/diejungsvondertanke/tankstelle/Main.java b/src/main/java/de/diejungsvondertanke/tankstelle/Main.java index f08e14d..9419a4c 100644 --- a/src/main/java/de/diejungsvondertanke/tankstelle/Main.java +++ b/src/main/java/de/diejungsvondertanke/tankstelle/Main.java @@ -13,6 +13,5 @@ public class Main { new GrosseTankstelle("PlatzhalterFirma3") }; public static void main(String[] args) { - System.out.println(tankstellen[7].getMitarbeiterzahl()); } } \ No newline at end of file diff --git a/src/main/java/de/diejungsvondertanke/tankstelle/MittlereTankstelle.java b/src/main/java/de/diejungsvondertanke/tankstelle/MittlereTankstelle.java index dd9e3ff..da487b3 100644 --- a/src/main/java/de/diejungsvondertanke/tankstelle/MittlereTankstelle.java +++ b/src/main/java/de/diejungsvondertanke/tankstelle/MittlereTankstelle.java @@ -10,11 +10,12 @@ public class MittlereTankstelle extends Tankstelle { private int quadratmeterzahl_verkaufsflaeche; /** - * Konstruktor + * Konstruktor für mittelgroße Tankstellen * * @param quadratmeterzahl_verkaufsflaeche Quadratmeterzahl der * Ladenverkaufsfläche - * @see de.diejungsvondertanke.tankstelle.MittlereTankstelle#quadratmeterzahl_verkaufsflaeche quadratmeterzahl_verkaufsflaeche + * @see de.diejungsvondertanke.tankstelle.MittlereTankstelle#quadratmeterzahl_verkaufsflaeche + * quadratmeterzahl_verkaufsflaeche * @see de.diejungsvondertanke.tankstelle.Tankstelle Tankstelle */ public MittlereTankstelle(int quadratmeterzahl_verkaufsflaeche) { @@ -26,6 +27,18 @@ public class MittlereTankstelle extends Tankstelle { this.quadratmeterzahl_verkaufsflaeche = quadratmeterzahl_verkaufsflaeche; } + /** + * Konstruktor für mittelgroße Tankstellen inklusive Mitarbeiteranzahl + * + * @param quadratmeterzahl_verkaufsflaeche Quadratmeterzahl der + * Ladenverkaufsfläche + * @param mitarbeiterzahl Mitarbeiteranzahl + * @see de.diejungsvondertanke.tankstelle.MittlereTankstelle#quadratmeterzahl_verkaufsflaeche + * quadratmeterzahl_verkaufsflaeche + * @see de.diejungsvondertanke.tankstelle.Tankstelle Tankstelle + * @see de.diejungsvondertanke.tankstelle.Tankstelle#mitarbeiterzahl + * mitarbeiterzahl + */ public MittlereTankstelle(int quadratmeterzahl_verkaufsflaeche, byte mitarbeiterzahl) { Treibstoff[] treibstoffe = { new Treibstoff(Treibstofftyp.SUPER, 6000f, 0f, 12000), new Treibstoff(Treibstofftyp.SUPER_E10, 6000f, 0f, 12000), diff --git a/src/main/java/de/diejungsvondertanke/tankstelle/Tankstelle.java b/src/main/java/de/diejungsvondertanke/tankstelle/Tankstelle.java index a049424..288c775 100644 --- a/src/main/java/de/diejungsvondertanke/tankstelle/Tankstelle.java +++ b/src/main/java/de/diejungsvondertanke/tankstelle/Tankstelle.java @@ -5,7 +5,8 @@ package de.diejungsvondertanke.tankstelle; * Alle Tankstellen erben hiervon * * @see de.diejungsvondertanke.tankstelle.GrosseTankstelle Große Tankstelle - * @see de.diejungsvondertanke.tankstelle.MittlereTankstelle Mittelgroße Tankstelle + * @see de.diejungsvondertanke.tankstelle.MittlereTankstelle Mittelgroße + * Tankstelle * @see de.diejungsvondertanke.tankstelle.KleineTankstelle Kleine Tankstelle */ abstract class Tankstelle { @@ -33,8 +34,10 @@ abstract class Tankstelle { * GROSS) * @param treibstoffe Array der Treibstoffe dieser Tankstelle * @see de.diejungsvondertanke.tankstelle.GrosseTankstelle Große Tankstelle - * @see de.diejungsvondertanke.tankstelle.MittlereTankstelle Mittelgroße Tankstelle + * @see de.diejungsvondertanke.tankstelle.MittlereTankstelle Mittelgroße + * Tankstelle * @see de.diejungsvondertanke.tankstelle.KleineTankstelle Kleine Tankstelle + * @see de.diejungsvondertanke.tankstelle.Treibstoff Treibstoff */ protected Tankstelle(byte mitarbeiterzahl, Groesse groesse, Treibstoff[] treibstoffe) { this.mitarbeiterzahl = mitarbeiterzahl; @@ -51,11 +54,11 @@ abstract class Tankstelle { } // public Treibstoff[] getTreibstoffe() { - // return treibstoffe; + // return treibstoffe; // } // public void setTreibstoffe(Treibstoff[] treibstoffe) { - // this.treibstoffe = treibstoffe; + // this.treibstoffe = treibstoffe; // } public Groesse getGroesse() { @@ -63,6 +66,6 @@ abstract class Tankstelle { } // public void setGroesse(Groesse groesse) { - // this.groesse = groesse; + // this.groesse = groesse; // } } diff --git a/src/main/java/de/diejungsvondertanke/tankstelle/Treibstoff.java b/src/main/java/de/diejungsvondertanke/tankstelle/Treibstoff.java index c9b40d6..6beb5de 100644 --- a/src/main/java/de/diejungsvondertanke/tankstelle/Treibstoff.java +++ b/src/main/java/de/diejungsvondertanke/tankstelle/Treibstoff.java @@ -36,7 +36,7 @@ public class Treibstoff { * @param preis Verkaufspreis in € / L * @param kapazitaet Maximaler Treibstoffvorrat / Lagerkapazität */ - Treibstoff(Treibstofftyp Treibstofftyp, float menge, float preis, int kapazitaet) { + public Treibstoff(Treibstofftyp Treibstofftyp, float menge, float preis, int kapazitaet) { this.TREIBSTOFFTYP = Treibstofftyp; this.menge = menge; this.preis = preis; -- 2.43.0