Merge branch 'main' into final_changes

Author: Saleheddin

pom.xml

@@ -14,4 +14,19 @@
         <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
     </properties>
 
+    <dependencies>
+        <!-- https://mvnrepository.com/artifact/org.projectlombok/lombok -->
+        <dependency>
+            <groupId>org.projectlombok</groupId>
+            <artifactId>lombok</artifactId>
+            <version>1.18.24</version>
+            <scope>provided</scope>
+        </dependency>
+        <dependency>
+            <groupId>org.projectlombok</groupId>
+            <artifactId>lombok</artifactId>
+            <version>1.18.22</version>
+            <scope>compile</scope>
+        </dependency>
+    </dependencies>
 </project>

src/main/java/org/ecn/medev/Achetable.java

@@ -21,7 +21,7 @@ public abstract class Achetable extends Case {
     protected Joueur proprietaire;
 
     /**
-     * Constructeur pour une case achetable
+     * Constructeur pour une case achetable avec propriétaire. Le loyer est mis à 0 par défaut.
      * @param nom nom de la case
      * @param prix le prix de la case
      * @param proprietaire le proprietaire de la case
@@ -33,41 +33,70 @@ public Achetable(String nom, int prix, Joueur proprietaire) {
         this.proprietaire = proprietaire;
     }
 
-
+    /**
+     * Constructeur pour une case achetable sans propriétaire. Le loyer est mis à 0 par défaut.
+     * @param nom le nom de la case
+     * @param prix le prix de la case
+     */
     public Achetable(String nom, int prix) {
         super(nom);
         this.prix = prix;
         this.loyer = 0;
 
     }
 
+    /**
+     * Renvoie le prix d'achat de la case.
+     * @return le prix
+     */
     public int getPrix() {
         return prix;
     }
 
+    /**
+     * Renvoie le loyer sur la case.
+     * @return le loyer
+     */
     public int getLoyer() {
         return loyer;
     }
 
+    /**
+     * Renvoie le joueur propriétaire de la case.
+     * @return le joueur propriétaire
+     */
     public Joueur getProprietaire() {
         return proprietaire;
     }
 
+    /**
+     * Définit le prix de la case.
+     * @param prix le nouveau prix
+     */
     public void setPrix(int prix) {
         this.prix = prix;
     }
 
+    /**
+     * Définit le loyer sur la case.
+     * @param loyer le nouveau loyer
+     */
     public void setLoyer(int loyer) {
         this.loyer = loyer;
     }
 
+    /**
+     * Définit le propriétaire de la case.
+     * @param proprietaire le propriétaire de la case.
+     */
     public void setProprietaire(Joueur proprietaire) {
         this.proprietaire = proprietaire;
     }
 
     /**
-     *
-     * @param j
+     * Permet au joueur d'acheter la case.
+     * @param j le joueur acheteur
+     * @throws org.ecn.medev.NoMoreMoney
      */
     public void acheter(Joueur j) throws NoMoreMoney{
         this.setProprietaire(j);
@@ -78,30 +107,22 @@ public void acheter(Joueur j) throws NoMoreMoney{
     }
 
     /**
-    * <h1>CalculLoyer</h1>
-    * La méthode MAJ le prix du loyer lors de l'achat ou de la construction
-    * <p>
-    *
+    * Calcule le loyer sur la case. Le calcul est fait en fonction du type de case et du nombres de maisons et d'hotels.
     * @author  Thomas Canal
-    * @version 1.0
-    * @since   2022-11-17
     */
-    public void calculLoyer()
-    {
+    public void calculLoyer() {
         int loyer = 0;
         int a,b;
 
         a = 500;
         b = 100;
 
         //  est-ce une gare ?
-        if(this instanceof Constructible)
-        {
+        if(this instanceof Constructible) {
             loyer = a * this.prix *  ((Constructible)this).getNbHotels() + b * this.prix * ((Constructible)this).getNbMaisons();
         }
         // ou un constructible ?
-        else if(this instanceof Gare)
-        {
+        else if(this instanceof Gare) {
             loyer = 2500 * Plateau.instance.nbGares(this.getProprietaire());
         }
 
@@ -110,13 +131,17 @@ else if(this instanceof Gare)
 
 
 
+    /**
+     * Renvoie une chaine de caractères représentant la case.
+     * @return une chaine de caractères représentant la case.
+     */
     @Override
     public String toString() {
-        String achetableString = getNom() + "(cout : " + getPrix() + " )";
-        if (getProprietaire() == null) {
+        String achetableString = this.getNom() + "(cout : " + this.getPrix() + " )";
+        if (this.getProprietaire() == null) {
             return achetableString + " - Sans proprietaire";
         } else {
-            return achetableString + " - Proprietaire : " + getProprietaire() + ", loyer: " + getLoyer();
+            return achetableString + " - Proprietaire : " + this.getProprietaire() + ", loyer: " + this.getLoyer();
         }
     }
 

src/main/java/org/ecn/medev/Case.java

@@ -1,23 +1,46 @@
 package org.ecn.medev;
 
+/**
+ * Classe décrivant une case du plateau.
+ */
 public abstract class Case {
+    
+    /**
+     * Nom de la case.
+     */
     String nom;
 
+    /**
+     * Constructeurs pour une case.
+     * @param nom le nom de la case.
+     */
     public Case(String nom) {
         this.nom = nom;
     }
-
+    
+    /**
+     * Renvoie le nom de la case.
+     * @return le nom
+     */
     public String getNom() {
         return nom;
     }
 
+    /**
+     * Définit le nom de la case.
+     * @param nom le nouveau nom.
+     */
     public void setNom(String nom) {
         this.nom = nom;
     }
 
+    /**
+     * Renvoie une chaine de caractères représentant la case.
+     * @return 
+     */
     @Override
     public String toString() {
-        return "Case{" +
+        return "Case{ " +
                 "nom='" + nom + '\'' +
                 '}';
     }

src/main/java/org/ecn/medev/CaseSpeciale.java

@@ -1,35 +1,39 @@
 package org.ecn.medev;
 
 /**
- *
- * @author aulou
+ * Classe des cases spéciales
  */
 public class CaseSpeciale extends Case {
-   
-    
-    // Constructeur par défaut : case départ
+
 
     /**
-     *
+     * Constructeurs par défaut.
      */
      public CaseSpeciale(){
         super("Depart");
     }
 
-   public CaseSpeciale(String nom){
-      super(nom);
-   }
+     /**
+      * Constructeurs pour une case spéciale.
+      * @param nom le nom de la case spéciale
+      */
+    public CaseSpeciale(String nom){
+       super(nom);
+    }
 
     /**
-     *
-     * @return
+     * Renvoie le nom de la case.
+     * @return le nom
      */
     @Override
     public String getNom(){
         return(nom);
     }
 
-    public void effet(Joueur joueur) {
-        
+    /**
+     * Gère l'effet de la case sur le joueur.
+     * @param joueur le joueur affecté
+     */
+    public void effet(Joueur joueur) {  
     }
 }

src/main/java/org/ecn/medev/Chance.java

@@ -1,14 +1,21 @@
 package org.ecn.medev;
 
+/**
+ * Classe de la case spéciale Chance.
+ */
 public class Chance extends CaseSpeciale{
 
     /**
-     * Constructeur par defaut
+     * Constructeur de Chance.
      */
     public Chance() {
         super("Chance");
     }
 
+    /**
+     * Gére l'effet de la case Chance sur le joueur.
+     * @param joueur le joueur affecté.
+     */
     @Override
     public void effet(Joueur joueur) {
 

src/main/java/org/ecn/medev/Constructible.java

@@ -20,29 +20,65 @@ public class Constructible extends Achetable {
      */
     protected int nbHotels;
 
+    /**
+     * Constructeur pour une case constructible.
+     * @param nom le nom de la case
+     * @param prix le prix d'achat de la case
+     * @param proprietaire le propriétaire de la case
+     * @param nbMaisons le nombre de maisons sur la case
+     * @param nbHotels le nombre d'hotels sur la case
+     */
     public Constructible(String nom, int prix, Joueur proprietaire, int nbMaisons, int nbHotels) {
         super(nom, prix, proprietaire);
         this.nbMaisons = nbMaisons;
         this.nbHotels = nbHotels;
     }
 
+     /**
+     * Constructeur pour une case constructible.
+     * @param nom le nom de la case
+     */
     public Constructible(String nom){
-        super(nom, -1);
+        super(nom, 10000);
     }
-    
 
+     /**
+     * Constructeur pour une case constructible.
+     * @param nom le nom de la case
+     * @param prix le prix de la case
+     */
+    public Constructible(String nom, int prix){
+        super(nom, prix);
+    }
+    
+     /**
+     * Renvoie le nombre de maisons sur la case.
+     * @return le nombre de maisons
+     */
     public int getNbMaisons() {
         return nbMaisons;
     }
 
+     /**
+     * Renvoie le nombre d'hotels sur la case.
+     * @return le nombre de cases
+     */
     public int getNbHotels() {
         return nbHotels;
     }
 
+     /**
+     * Définit le nombre de maisons sur la case.
+     * @param nbMaisons le nouveau nombre de maison
+     */
     public void setNbMaisons(int nbMaisons) {
         this.nbMaisons = nbMaisons;
     }
 
+     /**
+     * Définit le nombre d'hotels sur la case.
+     * @param nbHotels le nouveau nombre d'hotels
+     */
     public void setNbHotels(int nbHotels) {
         this.nbHotels = nbHotels;
     }

src/main/java/org/ecn/medev/Depart.java

@@ -1,17 +1,22 @@
 package org.ecn.medev;
 
+/**
+ * Classe de la case Départ.
+ */
 public class Depart extends CaseSpeciale {
 
-
     /**
-     * Constructeur par defaut
+     * Constructeur de la case spéciale Départ.
      */
     public Depart() {
         super("Depart");
     }
 
+    /**
+     * Réalise l'effet de la case Départ sur le joueur.
+     * @param joueur le joueur affecté.
+     */
     @Override
     public void effet(Joueur joueur) {
-        
     }
 }