/*
 * $Id: Letter.java 3364 2006-07-10 10:33:29Z gbevin $ $Revision: 3364 $ $Date:
 * 2005-10-02 12:04:34 +0200 (So, 02 Okt 2005) $
 *
 * ==============================================================================
 * Licensed under the Apache License, Version 2.0 (the "License"); you may not
 * use this file except in compliance with the License. You may obtain a copy of
 * the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
 * License for the specific language governing permissions and limitations under
 * the License.
 */
package model;

import java.io.Serializable;

/**
 * Model for a letter in the game of hangman
 *
 * @author Jonathan Locke
 * @author Geert Bevin
 */
public class Letter implements Serializable {
	/** True if the letter has been guessed */
	private boolean guessed;
	
	/** The letter */
	private char letter;
	
	/**
	 * Constructor
	 *
	 * @param letter
	 *            The letter
	 */
	public Letter(final char letter) {
		this.letter = letter;
	}
	
	/**
	 * @return This letter as a string
	 */
	public String asString() {
		return Character.toString(letter);
	}
	
	/**
	 * @see java.lang.Object#equals(java.lang.Object)
	 */
	public boolean equals(final Object object) {
		if (object instanceof Letter) {
			final Letter that = (Letter)object;
			return that.letter == this.letter && that.guessed == this.guessed;
		}
		return false;
	}
	
	/**
	 * Guess this letter
	 */
	public void guess() {
		this.guessed = true;
	}
	
	/**
	 * @see java.lang.Object#hashCode()
	 */
	public int hashCode() {
		return letter << (guessed ? 1 : 0);
	}
	
	/**
	 * @return Returns the isGuessed.
	 */
	public boolean isGuessed() {
		return guessed;
	}
	
	/**
	 * Resets this letter into the default state
	 */
	public void reset() {
		this.guessed = false;
	}
	
	/**
	 * @see java.lang.Object#toString()
	 */
	public String toString() {
		return "[Letter letter = " + letter + ", guessed = " + guessed + "]";
	}
}