fix: docstring spelling and unused variable

Author: inesiscosta

src/hva/app/App.java

@@ -6,7 +6,8 @@
 public class App {
 
   public static void main(String[] args) {
-    try (var ui = Dialog.UI) {
+    final var ui = Dialog.UI;
+    try (ui) {
       var manager = new hva.core.HotelManager();
       String datafile = System.getProperty("import");
       if (datafile != null) {

src/hva/app/vaccine/DoRegisterVaccine.java

@@ -25,7 +25,7 @@ protected final void execute() throws CommandException {
     var id = stringField("id");
     var name = stringField("name");
     var species = stringField("species");
-    /* Split The Species string into an array of species ids
+    /* Split the species string into an array of species ids
     ignoring leading and trailing spaces*/
     String[] speciesArray = species.split("\\s*,\\s*");
     try {

src/hva/core/Animal.java

@@ -23,7 +23,7 @@ public class Animal extends NamedEntity {
    * 
    * @param id the animal's unique identifier
    * @param name the animal's name
-   * @param species The Species the animal belongs to
+   * @param species the species the animal belongs to
    * @param habitat the habitat the animal is in
    */
   Animal(String id, String name, Species species, Habitat habitat) {
@@ -41,9 +41,9 @@ the class Habitat holds.*/
   }
 
   /**
-   * Gets The Species the animal belongs to.
+   * Gets the species the animal belongs to.
    *
-   * @return The Species object the animal belongs to
+   * @return the Species object the animal belongs to
    */
   Species species() {
     return _species;
@@ -60,7 +60,7 @@ Habitat habitat() {
 
   /**
    * Changes the animal to a different habitat. 
-   * If the animal already is in the destination habitat it doesnt 
+   * If the animal already is in the destination habitat it doesn't 
    * change anything.
    * 
    * @param newHabitat the new habitat to move the animal to

src/hva/core/CaseInsensitiveHashMap.java

@@ -4,9 +4,9 @@
 import java.util.HashMap;
 
 /**
- * Custom HasMap override that trets all the ids strings as case insensitive
- * it doesnt distingues between lower and upper case, it makes all the ids 
- * lower case before calling the super methods provided by the HashMap class.
+ * Custom HashMap override that treats all the id strings as case insensitive
+ * it does so by forcing all ids to be lowercase before calling the super
+ * methods provided by the HashMap class.
  */
 public class CaseInsensitiveHashMap<T extends NamedEntity>
 extends HashMap<String, T> {
@@ -15,23 +15,23 @@ public class CaseInsensitiveHashMap<T extends NamedEntity>
   private static final long serialVersionUID = 202410250009L;
 
   /**
-  * Puts the object in the map with the key in lower case.
+  * Puts the object in the map given a key.
   */
   @Override
   public T put(String key, T value) {
     return super.put(key.toLowerCase(), value);
   }
 
   /**
-  * Gets the object from the map with the key in lower case.
+  * Gets the object from the map given a key.
   */
   @Override
   public T get(Object key) {
     return super.get(((String)key).toLowerCase());
   }
 
   /**
-   * Checks if the map contains the key in lower case.
+   * Checks if the map contains the key given a key.
    */
   @Override
   public boolean containsKey(Object key) {
@@ -44,7 +44,7 @@ public T putIfAbsent(String key, T value) {
   }
 
   /**
-   * Removes the object from the map with the key in lower case.
+   * Removes the object from the map given a key.
    */
   @Override
   public T remove(Object key) {

src/hva/core/Habitat.java

@@ -195,18 +195,18 @@ Tree identifyTree(String id) {
    * Gets the influence of the habitat on a species. 
    * Used to calculate an animal's satisfaction.
    *
-   * @param species The Species to get the influence of the habitat on
+   * @param species the species to get the influence of the habitat on
    * @return the influence of the habitat on the species
    */
   Influence identifyInfluence(Species species) {
-    // Returns NEU if The Species isn't in the map, indicating neutral influence.
+    // Returns NEU if the species isn't in the map, indicating neutral influence.
     return _influences.getOrDefault(species, Influence.NEU);
   }
 
   /**
    * Changes the influence value a habitat has on a given species.
    * 
-   * @param species The Species influenced (POS, NEG, NEU) by the habitat
+   * @param species the species influenced (POS, NEG, NEU) by the habitat
    * @param newInfluence the new influence value the habitat has on the
    * species
    */
@@ -305,7 +305,7 @@ Collection<Tree> listTrees() {
   /**
    * Counts the number of animals of a given species in a habitat.
    * 
-   * @param species The Species to count the number of animals of
+   * @param species the species to count the number of animals of
    * @return the total number of animals of the given species in the habitat
    */
   int getNumAnimalsSameSpecies(Species species) {

src/hva/core/HealthStatus.java

@@ -39,10 +39,10 @@ public String toString() {
 
   /**
    * Determines the health status of an animal based on the damage incurred
-   * by the vaccine and wether The Species is correct.
+   * by the vaccine and whether the species is correct.
    * 
    * @param damage the damage suffered by the animal as the result of a vaccine
-   * @param correctSpecies a boolean indicating whether The Species is correct
+   * @param correctSpecies a boolean indicating whether the species is correct
    * @return the effect on an animal's health as a result of the vaccine
    * @throws InvalidDamageValueException if the damage is invalid
    * (if the damage is less than 0)

src/hva/core/Hotel.java

@@ -200,9 +200,9 @@ public Animal identifyAnimal(String idAnimal)
   /**
    * Identifies a species by its id.
    * 
-   * @param idSpecies the id of The Species to identify
-   * @return The Species object with the given id
-   * @throws UnknownSpeciesIdException if The Species with the given id
+   * @param idSpecies the id of the species to identify
+   * @return the Species object with the given id
+   * @throws UnknownSpeciesIdException if the species with the given id
    * is not found
    */
   public Species identifySpecies(String idSpecies)
@@ -232,7 +232,7 @@ public Employee identifyEmployee(String idEmployee)
    * 
    * @param idVet the id of the veterinarian to identify
    * @return the veterinarian object with the given id
-   * @throws UnknownVeterinarianIdException
+   * @throws UnknownEmployeeIdException
    * if the veterinarian with the given id is not found
    */
   public Veterinarian identifyVet(String idVet)
@@ -286,7 +286,7 @@ public Habitat registerHabitat(String id, String name, int area)
    * @throws UnknownHabitatIdException if the habitat with the given id
    * is not found
    * @throws DuplicateAnimalIdException if the id is already used
-   * @throws UnknownSpeciesIdException if The Species with the given id
+   * @throws UnknownSpeciesIdException if the species with the given id
    * is not found
    */
   public void registerAnimal(String idAnimal, String name, String idSpecies,
@@ -309,7 +309,7 @@ private boolean animalAlreadyExists(String idAnimal) {
    * Checks if a species already exists in the hotel.
    * 
    * @param idSpecies the species' id to check
-   * @return true if The Species already exists, false otherwise
+   * @return true if the species already exists, false otherwise
    */
   public boolean speciesAlreadyExists(String idSpecies) {
     return _species.containsKey(idSpecies);
@@ -329,7 +329,7 @@ public void registerSpecies(String id, String name)
       throw new DuplicateSpeciesIdException(id);
     if (_speciesByName.containsKey(name))
       throw new DuplicateSpeciesNameException(name);
-    // Only adds The Species if both the id and the name are unique
+    // Only adds the species if both the id and the name are unique
     Species newSpecies = new Species(id, name);
     _species.put(id, newSpecies);
     _speciesByName.put(name, newSpecies);
@@ -372,7 +372,7 @@ public void registerEmployee(String id, String name, String type)
    * @param idVaccine the vaccine's unique identifier
    * @param name the vaccine's name
    * @param speciesIds the species' ids that the vaccine is suitable for
-   * @throws UnknownSpeciesIdException if The Species with the given id
+   * @throws UnknownSpeciesIdException if the species with the given id
    * is not found
    * @throws DuplicateVaccineIdException if a vaccine with the same id
    * already exists
@@ -404,7 +404,7 @@ public boolean addVaccinationRecord(String idVaccine, String idVet,
     Animal animal = identifyAnimal(idAnimal);
     _vaccinationRecords.add(vet.vaccinate(identifyVaccine(idVaccine), animal));
     notifyHotelObservers();
-    return vaccine.isSpeciesApropriated(animal.species());
+    return vaccine.isSpeciesAppropriate(animal.species());
   }
 
   /**
@@ -427,29 +427,31 @@ public String idSpeciesAnimal(String idAnimal) {
    * Adds a responsibility to an employee.
    * 
    * @param idEmployee the employee's unique identifier
-   * @param idReponsibility the responsibility's unique identifier
-   * @throws UnknownIdException if the employee with the given id is not found
+   * @param idResponsibility the responsibility's unique identifier
+   * @throws UnknownEmployeeIdException if the employee with the given id is
+   * not found
    * @throws UnknownResponsibilityException if responsibility with the given id
    * is not found
    */
-  public void addResponsibility(String idEmployee, String idReponsibility)
+  public void addResponsibility(String idEmployee, String idResponsibility)
   throws UnknownEmployeeIdException, UnknownResponsibilityIdException {
-    identifyEmployee(idEmployee).addResponsibility(idReponsibility);
+    identifyEmployee(idEmployee).addResponsibility(idResponsibility);
     notifyHotelObservers();
   }
 
   /**
    * Removes a responsibility of an employee.
    * 
    * @param idEmployee the employee's unique identifier
-   * @param idReponsibility the responsibility's unique identifier
+   * @param idResponsibility the responsibility's unique identifier
    * @throws UnknownIdException if the employee with the given id is not found
    * @throws UnknownResponsibilityException if responsibility with the given id
    * is not found
    */
-  public void removeResponsibility(String idEmployee, String idReponsibility)
-  throws EmployeeNotResponsibleException, UnknownEmployeeIdException, UnknownResponsibilityIdException {
-    identifyEmployee(idEmployee).removeResponsibility(idReponsibility);
+  public void removeResponsibility(String idEmployee, String idResponsibility)
+  throws EmployeeNotResponsibleException, UnknownEmployeeIdException,
+  UnknownResponsibilityIdException {
+    identifyEmployee(idEmployee).removeResponsibility(idResponsibility);
     notifyHotelObservers();
   }
 
@@ -494,11 +496,11 @@ public void changeHabitatArea(String id, int area)
    * Change the influence that a habitat has over a species
    * 
    * @param idHabitat the habitat to add the influence
-   * @param idSpecies The Species it will affected
+   * @param idSpecies the species it will affected
    * @param influence the new influence the habitat will have over the
    * species in question
-   * @throws UnknownHabitatIdException if the habitat doesnt exist in the hotel
-   * @throws UnknownSpeciesIdException if The Species doesnt exist
+   * @throws UnknownHabitatIdException if the habitat doesn't exist in the hotel
+   * @throws UnknownSpeciesIdException if the species doesn't exist
    */
   public void changeHabitatInfluence(String idHabitat, String idSpecies,
   String influence) throws UnknownHabitatIdException,
@@ -513,7 +515,7 @@ public void changeHabitatInfluence(String idHabitat, String idSpecies,
    * 
    * @param idAnimal the animal to transfer to another habitat
    * @param idHabitat the destination habitat
-   * @throws UnknownAnimalIdException if the animal doesnt exist in any of
+   * @throws UnknownAnimalIdException if the animal doesn't exist in any of
    * the habitats in the hotel
    * @throws UnknownHabitatIdException if the destination habitat doesnt exist
    * in the hotel
@@ -577,7 +579,7 @@ public Collection<Tree> listAllTreesHabitat(String idHabitat)
    * 
    * @param idHabitat the habitat to list all animals from
    * @return an unmodifiableCollection of all animals from the habitat
-   * @throws UnknownHabitatIdException if the habitat doesnt exist in this
+   * @throws UnknownHabitatIdException if the habitat doesn't exist in this
    * hotel
    */
   public Collection<Animal> listAnimalsInHabitat(String idHabitat)
@@ -610,8 +612,8 @@ public Collection<VaccinationRecord> listVaccinationRecords() {
    * Lists all vaccination records of vaccines given to a given
    * animal in a string containing information about each record.
    * 
-   * @param animal the animal to list the vaccination records of
-   * @return  an unmodifiable List containing the VaccinationRecord objects
+   * @param id the id of the animal to list the vaccination records of
+   * @return an unmodifiable List containing the VaccinationRecord objects
    * of a specific animal
    */
   public Collection<VaccinationRecord> listAnimalVaccinationHistory(String id)
@@ -626,7 +628,7 @@ public Collection<VaccinationRecord> listAnimalVaccinationHistory(String id)
    * Lists all vaccination records of vaccines administered by a given vet
    * in a string containing information about each record.
    * 
-   * @param vet the veterinarian to list the vaccination records of
+   * @param id the id of the veterinarian to list the vaccination records of
    * @return an unmodifiable List containing the VaccinationRecord object
    * of all vaccination records of vaccines administered by the given vet
    */

src/hva/core/Vaccine.java

@@ -22,7 +22,7 @@ class Vaccine extends NamedEntity {
    *
    * @param id the vaccine's unique identifier
    * @param name the vaccine's name
-   * @param appropiateSpecies a list of The Species the vaccine is suitable for
+   * @param appropiateSpecies a list of the species the vaccine is suitable for
    */
   Vaccine(String id, String name, List<Species> appropiateSpecies) {
     super(id, name);
@@ -36,7 +36,7 @@ int numApplications() {
     return _numApplications;
   }
 
-  boolean isSpeciesApropriated(Species species) {
+  boolean isSpeciesAppropriate(Species species) {
     return _appropiateSpecies.contains(species);
   }