tutorial.hangman
Class HangmanGame

java.lang.Object
  |
  +--tutorial.hangman.HangmanGame
All Implemented Interfaces:
java.io.Serializable

public class HangmanGame
extends java.lang.Object
implements java.io.Serializable

The logic for a game of Hangman.

Version:
$Id: HangmanGame.java,v 1.3 2001/05/02 18:07:07 hship Exp $
Author:
Howard Ship
See Also:
Serialized Form

Constructor Summary
HangmanGame()
           
 
Method Summary
 boolean getDone()
          Returns true when all letters have been guessed.
 boolean getFailed()
          Returns true when the maximum number of misses has been reached.
 char[] getGuessed()
          Returns an array of characters, each position is either a correctly guessed letter, or an underscore (for an as-yet unguessed letter).
 int getMaxMisses()
           
 int getMissed()
           
 char[] getUnusedLetters()
          Returns an array of unused letters that may be guessed.
 java.lang.String getWord()
          Returns the word being guessed.
 void guess(char letter)
          Guesses a letter.
 void start(java.lang.String word, int maxMisses)
          Starts a new game, resetting the number of misses.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

HangmanGame

public HangmanGame()
Method Detail

start

public void start(java.lang.String word,
                  int maxMisses)
Starts a new game, resetting the number of misses.

getFailed

public boolean getFailed()
Returns true when the maximum number of misses has been reached.

getDone

public boolean getDone()
Returns true when all letters have been guessed.

getGuessed

public char[] getGuessed()
Returns an array of characters, each position is either a correctly guessed letter, or an underscore (for an as-yet unguessed letter).

getWord

public java.lang.String getWord()
Returns the word being guessed.

guess

public void guess(char letter)
           throws GameException
Guesses a letter. Returns the number of letters left to guess.
Parameters:
letter - a single letter, in the range 'A' to 'Z'.
Throws:
GameException - if the letter doesn't appear in the word.

getUnusedLetters

public char[] getUnusedLetters()
Returns an array of unused letters that may be guessed.

getMissed

public int getMissed()

getMaxMisses

public int getMaxMisses()