Generierte Dokumentation der praktischen Arbeit von Simon Tiffert

main.Main Klassenreferenz

Zusammengehörigkeiten von main.Main:

[Legende]Aufstellung aller Elemente

---

Ausführliche Beschreibung

Diese Klasse steuert den Ablauf des Programms.

Hier kann man in der main-Funktion den Ablauf des EVA Prinzips erkennen. Da hier auch zentral Fehler abgefangen werden, war es nötig, die Ausgabedatei schon sehr früh im Programmablauf zu öffnen, da Exceptions sonst nicht in Datei geschrieben werden könnten. In dieser Klasse befindet sich auch das zentrale Matrix-Element, welches per Referenz an die Unterteile Eingabe, Verarbeitung und Ausgabe übergeben wird.

Zudem befindet sich hier der Parser für die Eingabeparameter. Dieser sorgt dafür, dass wichtige Flags in dieser Klasse gesetzt sind. Abgefangen werden:

• -d DATEINAME (erkennt den Parameter und setzt den Dateinamen)

• -debug (setzt das Programm in den Debugmodus, bei dem die Ausgaben auch auf dem Bildschirm ausgegeben werden).

• -overwrite (überschreibt eine vorhandene Ausgabedatei. Dies erleichtert das Testen, kann aber im normalen Ablauf unerwünscht sein)

• -h (zeigt die Hilfe an, wie das Programm aufgerufen wird. Die Hilfe wird auch automatisch angezeigt, wenn Parameter falsch angegeben wurden)

Version:

Revision

1.16

Autor:

Simon Tiffert

Definiert in Zeile 68 der Datei Main.java.

Öffentliche, statische Methoden
void	main (String[] args)
	main-Funktion des Programms.
Statische öffentliche Attribute
final int	maxDimension = 6
	maximale Größe der Matrix
boolean	debug = false
	setzt den Debug-Modus
boolean	overwrite = false
	setzt den Overwrite-Modus
Matrix	matrix = new Matrix()
	Die zentrale Datenstruktur mit der Matrix.
Private, statische Methoden
String	parameterParser (String[] parameter) throws WrongParameterException, NoInputException
	Diese Funktion parst die Eingabeparameter.

---

Dokumentation der Elementfunktionen

void main.Main.main (  String[]  args  )  [static]

