Skip to content
Snippets Groups Projects
Commit 457ba116 authored by AREZKI Celia's avatar AREZKI Celia
Browse files

BoardProperties : add the documentation

parent e53a58ab
No related branches found
No related tags found
No related merge requests found
......@@ -4,9 +4,39 @@ import util.Position;
import java.util.List;
public interface BoardProperties {
/**
* Interface représentant les propriétés d'un tableau générique pour la gestion de l'état.
*
* @param <S> Le type d'état utilisé pour les éléments du tableau.
*/
public interface BoardProperties<S> {
/**
* Retourne le nombre de lignes du tableau.
*
* @return Le nombre de lignes.
*/
int rowCount(); // Nombre de lignes.
/**
* Retourne le nombre de colonnes du tableau.
*
* @return Le nombre de colonnes.
*/
int columnCount(); // Nombre de colonnes.
List<ModelElement> getState(Position position); // État des éléments sur une position donnée.
void setState(List<ModelElement> state, Position position);
/**
* Retourne l'état des éléments situés à une position spécifique du tableau.
*
* @param position La position sur le tableau pour laquelle récupérer l'état.
* @return L'état des éléments à la position donnée.
*/
S getState(Position position); // État des éléments sur une position donnée.
/**
* Définit l'état des éléments à une position spécifique du tableau.
*
* @param state L'état à définir pour la position donnée.
* @param position La position sur le tableau pour laquelle définir l'état.
*/
void setState(S state, Position position);
}
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment