Interface wbuch

All Known Implementing Classes:
Woerterbuch

interface wbuch

Interface, welches die Schnittstelle des Wörterbuchs definiert

Version:
1.0
Author:
Markus Burger-Scheidlin 2683838 Vitus Lorenz-Meyer 2691370

Method Summary
 void addWord(java.lang.String word)
          Fügt dem Wörterbuch ein Wort hinzu.
 boolean checkWord(java.lang.String word)
          Überprüft, ob ein Wort im Wörterbuch vorhanden ist.
 int readFromFile(java.lang.String filename)
          Liest das Wörterbuch aus einem Textfile ein.
 boolean removeWord(java.lang.String word)
          Löscht ein Wort aus dem Wörterbuch
 void writeToFile(java.lang.String filename)
          Schreibt das Wörterbuch in ein Textfile Format: Wort1 Wort2 Wort3 ...
 

Method Detail

addWord

public void addWord(java.lang.String word)
             throws java.lang.IllegalArgumentException
Fügt dem Wörterbuch ein Wort hinzu.
Parameters:
word - Das Wort, das hinzugefügt werden soll
Throws:
java.lang.IllegalArgumentException - wird ausgelöst, wenn es sich um ein ungültiges Eingabewort handelt.

removeWord

public boolean removeWord(java.lang.String word)
                   throws java.lang.IllegalArgumentException
Löscht ein Wort aus dem Wörterbuch
Parameters:
word - Das Wort, das gelöscht werden soll
Returns:
true bei Erfolg, sonst false
Throws:
java.lang.IllegalArgumentException - wird ausgelöst, wenn es sich um ein ungültiges Eingabewort handelt.

checkWord

public boolean checkWord(java.lang.String word)
                  throws java.lang.IllegalArgumentException
Überprüft, ob ein Wort im Wörterbuch vorhanden ist.
Parameters:
word - Das Wort, das überprüft wird
Returns:
true, wenn das Wort im Wörterbuch enthalten ist, sonst false
Throws:
java.lang.IllegalArgumentException - wird ausgelöst, wenn es sich um ein ungültiges Eingabewort handelt.

readFromFile

public int readFromFile(java.lang.String filename)
                 throws java.io.IOException,
                        java.io.FileNotFoundException
Liest das Wörterbuch aus einem Textfile ein. Format: Wort1 Wort2 Wort3 ...
Parameters:
filename - Der Name des Textfiles
Throws:
java.io.IOException - tritt auf, wenn beim Lesen ein Fehler aufgetreten ist. FileNotFoundException tritt auf, wenn das Textfile nicht gefunden wurde

writeToFile

public void writeToFile(java.lang.String filename)
                 throws java.io.IOException
Schreibt das Wörterbuch in ein Textfile Format: Wort1 Wort2 Wort3 ...
Parameters:
filename - Der Name des Textfiles
Throws:
java.io.IOException - tritt auf, wenn beim Lesen ein Fehler aufgetreten ist.