main-Funktion des Programms. Hier wird die Verarbeitung des Programms gesteuert und die Fehlerabfrage durchgeführt, die zur weiteren Verarbeitung weitergereicht wird. Parameter: args  Programmparameter -d DATEINAME [-h] [-debug][-overwrite] Definiert in Zeile 91 der Datei Main.java. Benutzt main.Main.parameterParser(). { // Dateiname der Eingabedatei String dateiName = null; // Erstelle einen Writer, für die Ausgabedatei BufferedWriter bw = null; try { // Überprüft, ob ein Dateiname mit angegeben wurde. dateiName = parameterParser(args); // öffne Ausgabedatei und setze den Writer darauf bw = new OutputFile(dateiName, ".out").getAusgabeDatei(); // EVA-Prinzip: // Erstelle eine Instanz der Eingabe new Eingabe(matrix, dateiName); // rufe die Verarbeitung mit den RoesselSprüngen auf new Verarbeitung(matrix); // erzeuge die Ausgabe new Ausgabe(matrix, bw); } catch (Exception e) { // die Fehler werden dann in der Datei ausgewertet new FehlerAusgabe(bw, e, dateiName); } finally { // schliesse die Ausgabedatei und fange einen Fehler dabei auf try { if (bw != null) { bw.close(); } } catch (IOException e) { System.err.println( "Ausgabedatei konnte nicht geschrieben werden."); } } }

Hier ist der Graph aller Aufrufe für diese Funktion:

String main.Main.parameterParser (  String[]  parameter  )  throws WrongParameterException, NoInputException [static, private]

Diese Funktion parst die Eingabeparameter. Dabei wird überprüft, ob eine Eingabedatei angegeben wurde. Zudem werden weitere Parameter erkannt und fehlerhafte sowie doppelte Parameter werden erkannt und als Exception geworfen. <br /> Erkannt werden: -d DATEINAME (Pflichtparameter) -h (Hilfe) -debug (Debugmodus) -overwrite (Overwrite-Modus, der die Ausgabedatei überschreibt) Parameter: parameter  Übergabeparameter der main-Funktion Rückgabe: Übergebenen Dateinamen Ausnahmebehandlung: WrongParameterException  Fehlerhafte Parameter NoInputException  Fehlende Parameter Definiert in Zeile 164 der Datei Main.java. Benutzt main.Main.debug und main.Main.overwrite. Wird benutzt von main.Main.main(). { // Dateiname der Eingabedatei String dateiName = null; // Flagge für Anzeige der Hilfe boolean hilfe = false; // überprüft, ob überhaupt Parameter angegeben wurden if (parameter.length == 0) { // werfe eigene Exception throw new NoInputException(); } // laufe über alle Parameter for (int i = 0; i < parameter.length; i++) { // -d für Dateiname if (parameter[i].equalsIgnoreCase("-d")) { // wenn der Dateiname noch nicht gesetzt ist if (dateiName == null) { // setze den nächsten Parameter als Dateinamen, wenn noch // Parameter vorhanden sind. Ansonsten werfe Fehler, dass // der Dateiname fehlt if (i < parameter.length - 1) { dateiName = parameter[++i]; } else { throw new WrongParameterException( "Falscher Parameter - Dateiname fehlt"); } // Falls danach wieder ein Parameter folgt, fehlt der // Dateiname if (dateiName.startsWith("-")) { throw new WrongParameterException( "Falscher Parameter - Dateiname fehlt"); } } // wenn der Dateiname schon gesetzt ist, wäre er doppelt // definiert. Um Fehlern vorzubeugen wird hier eine Exception // geworfen else { throw new WrongParameterException( "Doppelter Parameter - Dateiname schon angegeben"); } } // -debug Debug-Modus else if (parameter[i].equalsIgnoreCase("-debug")) { // wenn der Debugmodus noch nicht gesetzt ist, setze ihn jetzt if (debug == false) { debug = true; } // doppelter Parameter, der zu einer Exception führt else { throw new WrongParameterException( "Doppelter Parameter -debug"); } } // -overwrite Overwrite-Modus else if (parameter[i].equalsIgnoreCase("-overwrite")) { // Wenn der Overwritemodus noch nicht gesetzt ist, setze ihn // jetzt if (overwrite == false) { overwrite = true; } // doppelter Parameter, der zu einer Exception führt else { throw new WrongParameterException( "Doppelter Parameter -overwrite"); } } // -h Hilfe else if (parameter[i].equalsIgnoreCase("-h")) { // überprüfe, ob die Hilfe schon angezeigt werden soll. // Ansonsten setze Flag zur Anzeige if (hilfe == false) { hilfe = true; } // doppelter Parameter, der zu einer Exception führt else { throw new WrongParameterException("Doppelter Parameter -h"); } } // unbekannter Parameter, der zu einer Exception führt else { throw new WrongParameterException( "Fehlerhafter Parameter - " + parameter[i]); } } // wenn die Hilfe angezeigt werden soll, so unterbreche den // Programmfluss mit einer Exception, die allerdings keinen Fehler // erzeugt, sondern die Hilfe anzeigt if (hilfe == true) { throw new WrongParameterException(""); } // ist der Dateiname noch nicht gesetzt worden, so ist keine // weitere Verarbeitung möglich und das Programm wird mit einer // Exception abgebrochen else if (dateiName == null) { throw new WrongParameterException( "Falscher Aufruf - keine Eingabedatei angegeben"); } // wenn alles richtig verarbeitet wurde, gib den Dateinamen zurück return dateiName; }

---

Dokumentation der Datenelemente

boolean main.Main.debug = false [static]

setzt den Debug-Modus Definiert in Zeile 74 der Datei Main.java. Wird benutzt von main.Main.parameterParser().

Matrix main.Main.matrix = new Matrix() [static]

Die zentrale Datenstruktur mit der Matrix. Definiert in Zeile 80 der Datei Main.java.

final int main.Main.maxDimension = 6 [static]

maximale Größe der Matrix Definiert in Zeile 71 der Datei Main.java.

boolean main.Main.overwrite = false [static]

setzt den Overwrite-Modus Definiert in Zeile 77 der Datei Main.java. Wird benutzt von main.Main.parameterParser().

---

Die Dokumentation für diese Klasse wurde erzeugt aufgrund der Datei:

• Main.java

Documentation created with Doxygen 1.3.6	Fri May 14 11:15:33 2004