From 48f716c1522e86eeed74fb7127bee4e356f3b28b Mon Sep 17 00:00:00 2001
From: Dennis Eisold <de@itstall.de>
Date: Fri, 29 Nov 2019 03:46:33 +0100
Subject: [PATCH] =?UTF-8?q?Noch=20ein=20wenig=20aufger=C3=A4umt=20und=20To?=
=?UTF-8?q?do=20Marker=20eingef=C3=BCgt.?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
---
src/main/java/enigma/model/Codebuch.java | 8 ++++--
src/main/java/enigma/model/Codierer.java | 31 +++++++++++++++-------
src/main/java/enigma/model/Hardware.java | 2 +-
src/main/java/enigma/model/Steckbrett.java | 13 +++++----
src/main/java/enigma/model/Walze.java | 17 ++++++------
5 files changed, 43 insertions(+), 28 deletions(-)
diff --git a/src/main/java/enigma/model/Codebuch.java b/src/main/java/enigma/model/Codebuch.java
index 020b070..115ed44 100644
--- a/src/main/java/enigma/model/Codebuch.java
+++ b/src/main/java/enigma/model/Codebuch.java
@@ -23,7 +23,7 @@ import java.time.ZoneId;
*/
public class Codebuch {
/**
- * TODO Dokumentieren
+ * TODO: Dokumentieren
*/
private int tag;
private int[] walzenlage;
@@ -51,6 +51,10 @@ public class Codebuch {
}
}
+ /**
+ * TODO: Dokumentieren
+ * @param tag
+ */
public void getTagesschluessel(int... tag) {
String[] walzenlage, ringstellung, db;
@@ -136,7 +140,7 @@ public class Codebuch {
*
* @param tag : int
*/
- private void setTag(int tag) {
+ void setTag(int tag) {
this.tag = tag;
}
diff --git a/src/main/java/enigma/model/Codierer.java b/src/main/java/enigma/model/Codierer.java
index 0f8aa88..8b1ff3b 100644
--- a/src/main/java/enigma/model/Codierer.java
+++ b/src/main/java/enigma/model/Codierer.java
@@ -7,12 +7,12 @@ import java.util.Calendar;
import java.util.Random;
/**
- * TODO Dokumentieren
+ * TODO: Dokumentieren
*/
public class Codierer {
/**
- * TODO Dokumentieren
+ * TODO: Dokumentieren
*/
private String spruchschluessel;
private String spruchschluesselCodiert;
@@ -22,7 +22,7 @@ public class Codierer {
private Codebuch codebuch;
/**
- * TODO Dokumentieren
+ * TODO: Dokumentieren
*/
public Codierer() {
this.nachricht = "";
@@ -109,7 +109,7 @@ public class Codierer {
}
/**
- * TODO Dokumentieren
+ * TODO: Dokumentieren
*
* @return String : Der codierte Spruchschlüssel
*/
@@ -118,7 +118,7 @@ public class Codierer {
}
/**
- * TODO Dokumentieren
+ * TODO: Dokumentieren
*
* @return String : Der klartext Spruchschlüssel
*/
@@ -127,13 +127,13 @@ public class Codierer {
}
/**
- * TODO Dokumentieren
+ * TODO: Dokumentieren
*/
private String generateKopf() {
Calendar cal = Calendar.getInstance();
// Uhrzeit an den Kopf hängen
- // Todo: Da gab es doch noch eine besser Lösung für den Korrekturfaktor der Uhrzeit?
+ // TODO: Da gab es doch noch eine besser Lösung für den Korrekturfaktor der Uhrzeit?
return String.format("%02d%02d", cal.get(Calendar.HOUR), cal.get(Calendar.MINUTE)) + " " +
@@ -248,7 +248,7 @@ public class Codierer {
}
/**
- * TODO Dokumentieren
+ * TODO: Dokumentieren
*
* @param buchstabe
* @return
@@ -262,6 +262,12 @@ public class Codierer {
return codiert;
}
+ /**
+ * TODO: Dokumentieren
+ * @param klartext
+ * @param save
+ * @return
+ */
public String codiere(String klartext, boolean save) {
StringBuilder sb = new StringBuilder();
@@ -274,7 +280,7 @@ public class Codierer {
}
/**
- * TODO Dokumentieren
+ * TODO: Dokumentieren
*
* @param codierteNachricht : String : Enigma codierte Nachricht
* @param tag : int : Tag der Nachricht
@@ -311,6 +317,11 @@ public class Codierer {
return sb.toString();
}
+ /**
+ * TODO: Dokumentieren
+ * @param nachricht
+ * @return
+ */
public String decodiereString(String nachricht) {
StringBuilder sb = new StringBuilder();
@@ -325,7 +336,7 @@ public class Codierer {
}
/**
- * Todo Dokumentieren
+ * TODO: Dokumentieren
*/
public void resetHardware() {
diff --git a/src/main/java/enigma/model/Hardware.java b/src/main/java/enigma/model/Hardware.java
index 36ea74b..1842e1e 100644
--- a/src/main/java/enigma/model/Hardware.java
+++ b/src/main/java/enigma/model/Hardware.java
@@ -16,7 +16,7 @@ package enigma.model;
public class Hardware {
/**
- * TODO Dokumentieren
+ * TODO: Dokumentieren
*/
private Walze[] walzen;
private Steckbrett steckbrett;
diff --git a/src/main/java/enigma/model/Steckbrett.java b/src/main/java/enigma/model/Steckbrett.java
index 4a87914..63bf834 100644
--- a/src/main/java/enigma/model/Steckbrett.java
+++ b/src/main/java/enigma/model/Steckbrett.java
@@ -1,18 +1,18 @@
package enigma.model;
/**
- *TODO Dokumentieren
+ *TODO: Dokumentieren
*/
public class Steckbrett {
/**
- *TODO Dokumentieren
+ *TODO: Dokumentieren
*/
private int zaehler;
private Character[] orginalBuchstaben;
private Character[] getauschteBuchstaben;
/**
- *TODO Dokumentieren
+ *TODO: Dokumentieren
*/
public Steckbrett() {
@@ -20,9 +20,8 @@ public class Steckbrett {
getauschteBuchstaben = new Character[10];
}
-
/**
- *TODO Dokumentieren
+ *TODO: Dokumentieren
*
* @param buchstabe1 : char
* @param buchstabe2 : char
@@ -41,7 +40,7 @@ public class Steckbrett {
}
/**
- *TODO Dokumentieren
+ *TODO: Dokumentieren
*
* @return boolean
*/
@@ -59,7 +58,7 @@ public class Steckbrett {
}
/**
- * TODO Dokumentieren
+ * TODO: Dokumentieren
*
* @param buchstabe : Character
* @return char
diff --git a/src/main/java/enigma/model/Walze.java b/src/main/java/enigma/model/Walze.java
index d6be910..42d9c87 100644
--- a/src/main/java/enigma/model/Walze.java
+++ b/src/main/java/enigma/model/Walze.java
@@ -43,7 +43,6 @@ public class Walze {
this.setRingstellung(ringstellung);
}
-
/**
* Sortiert den Walzennummern das passenden Character-Array mittels switch zu.
*
@@ -80,7 +79,7 @@ public class Walze {
}
/**
- * TODO Dokumentieren
+ * TODO: Dokumentieren
*
* @return ringstellung : Character : gibt die neue Ringstellung zurueck
*/
@@ -105,7 +104,7 @@ public class Walze {
/**
* dreheWalze() return boolean => Wenn Notch erreicht, gib true zurück, ansonsten false
- * TODO Doku
+ * TODO: Doku
*/
public boolean dreheWalze(int... drehung) {
@@ -127,7 +126,7 @@ public class Walze {
}
/**
- * TODO Dokumentieren
+ * TODO: Dokumentieren
*/
private void verschiebung() {
@@ -139,13 +138,16 @@ public class Walze {
this.walzeAlpha = neueWalze;
}
+ /**
+ * TODO: Dokumentieren
+ * @return
+ */
public char getAnzeige() {
int temp = this.getArrayIndex('A', this.walzeAlpha);
return this.alphabet[temp];
}
-
/**
* Chiffriert den Buchstaben an der Position aus der Methode positionBuchstabe()
* anhand der gewaehlten Walze.
@@ -163,7 +165,6 @@ public class Walze {
return buchstabe;
}
-
/**
* Chiffriert den Buchstaben an der Position aus der Methode positionBuchstabeReverse()
* anhand der AlphaWalze.
@@ -182,7 +183,7 @@ public class Walze {
}
/**
- * TODO Dokumentieren
+ * TODO: Dokumentieren
*
* @param buchstabe : Character
* @param array : Character[]
@@ -228,7 +229,7 @@ public class Walze {
* Gibt die Grundeinstellung der Walze ein. Nur Buchstaben von A - Z sind zugelassen.
* Buchstaben werden automatisch in Grossbuchstaben umgewandelt.
* Im Fehlerfall wird die Grundeinstellung der Walze standardmaessig auf 'A' gesetzt.
- * TODO Funktionsname hat sich geändert
+ * TODO: Funktionsname hat sich geändert
*
* @param buchstabe : Character : Grundeinstellung der Walze
*/
--
GitLab