All Downloads are FREE. Search and download functionalities are using the official Maven repository.

org.refcodes.checkerboard.Sprites Maven / Gradle / Ivy

Go to download

Artifact for providing some easy means to visualize (state of) board games or (state of) cellular automatons.

There is a newer version: 3.3.8
Show newest version
// /////////////////////////////////////////////////////////////////////////////
// REFCODES.ORG
// /////////////////////////////////////////////////////////////////////////////
// This code is copyright (c) by Siegfried Steiner, Munich, Germany and licensed
// under the following (see "http://en.wikipedia.org/wiki/Multi-licensing")
// licenses:
// -----------------------------------------------------------------------------
// GNU General Public License, v3.0 ("http://www.gnu.org/licenses/gpl-3.0.html")
// -----------------------------------------------------------------------------
// Apache License, v2.0 ("http://www.apache.org/licenses/LICENSE-2.0")
// -----------------------------------------------------------------------------
// Please contact the copyright holding author(s) of the software artifacts in
// question for licensing issues not being covered by the above listed licenses,
// also regarding commercial licensing models or regarding the compatibility
// with other open source licenses.
// /////////////////////////////////////////////////////////////////////////////

package org.refcodes.checkerboard;

import java.util.Collection;
import java.util.Set;

import org.refcodes.structure.Relation;

/**
 * The Interface Sprites.
 *
 * @author steiner
 * @param  the generic type
 * @param  the generic type
 * @param  the generic type
 */
public interface Sprites, S, IMG> {

	// /////////////////////////////////////////////////////////////////////////
	// CONSTANTS:
	// /////////////////////////////////////////////////////////////////////////

	// /////////////////////////////////////////////////////////////////////////
	// METHODS:
	// /////////////////////////////////////////////////////////////////////////

	/**
	 * With sprite.
	 *
	 * @param aRelation the relation
	 * @return the sps
	 */
	SPS withSprite( Relation aRelation );

	/**
	 * With sprite.
	 *
	 * @param aStatus the status
	 * @param aSprite the sprite
	 * @return the sps
	 */
	SPS withSprite( S aStatus, IMG aSprite );

	/**
	 * Removes the sprite.
	 *
	 * @param aStatus the status
	 * @return the img
	 */
	IMG removeSprite( S aStatus );

	/**
	 * Clear sprites.
	 */
	void clearSprites();

	/**
	 * Checks for sprites.
	 *
	 * @return true, if successful
	 */
	boolean hasSprites();

	/**
	 * Sprite count.
	 *
	 * @return the int
	 */
	int spriteCount();

	/**
	 * Values.
	 *
	 * @return the collection
	 */
	Collection values();

	/**
	 * States.
	 *
	 * @return the sets the
	 */
	Set states();

	/**
	 * Gets the sprite.
	 *
	 * @param aStatus the status
	 * @return the sprite
	 */
	IMG getSprite( S aStatus );

	/**
	 * Contains sprite.
	 *
	 * @param aStatus the status
	 * @return true, if successful
	 */
	boolean containsSprite( S aStatus );

	/**
	 * Put sprite.
	 *
	 * @param aRelation the relation
	 * @return the img
	 */
	IMG putSprite( Relation aRelation );

	/**
	 * Put sprite.
	 *
	 * @param aStatus the status
	 * @param aSprite the sprite
	 * @return the img
	 */
	IMG putSprite( S aStatus, IMG aSprite );

}