package jrummikub.model;

import jrummikub.util.Pair;

/**
 * Interface for the {@link StoneTray} model
 * 
 * @param <E>
 *            Objects held by the IStoneTray
 */
public interface IStoneTray<E extends Sizeable> extends
		Iterable<Pair<E, Position>>, Cloneable {

	/**
	 * 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);

	/**
	 * Tries to pick up (remove) a given object
	 * 
	 * @param object
	 *            object to pick up
	 * @return true when the object was successfully removed
	 */
	public boolean pickUp(E object);

	/**
	 * Create a clone of the StoneTray
	 * 
	 * @return cloned StoneTray
	 */
	public IStoneTray<E> clone();

	/**
	 * Return the number of objects on the tray
	 * 
	 * @return number of objects
	 */
	public int getSize();

}