Ajout doc pour les classes pricipales
This commit is contained in:
@@ -15,6 +15,10 @@ public class AbstractChangementFactoryNP implements AbstractChangementFactory {
|
||||
// Si il y a beaucoup de changements c'est plus rapide que de parcourir toute une liste.
|
||||
private HashMap<Integer,Changement> brain;
|
||||
|
||||
/**
|
||||
* Constructeur de l'usine à changement.
|
||||
* @param agf l'usine à groupe travaillant en tandem avec cette usine.
|
||||
*/
|
||||
public AbstractChangementFactoryNP(AbstractGroupeFactory agf){
|
||||
Objects.requireNonNull(agf,"On ne peut pas créer une usine à changement dont l'usine à groupe parternaire est null");
|
||||
this.agf=agf;
|
||||
@@ -44,6 +48,8 @@ public class AbstractChangementFactoryNP implements AbstractChangementFactory {
|
||||
|
||||
/**
|
||||
* permet de mettre en oeuvre un changement connu de l'usine abstraite.
|
||||
*
|
||||
* @param c le changement à mettre en oeuvre.
|
||||
*
|
||||
* @throws java.lang.NullPointerException si un argument est null
|
||||
* @throws java.lang.IllegalStateException si le changement n'a pas de sens en l'état actuel (e.g. étudiant pas dans le groupe de départ a, groupe b inconnu, groupe a inconnu, etc).
|
||||
@@ -70,7 +76,9 @@ public class AbstractChangementFactoryNP implements AbstractChangementFactory {
|
||||
|
||||
/**
|
||||
* permet de supprimer un changement connu de l'usine abstraite.
|
||||
*
|
||||
*
|
||||
* @param c le changement à supprimer.
|
||||
*
|
||||
* @throws java.lang.NullPointerException si un argument est null
|
||||
* @throws java.lang.IllegalArgumentException si inconnu de l'usine abstraite
|
||||
*/
|
||||
@@ -101,7 +109,18 @@ public class AbstractChangementFactoryNP implements AbstractChangementFactory {
|
||||
this.brain.put(Integer.valueOf(c.getId()),c);
|
||||
}
|
||||
|
||||
|
||||
/**
|
||||
* permet d'ajouter un nouveau changement.
|
||||
*
|
||||
* @param A groupe actuel
|
||||
* @param B groupe demandé
|
||||
* @param e étudiant concerné par le changement
|
||||
* @param raison la raison du changement
|
||||
*
|
||||
* @throws java.lang.NullPointerException si un argument est null
|
||||
* @throws java.lang.IllegalArgumentException si les groupes ou l'étudiant ne sont pas connus de la factory partenaire, ou e n'appartient pas à A ou A et B ne sont pas frères dans l'arbre des groupes.
|
||||
*
|
||||
*/
|
||||
@Override
|
||||
public void createChangement(Groupe A, Etudiant e, Groupe B, String raison) {
|
||||
Objects.requireNonNull(A,"Le groupe d'origine ne peut pas être null");
|
||||
|
||||
Reference in New Issue
Block a user