Tile.java

/** MineSweeper
 *  @author Chase Carnaroli
 *
 *  Each location on the grid has a Tile class
 *
 *  INSTANCE VARIABLES
 *      boolean mine                // represents whether or not the tile has a mine
 *      boolean flagged             // represents whether or not the tile is flagged
 *      Location loc                // the location of the tile on the grid
 *      int neighboorsWithMines     // number of neighboors with mines
 *      boolean turned              // represents whether or not the tile has been turned
 *      boolean questionMark        // represents whether or not the tile is question marked
 *      Color textColor             // color for the text
 *
 *  METHODS
 *      getLocation() -> Location   // returns the location of the tile
 *      plantMine()                 // plants a mine on this tile
                                    // post: mine set to true
 *      setFlag(boolean)            // set whether or not the tile is flagged
                                    // post: flagged is set to the boolean passed through the method
 *      isFlagged() -> boolean      // returns true is tile is flagged, false if not
 *      setQuestionMark(boolean)    // set whether or not the tile is question marked
                                    // post: questionMark is set to the boolean passed through the method
 *      turnTile() -> boolean       // post: if tile wasn't turned already, it sets turn to true and returns true, else returns false
 *      isTurned() -> boolean       // returns true if tile is turned, false if not
 *      hasMine() -> boolean        // returns true if tile has mine, false if not
 *      setNum(int)                 // post: sets neighboorsWithMines to the int passed through
 *      setColor(int)               // sets color of tile based off of the number of mines around it
 *      getNum() -> int             // returns number of neighboors with mines
 *      getColor() -> Color         // returns color for the text
 *      toString() -> String        // returns string of the int value of number of neighboors. If value == 0, returns and empty string
 */

 import java.awt.Color;   // imports color class

public class Tile
{
    // instance variables
    private boolean mine;               // represents whether or not the tile has a mine
    private boolean flagged;            // represents whether or not the tile is flagged
    private Location loc;               // the location of the tile on the grid
    private int neighboorsWithMines;    // number of neighboors with mines
    private boolean turned;             // represents whether or not the tile has been turned
    private boolean questionMark;       // represents whether or not the tile is question marked
    private Color textColor;            // color of the text

    /**
     * Constructor for objects of class Tile
     */
    public Tile(Location location)
    {
        // initialise instance variables
        loc = location;
        mine = false;
        flagged = false;
        turned = false;
        questionMark = false;
        textColor = null;
    }

    // returns the location of the tile
    public Location getLocation(){
        return loc;
    }

    // plants a mine on this tile
    // post: mine set to true
    public void plantMine(){
        mine = true;
    }

    // set whether or not the tile is flagged
    // post: flagged is set to the boolean passed through the method
    public void setFlag(boolean flag){
        flagged = flag;
    }

    // returns true is tile is flagged, false if not
    public boolean isFlagged(){
        return flagged;
    }

    // set whether or not the tile is question marked
    // post: questionMark is set to the boolean passed through the method
    public void setQuestionMark(boolean question){
        questionMark = question;
    }

    // post: returns true is tile is question marked, false if not
    public boolean isQuestionMarked(){
        return questionMark;
    }

    // post: if tile wasn't turned already, it sets turn to true and returns true, else returns false
    public boolean turnTile(){
        if(!turned){
            turned = true;
            return true;
        } else {
            return false;
        }
    }

    // returns true if tile is turned, false if not
    public boolean isTurned(){
        return turned;
    }

    // returns true if tile has mine, false if not
    public boolean hasMine(){
        return mine;
    }

    // post: sets neighboorsWithMines to the int passed through
    public void setNum(int neighboors){
        // set number for tile
        neighboorsWithMines = neighboors;
        // set color
        setColor(neighboors);
    }

    // post: sets color of tile based off of the number of mines around it
    public void setColor(int num){
      // set color for tile
      switch(num){
        case 1: textColor = Color.BLUE;
                break;
        case 2: textColor = Color.GREEN;
                break;
        case 3: textColor = Color.RED;
                break;
        case 4: textColor = new Color(128, 0, 128);   // purple
                break;
        case 5: textColor = new Color(128, 0, 0);     // maroon
                break;
        case 6: textColor = new Color(64, 224, 208);  // turquoise
                break;
        case 7: textColor = Color.BLACK;
                break;
        case 8: textColor = Color.GRAY;
                break;
        default: textColor = null;
                break;
      }
    }

    // returns number of neighboors with mines
    public int getNum(){
        return neighboorsWithMines;
    }

    // returns color for the text
    public Color getColor(){
        return textColor;
    }

    // returns string of the int value of number of neighboors. If value == 0, returns and empty string
    public String toString(){
        if(neighboorsWithMines == 0){
            return "";
        } else {
            return neighboorsWithMines + "";
        }
    }
}