org.dts.spell.finder

Interface WordFinder

All Known Implementing Classes:

AbstractWordFinder, CharSequenceWordFinder, StringBufferWordFinder, StringBuilderWordFinder

public interface WordFinder

An interface for iterates through the words.

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.

Author:

Jason Height (jheight@chariot.net.au), DreamTangerine (DreamTangerine@hotmail.com)

Method Summary

Modifier and Type	Method and Description
Word	current() This method should return the Word object representing the current word in the iteration.
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 new string

Method Detail

current

Word current()

This method should return the Word object representing the current word in the iteration. This method should not affect the state of the WordFinder object.

Returns:

the current Word object.

Throws:

WordNotFoundException - current word has not yet been set.

hasNext

boolean hasNext()

Tests the finder to see if any more words are available.

Returns:

true if more words are available.

next

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.)

Returns:

the next Word in the iteration.

Throws:

WordNotFoundException - search string contains no more words.

replace

void replace(String newWord)

This method should replace the current Word object with a new string

Parameters:

newWord - the word to replace the current word with.

Throws:

WordNotFoundException - current word has not yet been set.