Added interfaces for model classes

git-svn-id: svn://sunsvr01.isp.uni-luebeck.de/swproj13/trunk@104 72836036-5685-4462-b002-a69064685172

src/jrummikub/control/TurnControl.java

@@ -2,19 +2,19 @@ package jrummikub.control;
 
 
 import jrummikub.model.Hand;
-import jrummikub.model.Table;
+import jrummikub.model.ITable;
 import jrummikub.util.Event;
 import jrummikub.util.IEvent;
 import jrummikub.view.IView;
 
 public class TurnControl {
 	private Hand hand;
-	private Table table;
+	private ITable table;
 	private TurnTimer timer;
 	private IView view;
 	private Event endOfTurnEvent = new Event();
 	
-	public TurnControl(Hand hand, Table table, IView view) {
+	public TurnControl(Hand hand, ITable table, IView view) {
 		this.hand = hand;
 		this.table = table;
 		this.view = view;

src/jrummikub/model/GameState.java

@@ -6,12 +6,13 @@ import java.util.List;
 
 /** Class managing the overall and momentary GameState */
 public class GameState {
-	Table table;
+	ITable table;
 	List<Player> players;
 	int activePlayer;
 	private StoneHeap gameHeap;
 
 	public GameState() {
+		table = new Table();
 		players = new ArrayList<Player>();
 		players.add(new Player(Color.red));
 		players.add(new Player(Color.yellow));
@@ -20,6 +21,10 @@ public class GameState {
 		activePlayer = 0;
 	}
 
+	public ITable getTable() {
+		return table;
+	}
+
 	/** Changes the activePlayer to the next {@link Player} in the list */
 	public void nextPlayer() {
 		activePlayer = (activePlayer + 1) % 4;
@@ -32,5 +37,4 @@ public class GameState {
 	public StoneHeap getGameHeap() {
 		return gameHeap;
 	}
-
 }

src/jrummikub/model/Hand.java

@@ -1,6 +1,6 @@
 package jrummikub.model;
 
 /** Class managing a {@link Player}'s {@link Stone}s */
-public class Hand extends StoneTray<Stone> {
+public class Hand extends StoneTray<Stone> implements IHand {
 
 }

src/jrummikub/model/IHand.java

@@ -0,0 +1,5 @@
+package jrummikub.model;
+
+public interface IHand extends IStoneTray<Stone> {
+
+}

src/jrummikub/model/IStoneTray.java

@@ -0,0 +1,40 @@
+package jrummikub.model;
+
+import jrummikub.util.Pair;
+
+public interface IStoneTray<E extends Sizeable> extends
+		Iterable<Pair<E, Position>> {
+
+	/**
+	 * Removes object from tray and returns it
+	 * 
+	 * @param position
+	 *          position of the object that will be removed
+	 * @return the picked up stone
+	 */
+	public E pickUp(Position position);
+
+	/**
+	 * Adds object to the tray
+	 * 
+	 * @param object
+	 *          object to add to Hand
+	 * @param position
+	 *          {@link Position} to put the object
+	 */
+	public void drop(E object, Position position);
+
+	/**
+	 * Returns the position of an object that is already on the tray
+	 * 
+	 * @param object
+	 *          object whose position is requested
+	 * @return position of the object or null when the object is not on the tray
+	 */
+	public Position getPosition(E object);
+
+	public void pickUp(E object);
+
+	public IStoneTray<E> clone();
+
+}

src/jrummikub/model/ITable.java

@@ -0,0 +1,16 @@
+package jrummikub.model;
+
+public interface ITable {
+
+	/**
+	 * Removes {@link Stone} from the Table
+	 * 
+	 * @param stone
+	 *          stone to pick up
+	 */
+	public void pickUpStone(Stone stone);
+
+	/** Tests the Table for rule conflicts by checking all the {@link StoneSet} */
+	public boolean isValid();
+
+}

src/jrummikub/model/Player.java

@@ -4,22 +4,22 @@ import java.awt.Color;
 
 /** Class managing player data. No methods in release 1 */
 public class Player {
+
+	private IHand hand;
+	private Color color;
+
+	// private String name;
+
 	public Player(Color color) {
+		hand = new Hand();
 		this.color = color;
 	}
 
-	private Hand hand;
-
-	private Color color;
-
-	public Hand getHand() {
+	public IHand getHand() {
 		return hand;
 	}
 
 	public Color getColor() {
 		return color;
 	}
-
-	// private String name;
-
 }

src/jrummikub/model/StoneTray.java

@@ -11,10 +11,9 @@ import jrummikub.util.Pair;
  * or {@link StoneSet}s.
  * 
  * @param <E>
- *            Type of positioned objects (must implement Sizeable)
+ *          Type of positioned objects (must implement Sizeable)
  */
-public class StoneTray<E extends Sizeable> implements
-		Iterable<Pair<E, Position>> {
+public class StoneTray<E extends Sizeable> implements IStoneTray<E> {
 	protected HashMap<E, Position> objects = new HashMap<E, Position>();
 
 	/** Possible move directions in case of overlapping Stones/Sets */
@@ -23,13 +22,12 @@ public class StoneTray<E extends Sizeable> implements
 		LEFT, RIGHT, TOP, BOTTOM;
 	}
 
-	/**
-	 * Removes object from tray and returns it
+	/*
+	 * (non-Javadoc)
 	 * 
-	 * @param position
-	 *            position of the object that will be removed
-	 * @return the picked up stone
+	 * @see jrummikub.model.IStoneTray#pickUp(jrummikub.model.Position)
 	 */
+	@Override
 	public E pickUp(Position position) {
 		for (Map.Entry<E, Position> i : objects.entrySet()) {
 			Position currentPosition = i.getValue();
@@ -41,12 +39,10 @@ public class StoneTray<E extends Sizeable> implements
 			if (position.getY() < currentPosition.getY()) {
 				continue;
 			}
-			if (position.getX() > currentPosition.getX()
-					+ currentObject.getWidth()) {
+			if (position.getX() > currentPosition.getX() + currentObject.getWidth()) {
 				continue;
 			}
-			if (position.getY() > currentPosition.getY()
-					+ currentObject.getHeight()) {
+			if (position.getY() > currentPosition.getY() + currentObject.getHeight()) {
 				continue;
 			}
 			// Position is inside the current object
@@ -56,14 +52,12 @@ public class StoneTray<E extends Sizeable> implements
 		return null;
 	}
 
-	/**
-	 * Adds object to the tray
+	/*
+	 * (non-Javadoc)
 	 * 
-	 * @param object
-	 *            object to add to Hand
-	 * @param position
-	 *            {@link Position} to put the object
+	 * @see jrummikub.model.IStoneTray#drop(E, jrummikub.model.Position)
 	 */
+	@Override
 	public void drop(E object, Position position) {
 		if (object != null) {
 			drop(object, position, null);
@@ -72,11 +66,11 @@ public class StoneTray<E extends Sizeable> implements
 
 	@SuppressWarnings("unchecked")
 	private void drop(E object, Position position, Direction direction) {
-		for (Map.Entry<E, Position> i : ((Map<E,Position>)objects.clone()).entrySet()) {
+		for (Map.Entry<E, Position> i : ((Map<E, Position>) objects.clone())
+				.entrySet()) {
 			Position currentPosition = i.getValue();
 			E currentObject = i.getKey();
-			if (!objectsOverlap(object, position, currentObject,
-					currentPosition)) {
+			if (!objectsOverlap(object, position, currentObject, currentPosition)) {
 				continue;
 			}
 			// Object would be placed inside the current object
@@ -87,23 +81,23 @@ public class StoneTray<E extends Sizeable> implements
 			// Move object to avoid overlap
 			switch (direction) {
 			case TOP:
-				newPosition = new Position(currentPosition.getX(),
-						position.getY() - currentObject.getHeight());
+				newPosition = new Position(currentPosition.getX(), position.getY()
+						- currentObject.getHeight());
 				break;
 			case BOTTOM:
-				newPosition = new Position(currentPosition.getX(),
-						position.getY() + object.getHeight());
+				newPosition = new Position(currentPosition.getX(), position.getY()
+						+ object.getHeight());
 				break;
 			case LEFT:
-				newPosition = new Position(position.getX()
-						- currentObject.getWidth(), currentPosition.getY());
+				newPosition = new Position(position.getX() - currentObject.getWidth(),
+						currentPosition.getY());
 				break;
 			case RIGHT:
 				newPosition = new Position(position.getX() + object.getWidth(),
 						currentPosition.getY());
 				break;
 			}
-			
+
 			objects.remove(i.getKey());
 			drop(currentObject, newPosition, direction);
 		}
@@ -159,37 +153,36 @@ public class StoneTray<E extends Sizeable> implements
 		float blockingRight = blocking.getValue().getX()
 				+ blocking.getKey().getWidth();
 		float overlapRight = Math.min(objectRight, blockingRight);
-		float overlapLeft = Math.max(position.getX(), blocking.getValue()
-				.getX());
+		float overlapLeft = Math.max(position.getX(), blocking.getValue().getX());
 		float overlapX = overlapRight - overlapLeft;
 		float objectBottom = position.getY() + object.getHeight();
 		float blockingBottom = blocking.getValue().getY()
 				+ blocking.getKey().getHeight();
 		float overlapBottom = Math.min(objectBottom, blockingBottom);
-		float overlapTop = Math.max(position.getY(), blocking.getValue()
-				.getY());
+		float overlapTop = Math.max(position.getY(), blocking.getValue().getY());
 		float overlapY = overlapBottom - overlapTop;
 		// vertical or horizontal Shift
 		// TODO magic factor
 		return overlapX > overlapY;
 	}
 
-	/**
-	 * Returns the position of an object that is already on the tray
+	/*
+	 * (non-Javadoc)
 	 * 
-	 * @param object
-	 *            object whose position is requested
-	 * @return position of the object or null when the object is not on the tray
+	 * @see jrummikub.model.IStoneTray#getPosition(E)
 	 */
+	@Override
 	public Position getPosition(E object) {
 		return objects.get(object);
 	}
 
 	@Override
 	public Iterator<Pair<E, Position>> iterator() {
-		final Iterator<Map.Entry<E, Position>> entryIterator = objects.entrySet().iterator();
+		final Iterator<Map.Entry<E, Position>> entryIterator = objects.entrySet()
+				.iterator();
 		return new Iterator<Pair<E, Position>>() {
 			Iterator<Map.Entry<E, Position>> iterator = entryIterator;
+
 			@Override
 			public boolean hasNext() {
 				return iterator.hasNext();
@@ -205,18 +198,29 @@ public class StoneTray<E extends Sizeable> implements
 			public void remove() {
 				iterator.remove();
 			}
-			
+
 		};
 	}
 
+	/*
+	 * (non-Javadoc)
+	 * 
+	 * @see jrummikub.model.IStoneTray#pickUp(E)
+	 */
+	@Override
 	public void pickUp(E object) {
 		objects.remove(object);
 	}
-	
-	
+
+	/*
+	 * (non-Javadoc)
+	 * 
+	 * @see jrummikub.model.IStoneTray#clone()
+	 */
+	@SuppressWarnings("unchecked")
 	@Override
-	public StoneTray<E> clone() {
-		StoneTray<E> copy = new StoneTray();
+	public IStoneTray<E> clone() {
+		StoneTray<E> copy = new StoneTray<E>();
 		copy.objects = (HashMap<E, Position>) objects.clone();
 		return copy;
 	}

src/jrummikub/model/Table.java

@@ -4,7 +4,7 @@ import jrummikub.util.Pair;
 
 /** Class administering the {@link Stone}s on the game-Table */
 
-public class Table extends StoneTray<StoneSet> {
+public class Table extends StoneTray<StoneSet> implements ITable {
 
 	/**
 	 * Removes {@link Stone} from the Table
@@ -12,6 +12,7 @@ public class Table extends StoneTray<StoneSet> {
 	 * @param stone
 	 *            stone to pick up
 	 */
+	@Override
 	public void pickUpStone(Stone stone) {
 		// Find the set of the stone
 		StoneSet set = null;
@@ -66,6 +67,7 @@ public class Table extends StoneTray<StoneSet> {
 	}
 
 	/** Tests the Table for rule conflicts by checking all the {@link StoneSet} */
+	@Override
 	public boolean isValid() {
 		for (Pair<StoneSet, Position> i : this) {
 			if (!i.getFirst().isValid()) {