com.swabunga.spell.event
public interface WordFinder
An interface for objects which take a String as input, and iterates through the words in the string.
When the object is instantiated, and before the first call to next()
is made,
the following methods should throw a WordNotFoundException
:
current()
,
startsSentence()
and replace()
.
A call to next()
when hasMoreWords()
returns false
should throw a WordNotFoundException
.
Method Summary | |
---|---|
Word | current()
This method should return the Word object representing the current word
in the iteration.
|
String | getText()
This method returns the text through which the WordFinder is iterating.
|
boolean | hasNext()
Tests the finder to see if any more words are available.
|
Word | next()
This method should return the Word object representing the next word
in the iteration (the first word if next() has not yet been called.)
|
void | replace(String newWord)
This method should replace the current Word object with a Word object
representing the String newWord.
|
void | setText(String newText)
This method resets the text through which the WordFinder iterates.
|
boolean | startsSentence()
Indicates if the current word starts a new sentence. |
Returns: the current Word object.
Throws: WordNotFoundException current word has not yet been set.
Returns: the (possibly modified) text being searched.
Returns: true if more words are available.
Returns: the next Word in the iteration.
Throws: WordNotFoundException search string contains no more words.
Parameters: newWord the word to replace the current word with.
Throws: WordNotFoundException current word has not yet been set.
Parameters: newText the new text to search.
Returns: true if the current word starts a new sentence.
Throws: WordNotFoundException current word has not yet been set.