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

Go to download
Show more of this group Show more artifacts with this name
Show all versions of refcodes-checkerboard Show documentation
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
package org.refcodes.checkerboard;

import org.refcodes.exception.VetoException;
import org.refcodes.observer.ObservableObserver;

/**
 * An asynchronous update interface for receiving notifications about
 * Checkerboard information as the Checkerboard is constructed.
 *
 * @param  the generic type
 * @param  the generic type
 */
public interface CheckerboardObserver
, S> extends ObservableObserver> {

	/**
	 * This method is called when information about an Checkerboard which was
	 * previously requested using an asynchronous interface becomes available.
	 *
	 * @param aCheckerboardEvent the checkerboard event
	 */
	void onCheckerboardEvent( CheckerboardEvent aCheckerboardEvent );

	/**
	 * This method is called when information about an Checkerboard which was
	 * previously requested using an asynchronous interface becomes available.
	 *
	 * @param aCheckerboardEvent the checkerboard event
	 */
	void onPlayerAddedEvent( PlayerAddedEvent aCheckerboardEvent );

	/**
	 * This method is called when information about an Checkerboard which was
	 * previously requested using an asynchronous interface becomes available.
	 *
	 * @param aCheckerboardEvent the checkerboard event
	 */
	void onPlayerRemovedEvent( PlayerRemovedEvent aCheckerboardEvent );

	/**
	 * This method is called when information about an Checkerboard which was
	 * previously requested using an asynchronous interface becomes available.
	 *
	 * @param aCheckerboardEvent the checkerboard event
	 */
	void onGridModeChangedEvent( GridModeChangedEvent aCheckerboardEvent );

	/**
	 * This method is called when information about an Checkerboard which was
	 * previously requested using an asynchronous interface becomes available.
	 *
	 * @param aCheckerboardEvent the checkerboard event
	 */
	void onGridDimensionChangedEvent( GridDimensionChangedEvent aCheckerboardEvent );

	/**
	 * This method is called when information about an Checkerboard which was
	 * previously requested using an asynchronous interface becomes available.
	 *
	 * @param aCheckerboardEvent the checkerboard event
	 */
	void onViewportOffsetChangedEvent( ViewportOffsetChangedEvent aCheckerboardEvent );

	/**
	 * This method is called when information about an Checkerboard which was
	 * previously requested using an asynchronous interface becomes available.
	 *
	 * @param aCheckerboardEvent the checkerboard event
	 */
	void onViewportDimensionChangedEvent( ViewportDimensionChangedEvent aCheckerboardEvent );

	/**
	 * This method is called when information about an Checkerboard which was
	 * previously requested using an asynchronous interface becomes available.
	 *
	 * @param aPlayerEvent the player event
	 * @param aSource The according source (origin).
	 */
	void onPlayerEvent( PlayerEvent
 aPlayerEvent, Checkerboard aSource );

	/**
	 * This method is called when information about an Checkerboard which was
	 * previously requested using an asynchronous interface becomes available.
	 *
	 * @param aPlayerEvent the player event
	 * @param aSource The according source (origin).
	 * @throws VetoException the veto exception
	 */
	void onChangePositionEvent( ChangePositionEvent
 aPlayerEvent, Checkerboard aSource ) throws VetoException;

	/**
	 * This method is called when information about an Checkerboard which was
	 * previously requested using an asynchronous interface becomes available.
	 *
	 * @param aPlayerEvent the player event
	 * @param aSource The according source (origin).
	 */
	void onPositionChangedEvent( PositionChangedEvent
 aPlayerEvent, Checkerboard aSource );

	/**
	 * This method is called when information about an Checkerboard which was
	 * previously requested using an asynchronous interface becomes available.
	 *
	 * @param aPlayerEvent the player event
	 * @param aSource The according source (origin).
	 */
	void onStateChangedEvent( StateChangedEvent aPlayerEvent, Checkerboard aSource );

	/**
	 * This method is called when information about an Checkerboard which was
	 * previously requested using an asynchronous interface becomes available.
	 *
	 * @param aPlayerEvent the player event
	 * @param aSource The according source (origin).
	 */
	void onVisibilityChangedEvent( VisibilityChangedEvent
 aPlayerEvent, Checkerboard aSource );

	/**
	 * This method is called when information about an Checkerboard which was
	 * previously requested using an asynchronous interface becomes available.
	 *
	 * @param aPlayerEvent the player event
	 * @param aSource The according source (origin).
	 */
	void onDraggabilityChangedEvent( DraggabilityChangedEvent aPlayerEvent, Checkerboard aSource );
}