summaryrefslogtreecommitdiffstats
path: root/src/jrummikub/model/ITable.java
blob: 3b0032fee079fd4ab80bf9ae898b5bd60697addb (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
package jrummikub.model;

import jrummikub.util.Pair;

/**
 * Interface for the {@link Table} model
 */
public interface ITable extends IStoneTray<StoneSet> {

	/**
	 * Removes {@link Stone} from the Table
	 * 
	 * @param stone
	 *            stone to pick up
	 * @return the stone sets that are created by taking pickung the the stone
	 */
	public Pair<StoneSet, StoneSet> pickUpStone(Stone stone);

	/**
	 * Tests the Table for rule conflicts by checking all the {@link StoneSet}
	 * 
	 * @return whether all sets on the table are valid
	 */
	public boolean isValid();

	/**
	 * Finds the {@link StoneSet} containing the given {@link Stone}
	 * @param stone stone whose set we're searching
	 * @return the set containing the stone or null if no set was found
	 */
	StoneSet findStoneSet(Stone stone);

}