Add JavaDoc

src/main/java/shift/Lab/Application.java

@@ -20,15 +20,22 @@
 @SpringBootApplication
 public class Application {
 
+    /**
+     * Поле для сервиса товара
+     */
     @Autowired
     private ProductService productService;
 
+    /**
+     * Поле для сервиса товара типа pc
+     */
     @Autowired
     private PcService pcService;
 
     public static void main(String[] args) {
         SpringApplication.run(Application.class, args);
     }
+
     /**
      * Метод создает продукты нужного типа для начального добавления продуктов в базу данных
      */

src/main/java/shift/Lab/controller/HardDiskController.java

@@ -8,27 +8,58 @@
 
 import java.util.List;
 
+/**
+ * RestController типа товара hardDisk
+ *
+ * @author "Alexey Derevtsov"
+ */
 @RestController
 @RequestMapping("product/hard_disk")
 public class HardDiskController {
+    /**
+     * Поля для сервиса товара hardDisk
+     */
     @Autowired
     private HardDiskService hardDiskService;
 
+    /**
+     * Get метод для вывода всех товаров типа HardDisk
+     *
+     * @return вывод всех товаров в формате JSON
+     */
     @GetMapping
     public ResponseEntity<List<HardDisk>> getAllHardDisk() {
         return ResponseEntity.ok().body(this.hardDiskService.getAllHardDisk());
     }
 
+    /**
+     * Get метод для вывода товара типа HardDisk по идентификатору
+     *
+     * @return вывод товара в формате JSON
+     */
     @GetMapping("{id}")
     public ResponseEntity<HardDisk> getHardDiskById(@PathVariable int id) {
         return ResponseEntity.ok().body(this.hardDiskService.getHardDiskById(id));
     }
 
+    /**
+     * Post метод создания товара типа hardDisk
+     *
+     * @param hardDisk - сущность в которую передают параметры из JSON
+     * @return данные сохраняются в бд
+     */
     @PostMapping
     public ResponseEntity<HardDisk> createLaptop(@RequestBody HardDisk hardDisk) {
         return ResponseEntity.ok().body(this.hardDiskService.createHardDisk(hardDisk));
     }
 
+    /**
+     * Put метод редактирования товара типа hardDisk
+     *
+     * @param id       - идентификатор товара,который должен быть изменен
+     * @param hardDisk - сущность в которую передают параметры из JSON файла
+     * @return данные товара обноляются в бд
+     */
     @PutMapping("{id}")
     public ResponseEntity<HardDisk> updateHardDisk(@PathVariable int id, @RequestBody HardDisk hardDisk) {
         hardDisk.setId(id);

src/main/java/shift/Lab/controller/LaptopController.java

@@ -9,27 +9,58 @@
 
 import java.util.List;
 
+/**
+ * RestController типа товара Laptop
+ *
+ * @author "Alexey Derevtsov"
+ */
 @RestController
 @RequestMapping("product/laptop")
 public class LaptopController {
+    /**
+     * Поля для сервиса товара Laptop
+     */
     @Autowired
     private LaptopService laptopService;
 
+    /**
+     * Get метод для вывода всех товаров типа Laptop
+     *
+     * @return вывод всех товаров в формате JSON
+     */
     @GetMapping
     public ResponseEntity<List<Laptop>> getAllLaptops() {
         return ResponseEntity.ok().body(this.laptopService.getAllLaptops());
     }
 
+    /**
+     * Get метод для вывода товара типа Laptop по идентификатору
+     *
+     * @return вывод товара в формате JSON
+     */
     @GetMapping("{id}")
     public ResponseEntity<Laptop> getLaptopById(@PathVariable int id) {
         return ResponseEntity.ok().body(this.laptopService.getLaptopById(id));
     }
 
+    /**
+     * Post метод создания товара типа laptop
+     *
+     * @param laptop - сущность в которую передают параметры из JSON
+     * @return данные сохраняются в бд
+     */
     @PostMapping
     public ResponseEntity<Laptop> createLaptop(@RequestBody Laptop laptop) {
         return ResponseEntity.ok().body(this.laptopService.createLaptop(laptop));
     }
 
+    /**
+     * Put метод редактирования товара типа laptop
+     *
+     * @param id     - идентификатор товара,который должен быть изменен
+     * @param laptop - сущность в которую передают параметры из JSON файла
+     * @return данные товара обноляются в бд
+     */
     @PutMapping("{id}")
     public ResponseEntity<Laptop> updateLaptop(@PathVariable int id, @RequestBody Laptop laptop) {
         laptop.setId(id);

src/main/java/shift/Lab/controller/MonitorController.java

@@ -8,27 +8,58 @@
 
 import java.util.List;
 
+/**
+ * RestController типа товара Monitor
+ *
+ * @author "Alexey Derevtsov"
+ */
 @RestController
 @RequestMapping("product/monitor")
 public class MonitorController {
+    /**
+     * Поля для сервиса товара Monitor
+     */
     @Autowired
     private MonitorService monitorService;
 
+    /**
+     * Get метод для вывода всех товаров типа Monitor
+     *
+     * @return вывод всех товаров в формате JSON
+     */
     @GetMapping
     public ResponseEntity<List<Monitor>> getAllMonitors() {
         return ResponseEntity.ok().body(this.monitorService.getAllMonitor());
     }
 
+    /**
+     * Get метод для вывода товара типа Monitor по идентификатору
+     *
+     * @return вывод товара в формате JSON
+     */
     @GetMapping("{id}")
     public ResponseEntity<Monitor> getMonitorById(@PathVariable int id) {
         return ResponseEntity.ok().body(this.monitorService.getMonitorById(id));
     }
 
+    /**
+     * Post метод создания товара типа monitor
+     *
+     * @param monitor - сущность в которую передают параметры из JSON
+     * @return данные сохраняются в бд
+     */
     @PostMapping
     public ResponseEntity<Monitor> createMonitor(@RequestBody Monitor monitor) {
         return ResponseEntity.ok().body(this.monitorService.createMonitor(monitor));
     }
 
+    /**
+     * Put метод редактирования товара типа monitor
+     *
+     * @param id      - идентификатор товара,который должен быть изменен
+     * @param monitor - сущность в которую передают параметры из JSON файла
+     * @return данные товара обноляются в бд
+     */
     @PutMapping("{id}")
     public ResponseEntity<Monitor> updateMonitor(@PathVariable int id, @RequestBody Monitor monitor) {
         monitor.setId(id);

src/main/java/shift/Lab/controller/PcController.java

@@ -8,28 +8,59 @@
 
 import java.util.List;
 
+/**
+ * RestController типа товара Pc
+ *
+ * @author "Alexey Derevtsov"
+ */
 @RestController
 @RequestMapping("product/pc")
 public class PcController {
 
+    /**
+     * Поля для сервиса товара Pc
+     */
     @Autowired
     private PcService pcService;
 
+    /**
+     * Get метод для вывода всех товаров типа Pc
+     *
+     * @return вывод всех товаров в формате JSON
+     */
     @GetMapping
     public ResponseEntity<List<Pc>> getAllPc() {
         return ResponseEntity.ok().body(this.pcService.getAllPc());
     }
 
+    /**
+     * Get метод для вывода товара типа Pc по идентификатору
+     *
+     * @return вывод товара в формате JSON
+     */
     @GetMapping("{id}")
     public ResponseEntity<Pc> getPcById(@PathVariable int id) {
         return ResponseEntity.ok().body(this.pcService.getPcById(id));
     }
 
+    /**
+     * Post метод создания товара типа Pc
+     *
+     * @param pc - сущность в которую передают параметры из JSON
+     * @return данные сохраняются в бд
+     */
     @PostMapping
     public ResponseEntity<Pc> createPc(@RequestBody Pc pc) {
         return ResponseEntity.ok().body(this.pcService.createPc(pc));
     }
 
+    /**
+     * Put метод редактирования товара типа pc
+     *
+     * @param id - идентификатор товара,который должен быть изменен
+     * @param pc - сущность в которую передают параметры из JSON файла
+     * @return данные товара обноляются в бд
+     */
     @PutMapping("{id}")
     public ResponseEntity<Pc> updatePc(@PathVariable int id, @RequestBody Pc pc) {
         pc.setId(id);

src/main/java/shift/Lab/controller/ProductController.java

@@ -11,18 +11,35 @@
 
 import java.util.List;
 
+/**
+ * RestController товара
+ *
+ * @author "Alexey Derevtsov"
+ */
 @RestController
 @RequestMapping("product")
 public class ProductController {
-
+    /**
+     * Поля для сервиса товара
+     */
     @Autowired
     private ProductService productService;
 
+    /**
+     * Get метод для вывода всех товаров
+     *
+     * @return вывод всех товаров в формате JSON
+     */
     @GetMapping
     public ResponseEntity<List<Product>> getAllProduct() {
         return ResponseEntity.ok().body(productService.getAllProduct());
     }
 
+    /**
+     * Get метод для вывода товара по идентификатору
+     *
+     * @return вывод товара в формате JSON
+     */
     @GetMapping("{id}")
     public ResponseEntity<Product> getProductById(@PathVariable int id) {
         return ResponseEntity.ok().body(this.productService.getProductById(id));

src/main/java/shift/Lab/entity/HardDisk.java

@@ -4,24 +4,57 @@
 import javax.persistence.Entity;
 import javax.persistence.Table;
 
+/**
+ * Сущность Жесктого диска.
+ * Тип товара
+ *
+ * @author "Alexey Derevtsov"
+ */
 @Entity
 @Table(name = "hard_disk")
 public class HardDisk extends Product {
+
+    /**
+     * Поле объема жесткого диска
+     */
     @Column(name = "capacity_gb")
     private int capacity;
 
+    /**
+     * Конструктор - создание нового объекта HardDisk
+     *
+     * @param batchNumber      - серия товара
+     * @param manufacturer     - производитель товара
+     * @param price            - цена товара
+     * @param numOfProdInStock - количество на складе товаров
+     * @param capacity         - объем жесткого диска
+     */
     public HardDisk(int batchNumber, String manufacturer, double price, int numOfProdInStock, int capacity) {
         super(batchNumber, manufacturer, price, numOfProdInStock);
         this.capacity = capacity;
     }
 
+    /**
+     * Конструктор - создание нового объекта HardDisk
+     *
+     * @param batchNumber      - серия товара
+     * @param manufacturer     - производитель товара
+     * @param price            - цена товара
+     * @param numOfProdInStock - количество на складе товаров
+     */
     public HardDisk(int batchNumber, String manufacturer, double price, int numOfProdInStock) {
         super(batchNumber, manufacturer, price, numOfProdInStock);
     }
 
+    /**
+     * Пустой конструктор
+     */
     public HardDisk() {
     }
 
+    /**
+     * Getters и Setters Product
+     */
     public int getCapacity() {
         return capacity;
     }