cse1030

Class AbstractWordPuzzle

java.lang.Object

cse1030.AbstractWordPuzzle

Direct Known Subclasses:

MissingVowelsPuzzle, ReverseWordPuzzle, ScrambledWordPuzzle

public abstract class AbstractWordPuzzle
extends Object

Abstract base class for simple word puzzles such as scrambled word puzzles (where the puzzle word is made up of the letters of the original word in random order). This class provides storage and access to the puzzle word. Subclasses are responsible for providing storage and access to the solution word or words.

Author:

EECS1030_2014_15W

Constructor Summary

Constructors

Constructor and Description
AbstractWordPuzzle() Constructor that creates an word puzzle whose puzzle word is the empty string.
AbstractWordPuzzle(String puzzleWord) Constructor that sets the puzzle word.

Method Summary

Methods

Modifier and Type	Method and Description
String	getPuzzleWord() Get the puzzle word
abstract String	getSolution() Get the solution word.
SortedSet<String>	getSolutions() Get a sorted set of all of the solution words.
void	setPuzzleWord(String puzzleWord) Set the puzzle word for this puzzle.
String	toString() Get the string representation of the puzzle.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

AbstractWordPuzzle

public AbstractWordPuzzle()

Constructor that creates an word puzzle whose puzzle word is the empty string.

AbstractWordPuzzle

public AbstractWordPuzzle(String puzzleWord)

Constructor that sets the puzzle word.

Parameters:

puzzleWord - the puzzle word

Method Detail

getSolution

public abstract String getSolution()

Get the solution word. For word puzzles with more than one solution this method returns the solution that comes first in dictionary order.

Returns:

the solution word that comes first in dictionary order

getSolutions

public SortedSet<String> getSolutions()

Get a sorted set of all of the solution words. AbstractWordPuzzle provides an implementation of this method that returns the set containing one string equal to the string returned by this.getSolution(). Subclasses should override this method if the word puzzle has multiple solutions.

The set returned by this method cannot be used to modify the solutions for this puzzle.

Returns:

a sorted set of solution words

getPuzzleWord

public final String getPuzzleWord()

Get the puzzle word

Returns:

the puzzle word

setPuzzleWord

public final void setPuzzleWord(String puzzleWord)

Set the puzzle word for this puzzle.

Parameters:

puzzleWord - the puzzle word

toString

public String toString()

Get the string representation of the puzzle. The string is the puzzle word, followed by " : " followed by a comma separated list of solutions words.

Overrides:

toString in class Object

See Also:

Object.toString()

Returns:

the string representation of the puzzle