fix violations

Author: HabibaMekay

table-inheritance/src/main/java/com/iluwatar/Car.java

@@ -1,22 +1,52 @@
 package com.iluwatar;
 
+/**
+ * Represents a car with a specific number of doors.
+ */
 public class Car extends Vehicle {
   private int numDoors;
 
+  /**
+   * Constructs a Car object.
+   *
+   * @param year     the manufacturing year
+   * @param make     the make of the car
+   * @param model    the model of the car
+   * @param numDoors the number of doors
+   * @param id       the unique identifier for the car
+   */
   public Car(int year, String make, String model, int numDoors, int id) {
     super(year, make, model, id);
     this.numDoors = numDoors;
   }
 
-  public void SetNumDoors(int doors){
-    this.numDoors=doors;
+  /**
+   * Sets the number of doors for the car.
+   *
+   * @param doors the number of doors
+   */
+  public void setNumDoors(int doors) {
+    this.numDoors = doors;
   }
-  public int GetNumDoors(){
+
+  /**
+   * Gets the number of doors for the car.
+   *
+   * @return the number of doors
+   */
+  public int getNumDoors() {
     return numDoors;
   }
 
-  @Override public String toString() {
-    return "Car{" + "id=" + getId() + ", make='" + getMake() + '\'' + ", model='" + getModel() + '\'' + ", year=" + getYear() + ", numberOfDoors=" + GetNumDoors() + '}';
+  @Override
+  public String toString() {
+    return "Car{"
+        + "id=" + getId()
+        + ", make='" + getMake() + '\''
+        + ", model='" + getModel() + '\''
+        + ", year=" + getYear()
+        + ", numberOfDoors=" + getNumDoors()
+        + '}';
   }
-
 }
+

table-inheritance/src/main/java/com/iluwatar/Main.java

@@ -1,11 +1,20 @@
 package com.iluwatar;
 
+/**
+ * The main entry point of the application demonstrating the use of vehicles.
+ */
 public class Main {
+
+  /**
+   * The main method to demonstrate adding and retrieving vehicles from the database.
+   *
+   * @param args command-line arguments
+   */
   public static void main(String[] args) {
-    Vehicle_Database database = new Vehicle_Database();
+    VehicleDatabase database = new VehicleDatabase();
 
     Car car = new Car(2020, "Toyota", "Corolla", 4, 1);
-    Truck truck = new Truck(2018, "Ford", "F-150", 60,2);
+    Truck truck = new Truck(2018, "Ford", "F-150", 60, 2);
 
     database.saveVehicle(car);
     database.saveVehicle(truck);
@@ -21,4 +30,4 @@ public static void main(String[] args) {
     Truck retrievedTruck = database.getTruck(truck.getId());
     System.out.println("Retrieved Truck: " + retrievedTruck);
   }
-}
+}

table-inheritance/src/main/java/com/iluwatar/Truck.java

@@ -1,20 +1,56 @@
 package com.iluwatar;
 
+/**
+ * Represents a truck, a type of vehicle with a specific load capacity.
+ */
 public class Truck extends Vehicle {
   private double loadCapacity;
 
+  /**
+   * Constructs a Truck object with the given parameters.
+   *
+   * @param year         the year of manufacture
+   * @param make         the make of the truck
+   * @param model        the model of the truck
+   * @param loadCapacity the load capacity of the truck
+   * @param id           the unique ID of the truck
+   */
   public Truck(int year, String make, String model, double loadCapacity, int id) {
-    super(year,make, model, id);
-    this.loadCapacity=loadCapacity;
+    super(year, make, model, id);
+    this.loadCapacity = loadCapacity; // Added spaces around '='
   }
 
-  public void SetLoadCapacity(double capacity){
-    this.loadCapacity=capacity;
+  /**
+   * Sets the load capacity of the truck.
+   *
+   * @param capacity the new load capacity
+   */
+  public void setLoadCapacity(double capacity) {
+    this.loadCapacity = capacity; // Added spaces around '='
   }
-  public double GetLoadCapacity(){
+
+  /**
+   * Retrieves the load capacity of the truck.
+   *
+   * @return the load capacity
+   */
+  public double getLoadCapacity() {
     return loadCapacity;
   }
 
-  @Override public String toString() {
-    return "Truck{" + "id=" + getId() + ", make='" + getMake() + '\'' + ", model='" + getModel() + '\'' + ", year=" + getYear() + ", payloadCapacity=" + GetLoadCapacity() + '}'; }
-}
+  /**
+   * Returns a string representation of the truck.
+   *
+   * @return a string with the truck's details
+   */
+  @Override
+  public String toString() {
+    return "Truck{"
+        + "id=" + getId()
+        + ", make='" + getMake() + '\''
+        + ", model='" + getModel() + '\''
+        + ", year=" + getYear()
+        + ", payloadCapacity=" + getLoadCapacity()
+        + '}';
+  }
+}

table-inheritance/src/main/java/com/iluwatar/Vehicle.java

@@ -1,48 +1,114 @@
 package com.iluwatar;
 
-public class Vehicle{
+/**
+ * Represents a generic vehicle with basic attributes like make, model, year, and ID.
+ */
+public class Vehicle {
 
-  private String make, model;
-  private int year, id;
+  private String make;
+  private String model;
+  private int year;
+  private int id;
 
-
-  Vehicle(int year, String make, String model, int id){
-    this.make=make;
-    this.model=model;
-    this.year=year;
-    this.id=id;
+  /**
+   * Constructs a Vehicle object with the given parameters.
+   *
+   * @param year  the year of manufacture
+   * @param make  the make of the vehicle
+   * @param model the model of the vehicle
+   * @param id    the unique ID of the vehicle
+   */
+  public Vehicle(int year, String make, String model, int id) {
+    this.make = make; // Added spaces around '='
+    this.model = model;
+    this.year = year;
+    this.id = id;
   }
 
-  public void setMake(String make){
-    this.make=make;
+  /**
+   * Sets the make of the vehicle.
+   *
+   * @param make the make to set
+   */
+  public void setMake(String make) {
+    this.make = make; // Added spaces around '='
   }
+
+  /**
+   * Gets the make of the vehicle.
+   *
+   * @return the make
+   */
   public String getMake() {
     return make;
   }
 
-  public void setModel(String model){
-    this.model=model;
+  /**
+   * Sets the model of the vehicle.
+   *
+   * @param model the model to set
+   */
+  public void setModel(String model) {
+    this.model = model; // Added spaces around '='
   }
-  public String getModel(){
+
+  /**
+   * Gets the model of the vehicle.
+   *
+   * @return the model
+   */
+  public String getModel() {
     return model;
   }
 
-  public void setYear(int year){
-    this.year=year;
+  /**
+   * Sets the year of manufacture for the vehicle.
+   *
+   * @param year the year to set
+   */
+  public void setYear(int year) {
+    this.year = year; // Added spaces around '='
   }
-  public int getYear(){
+
+  /**
+   * Gets the year of manufacture for the vehicle.
+   *
+   * @return the year
+   */
+  public int getYear() {
     return year;
   }
 
+  /**
+   * Gets the unique ID of the vehicle.
+   *
+   * @return the ID
+   */
   public int getId() {
     return id;
   }
+
+  /**
+   * Sets the unique ID of the vehicle.
+   *
+   * @param id the ID to set
+   */
   public void setId(int id) {
-    this.id = id;
+    this.id = id; // Added spaces around '='
   }
 
-
-  @Override public String toString() {
-    return "Vehicle{" + "id=" + id + ", make='" + make + '\'' + ", model='" + model + '\'' + ", year=" + year + '}';
+  /**
+   * Returns a string representation of the vehicle.
+   *
+   * @return a string with the vehicle's details
+   */
+  @Override
+  public String toString() {
+    return "Vehicle{"
+        + "id=" + id
+        + ", make='" + make + '\''
+        + ", model='" + model + '\''
+        + ", year=" + year
+        + '}';
   }
-}
+}

table-inheritance/src/main/java/com/iluwatar/VehicleDatabase.java

@@ -0,0 +1,68 @@
+package com.iluwatar;
+
+import java.util.HashMap;
+import java.util.Map;
+
+/**
+ * Manages the storage and retrieval of Vehicle objects, including Cars and Trucks.
+ */
+public class VehicleDatabase {
+
+  private Map<Integer, Vehicle> vehicleTable = new HashMap<>();
+  private Map<Integer, Car> carTable = new HashMap<>();
+  private Map<Integer, Truck> truckTable = new HashMap<>();
+
+  /**
+   * Saves a vehicle to the database. If the vehicle is a Car or Truck, it is added to the respective table.
+   *
+   * @param vehicle the vehicle to save
+   */
+  public void saveVehicle(Vehicle vehicle) {
+    vehicleTable.put(vehicle.getId(), vehicle);
+    if (vehicle instanceof Car) {
+      carTable.put(vehicle.getId(), (Car) vehicle);
+    } else if (vehicle instanceof Truck) {
+      truckTable.put(vehicle.getId(), (Truck) vehicle);
+    }
+  }
+
+  /**
+   * Retrieves a vehicle by its ID.
+   *
+   * @param id the ID of the vehicle
+   * @return the vehicle with the given ID, or null if not found
+   */
+  public Vehicle getVehicle(int id) {
+    return vehicleTable.get(id);
+  }
+
+  /**
+   * Retrieves a car by its ID.
+   *
+   * @param id the ID of the car
+   * @return the car with the given ID, or null if not found
+   */
+  public Car getCar(int id) {
+    return carTable.get(id);
+  }
+
+  /**
+   * Retrieves a truck by its ID.
+   *
+   * @param id the ID of the truck
+   * @return the truck with the given ID, or null if not found
+   */
+  public Truck getTruck(int id) {
+    return truckTable.get(id);
+  }
+
+  /**
+   * Prints all vehicles in the database.
+   */
+  public void printAllVehicles() {
+    for (Vehicle vehicle : vehicleTable.values()) {
+      System.out.println(vehicle);
+    }
+  }
+}
+