Generierte Dokumentation der praktischen Arbeit von Simon Tiffert

Hauptseite | Pakete | Klassenhierarchie | Alphabetische Liste | Auflistung der Klassen | Auflistung der Dateien | Klassen-Elemente

# main.tools.eingabe.MyLineNumberReader Klassenreferenz

Klassendiagramm für main.tools.eingabe.MyLineNumberReader:

[Legende]
Zusammengehörigkeiten von main.tools.eingabe.MyLineNumberReader:

[Legende]
Aufstellung aller Elemente

## Ausführliche Beschreibung

Klasse, welche Zeilenendkommentar überliest.

Version:
  Revision
    1.4

Autor:
  Simon Tiffert

Definiert in Zeile 29 der Datei MyLineNumberReader.java.

## Öffentliche Methoden
| MyLineNumberReader (Reader reader, String kommentar)
| Der Kommentar, der überlesen werden soll, wird definiert und der Standardkonstruktor der Superklasse wird aufgerufen.
String | readLine () throws IOException
| Die Funktionalität der Supermethode wird beibehalten, allerdings werden Zeilen, die mit einem oben definierten Kommentar beginnen, nicht mit ausgegeben.
## Private Methoden
String | stripLine (String zeile)
| Diese Funktion entfernt Zeilenendkommentar.
## Private Attribute
String | kommentar = ""

## Beschreibung der Konstruktoren und Destruktoren

main.tools.eingabe.MyLineNumberReader.MyLineNumberReader | ( | Reader | reader,
|  | String | kommentar
| ) |

  | Der Kommentar, der überlesen werden soll, wird definiert und der Standardkonstruktor der Superklasse wird aufgerufen. Parameter:
  reader |
  kommentar |
Definiert in Zeile 41 der Datei MyLineNumberReader.java.
    00042   {
    00043     // Konstruktor der Superklasse und setzen des Kommentars
    00044     super(reader);
    00045     this.kommentar = kommentar;
    00046   }

## Dokumentation der Elementfunktionen

String main.tools.eingabe.MyLineNumberReader.readLine | ( |  | ) | throws IOException

| Die Funktionalität der Supermethode wird beibehalten, allerdings werden Zeilen, die mit einem oben definierten Kommentar beginnen, nicht mit ausgegeben. Siehe auch: java.io.BufferedReader#readLine() Definiert in Zeile 56 der Datei MyLineNumberReader.java. Benutzt main.tools.eingabe.MyLineNumberReader.stripLine().
    00057   {
    00058     // Der Ausgabestring wird mit der ersten Zeile vorbesetzt, aus der
    00059     // Kommentar und Zwischenraumzeichen entfernt wurden
    00060     String ausgabe = stripLine(super.readLine());
    00061
    00062     // wenn die Ausgabe nicht null ist
    00063     if (ausgabe != null)
    00064     {
    00065       // solange nur noch ein leerer String übrig bleibt, lese
    00066       // die nächste Zeile und entferne Kommentar und weitere
    00067       // Zwischenraumzeichen
    00068       while (ausgabe.length() == 0)
    00069       {
    00070         ausgabe = stripLine(super.readLine());
    00071
    00072         // wenn die Zeile null ist, so gebe dies zurück
    00073         if (ausgabe == null)
    00074         {
    00075           return ausgabe;
    00076         }
    00077       }
    00078     }
    00079
    00080     // gib die überarbeitete Zeile zurück
    00081     return ausgabe;
    00082   }

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

String main.tools.eingabe.MyLineNumberReader.stripLine | ( | String | zeile | ) | `[private]`

  | Diese Funktion entfernt Zeilenendkommentar. Parameter:
  zeile | Die Zeile, die bearbeitet werden soll
Rückgabe: Die Zeile, in der kein Kommentar mehr steht Definiert in Zeile 90 der Datei MyLineNumberReader.java. Benutzt main.tools.eingabe.MyLineNumberReader.kommentar. Wird benutzt von main.tools.eingabe.MyLineNumberReader.readLine().
    00091   {
    00092     // wenn die Zeile ungleich null ist, bearbeite sie
    00093     if (zeile != null)
    00094     {
    00095       // wenn Kommentar vorhanden ist, schneide diesen ab
    00096       if (zeile.indexOf(kommentar) >= 0)
    00097       {
    00098         // entferne unnötige Leerzeichen an Anfang und Ende
    00099         return zeile.substring(0, zeile.indexOf(kommentar)).trim();
    00100       }
    00101       else
    00102       {
    00103         // entferne unnötige Leerzeichen an Anfang und Ende
    00104         return zeile.trim();
    00105       }
    00106     }
    00107
    00108     // gib die Zeile zurück
    00109     return zeile;
    00110   }

## Dokumentation der Datenelemente

String main.tools.eingabe.MyLineNumberReader.kommentar = ""`[private]`

| Definiert in Zeile 32 der Datei MyLineNumberReader.java. Wird benutzt von main.tools.eingabe.MyLineNumberReader.stripLine().

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

- MyLineNumberReader.java

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