Amélioration de la javadoc

This commit is contained in:
2025-03-07 22:13:57 +01:00
parent f1f378d68d
commit 3e9fa75023
11 changed files with 234 additions and 899 deletions

View File

@@ -2,14 +2,36 @@ package fr.monlouyan.bakefile;
import java.io.File;
import java.util.List;
import java.util.Date;
/**
* Représente une règle du fichier Bakefile.
* Chaque règle est composée d'un nom, d'une liste de dépendances et d'une liste de commandes.
* Une règle peut être phony, c'est-à-dire qu'elle n'a pas de fichier cible associé.
*
* @author Moncef STITI, Yanis HAMOUDI, Louay DARDOURI
* @version 1.0
*/
public class Rule {
/*** Nom de la règle */
private String name;
/*** Liste des dépendances de la règle */
private List<String> dependencies;
/*** Liste des commandes */
private List<String> commands;
/*** true si la règle est phony, false sinon */
private boolean isPhony;
/**
* Constructeur de la classe Rule.
* @param name Nom de la règle
* @param dependencies Liste des dépendances
* @param commands Liste des commandes
* @param isPhony true si la règle est phony, false sinon
*/
public Rule(String name, List<String> dependencies, List<String> commands, boolean isPhony) {
this.name = name;
this.dependencies = dependencies;
@@ -17,12 +39,40 @@ public class Rule {
this.isPhony = isPhony;
}
/**
* Récupère le nom de la règle.
* @return Le nom de la règle
*/
public String getName() { return name; }
/**
* Récupère la liste des dépendances de la règle.
* @return La liste des dépendances
*/
public List<String> getDependencies() { return dependencies; }
/**
* Récupère la liste des commandes de la règle.
* @return La liste des commandes
*/
public List<String> getCommands() { return commands; }
/**
* Vérifie si la règle est phony.
* @return true si la règle est phony, false sinon.
*/
public boolean isPhony() { return isPhony; }
/**
* Vérifie si la règle est vide (sans dépendances ni commandes).
* @return true si la règle est vide, false sinon
*/
public boolean isEmpty() { return dependencies.isEmpty() && commands.isEmpty(); }
/**
* Vérifie si la règle doit être mise à jour.
* @return true si la règle doit être mise à jour, false sinon
*/
public boolean needsUpdate() {
if (BakeCLI.isDebug()){
System.out.println("Debug : Checking if rule " + name + " needs update");