src/com/github/puzzles/core/AbstractPuzzle.java

   1 /**
   2  * All puzzles must inherit this class.
   3  */
   4 package com.github.puzzles.core;
   5
   6 public abstract class AbstractPuzzle {
   7
   8     private int size;
   9     private int counter;
  10     private Difficulty difficulty;
  11
  12     protected AbstractPuzzle(int size, int count, Difficulty difficulty) {
  13         this.size = size;
  14         this.counter = count;
  15         this.difficulty = difficulty;
  16     }
  17
  18     protected AbstractPuzzle(AbstractPuzzle puzzle) {
  19         this.size = puzzle.size;
  20         this.counter = puzzle.counter;
  21         this.difficulty = puzzle.difficulty;
  22     }
  23
  24     /**
  25      * Check to see if the puzzle is correct or not.
  26      *
  27      * @return true if the puzzle is correct, otherwise false.
  28      */
  29     public abstract boolean check();
  30
  31     /**
  32      * Increment the counter of played times.
  33      *
  34      * @return the counter.
  35      */
  36     protected int incrementCounter() {
  37         return --counter;
  38     }
  39
  40     /**
  41      * Decrement the counter of played times.
  42      *
  43      * @return the counter.
  44      */
  45     protected int decrementCounter() {
  46         return --counter;
  47     }
  48
  49     /**
  50      * Set the counter value.
  51      *
  52      * @param counter
  53      */
  54     protected void setCounter(int counter) {
  55         this.counter = counter;
  56     }
  57
  58     protected void reintialiseCounter() {
  59         this.counter = 0;
  60     }
  61
  62     /**
  63      * Getter.
  64      *
  65      * @return the size of the puzzle.
  66      */
  67     public final int getSize() {
  68         return size;
  69     }
  70
  71     /**
  72      * Getter.
  73      *
  74      * @return the number of the played times.
  75      */
  76     public final int getCounter() {
  77         return counter;
  78     }
  79
  80     /**
  81      * Getter.
  82      *
  83      * @return the difficulty of the puzzle.
  84      */
  85     public final Difficulty getDifficulty() {
  86         return difficulty;
  87     }
  88
  89     /*
  90      * (non-Javadoc)
  91      *
  92      * @see java.lang.Object#hashCode()
  93      */
  94     @Override
  95     public int hashCode() {
  96         final int prime = 31;
  97         int result = 1;
  98         result = prime * result + counter;
  99         result = prime * result
 100                 + ((difficulty == null) ? 0 : difficulty.hashCode());
 101         result = prime * result + size;
 102         return result;
 103     }
 104
 105     /*
 106      * (non-Javadoc)
 107      *
 108      * @see java.lang.Object#toString()
 109      */
 110     @Override
 111     public String toString() {
 112         return "AbstractPuzzle [size=" + size + ", counter=" + counter
 113                 + ", difficulty=" + difficulty + "]";
 114     }
 115
 116     /*
 117      * (non-Javadoc)
 118      *
 119      * @see java.lang.Object#equals(java.lang.Object)
 120      */
 121     @Override
 122     public boolean equals(Object obj) {
 123         if (this == obj) {
 124             return true;
 125         }
 126         if (obj == null) {
 127             return false;
 128         }
 129         if (getClass() != obj.getClass()) {
 130             return false;
 131         }
 132         AbstractPuzzle other = (AbstractPuzzle) obj;
 133         if (counter != other.counter) {
 134             return false;
 135         }
 136         if (difficulty != other.difficulty) {
 137             return false;
 138         }
 139         if (size != other.size) {
 140             return false;
 141         }
 142         return true;
 143     }
 144 }