Piece.java

package com.charlesmadere.android.classygames.models.games.checkers;


import com.charlesmadere.android.classygames.models.games.GenericPiece;


/**
 * Class representing a single Checkers piece.
 */
public final class Piece extends GenericPiece
{


	public final static byte TYPE_NORMAL = 1;
	public final static byte TYPE_KING = 2;




	/**
	 * Creates a Piece object. As this constructor <strong>does not</strong>
	 * take a type parameter, this Piece's type will be set to the default
	 * (a normal piece).
	 * 
	 * @param team
	 * What team is this Piece on? Use one of this class's public members for
	 * this parameter. So that'd be either TEAM_OPPONENT or TEAM_PLAYER.
	 */
	public Piece(final byte team)
	{
		super(team, TYPE_NORMAL);
	}


	/**
	 * Creates a Piece object.
	 * 
	 * @param team
	 * What team is this Piece on? Use one of this class's public members for
	 * this parameter. So that'd be either TEAM_OPPONENT or TEAM_PLAYER.
	 * 
	 * @param type
	 * What type of Piece is this? Use one of this class's public members for
	 * this parameter. So that'd be either TYPE_NORMAL or TYPE_KING.
	 */
	public Piece(final byte team, final byte type)
	{
		super(team, type);
	}


	/**
	 * Creates a Piece object.
	 * 
	 * @param team
	 * What team is this Piece on? Use one of this class's public members for
	 * this parameter. So that'd be either TEAM_OPPONENT or TEAM_PLAYER.
	 * 
	 * @param type
	 * What type of Piece is this? Use one of this class's public members for
	 * this parameter. So that'd be either TYPE_NORMAL or TYPE_KING.
	 */
	public Piece(final byte team, final int type)
	{
		super(team, (byte) type);
	}


	/**
	 * Creates a Piece object that is a copy of the given Piece object.
	 *
	 * @param piece
	 * The Piece object to make a copy of.
	 */
	protected Piece(final Piece piece)
	{
		super(piece);
	}


	/**
	 * Crowns a Piece object. This Piece object is now a King.
	 */
	public void ascendToKing()
	{
		type = TYPE_KING;
	}


	/**
	 * Checks to see if this Piece is a normal piece.
	 * 
	 * @return
	 * Returns true if this Piece is a normal piece.
	 */
	public boolean isTypeNormal()
	{
		return type == TYPE_NORMAL;
	}


	/**
	 * Checks to see if this Piece is a king piece.
	 * 
	 * @return
	 * Returns true if this Piece is a king piece.
	 */
	public boolean isTypeKing()
	{
		return type == TYPE_KING;
	}




	@Override
	protected boolean checkIfTypeIsValid(final byte type)
	{
		switch (type)
		{
			case TYPE_NORMAL:
			case TYPE_KING:
				return true;

			default:
				return false;
		}
	}


	@Override
	public String toString()
	{
		final StringBuilder builder = new StringBuilder();

		switch (team)
		{
			case TEAM_PLAYER:
				builder.append("Player");
				break;

			case TEAM_OPPONENT:
				builder.append("Opponent");
				break;
		}

		builder.append(" ");

		switch (getType())
		{
			case TYPE_NORMAL:
				builder.append("Normal");
				break;

			case TYPE_KING:
				builder.append("King");
				break;
		}

		return builder.toString();
	}


}