diff --git a/pom.xml b/pom.xml index 1044131..fd62b14 100644 --- a/pom.xml +++ b/pom.xml @@ -5,24 +5,23 @@ org.springframework.boot spring-boot-starter-parent - 2.4.0 + 2.6.4 com.pj liquibasedemo - 2.2.0 + 2.3.0 liquibasedemo Liquibase Demo project with Spring Boot and Spring Data - 2.4.0 - 5.4.24.Final - 4.8.0 - 4.2.0 - 4.1.1 - 2.0.1.Final + 2.6.4 + 5.6.7.Final + 4.9.0 + 4.9.0 + 4.9.0 3.27.0-GA - 2.4.0-b180830.0359 + 2.3.1 @@ -164,11 +163,7 @@ spring-boot-starter-data-jpa ${spring-boot.version} - - javax.validation - validation-api - ${validation-api.version} - + org.javassist javassist diff --git a/src/main/java/com/pj/liquibasedemo/domain/Country.java b/src/main/java/com/pj/liquibasedemo/domain/Country.java index 6d50f79..d6e4f66 100755 --- a/src/main/java/com/pj/liquibasedemo/domain/Country.java +++ b/src/main/java/com/pj/liquibasedemo/domain/Country.java @@ -11,7 +11,12 @@ import javax.persistence.ManyToOne; import javax.persistence.Table; - +/** + * Entity class that maps to country table in the database. + * + * @author Pavan Kumar Jadda + * @since 1.0.0 + */ @Entity @Table(name = "country") @Data diff --git a/src/main/java/com/pj/liquibasedemo/domain/Employee.java b/src/main/java/com/pj/liquibasedemo/domain/Employee.java index efa128f..597a262 100755 --- a/src/main/java/com/pj/liquibasedemo/domain/Employee.java +++ b/src/main/java/com/pj/liquibasedemo/domain/Employee.java @@ -10,7 +10,12 @@ import javax.persistence.Id; import javax.persistence.Table; - +/** + * Entity class that maps to employee table in the database. + * + * @author Pavan Kumar Jadda + * @since 1.0.0 + */ @Entity @Table(name = "employee") @Data diff --git a/src/main/java/com/pj/liquibasedemo/domain/EmploymentType.java b/src/main/java/com/pj/liquibasedemo/domain/EmploymentType.java index eacc11c..7c2e233 100644 --- a/src/main/java/com/pj/liquibasedemo/domain/EmploymentType.java +++ b/src/main/java/com/pj/liquibasedemo/domain/EmploymentType.java @@ -1,5 +1,11 @@ package com.pj.liquibasedemo.domain; +/** + * Enum that represents the employment type. + * + * @author Pavan Kumar Jadda + * @since 1.0.0 + */ public enum EmploymentType { CONTRACTOR("contractor"), diff --git a/src/main/java/com/pj/liquibasedemo/domain/EmploymentTypeConverter.java b/src/main/java/com/pj/liquibasedemo/domain/EmploymentTypeConverter.java index a74373f..69ab490 100644 --- a/src/main/java/com/pj/liquibasedemo/domain/EmploymentTypeConverter.java +++ b/src/main/java/com/pj/liquibasedemo/domain/EmploymentTypeConverter.java @@ -4,6 +4,12 @@ import javax.persistence.Converter; import java.util.stream.Stream; +/** + * Employee Type Converter that converts the Enum type to a String and vice versa. + * + * @author Pavan Kumar Jadda + * @since 1.0.0 + */ @Converter(autoApply = true) public class EmploymentTypeConverter implements AttributeConverter { diff --git a/src/main/java/com/pj/liquibasedemo/domain/Region.java b/src/main/java/com/pj/liquibasedemo/domain/Region.java index cc6be41..85a0646 100755 --- a/src/main/java/com/pj/liquibasedemo/domain/Region.java +++ b/src/main/java/com/pj/liquibasedemo/domain/Region.java @@ -10,6 +10,12 @@ import javax.persistence.Id; import javax.persistence.Table; +/** + * Entity class that maps to region table in the database. + * + * @author Pavan Kumar Jadda + * @since 1.0.0 + */ @Entity @Table(name = "region") @Data diff --git a/src/main/java/com/pj/liquibasedemo/repository/CountryRepository.java b/src/main/java/com/pj/liquibasedemo/repository/CountryRepository.java index 4e36c32..976100d 100755 --- a/src/main/java/com/pj/liquibasedemo/repository/CountryRepository.java +++ b/src/main/java/com/pj/liquibasedemo/repository/CountryRepository.java @@ -3,6 +3,12 @@ import com.pj.liquibasedemo.domain.Country; import org.springframework.data.jpa.repository.JpaRepository; +/** + * Country Repository interface that gets, saves, updates and deletes Country objects. + * + * @author Pavan Kumar Jadda + * @since 1.0.0 + */ public interface CountryRepository extends JpaRepository { } diff --git a/src/main/java/com/pj/liquibasedemo/repository/EmployeeRepository.java b/src/main/java/com/pj/liquibasedemo/repository/EmployeeRepository.java index ff238e0..78f192b 100755 --- a/src/main/java/com/pj/liquibasedemo/repository/EmployeeRepository.java +++ b/src/main/java/com/pj/liquibasedemo/repository/EmployeeRepository.java @@ -3,6 +3,12 @@ import com.pj.liquibasedemo.domain.Employee; import org.springframework.data.jpa.repository.JpaRepository; +/** + * Employee Repository interface that gets, saves, updates and deletes Employee objects. + * + * @author Pavan Kumar Jadda + * @since 1.0.0 + */ public interface EmployeeRepository extends JpaRepository { } diff --git a/src/main/java/com/pj/liquibasedemo/repository/RegionRepository.java b/src/main/java/com/pj/liquibasedemo/repository/RegionRepository.java index d720234..9e08355 100755 --- a/src/main/java/com/pj/liquibasedemo/repository/RegionRepository.java +++ b/src/main/java/com/pj/liquibasedemo/repository/RegionRepository.java @@ -5,7 +5,13 @@ import java.util.Optional; +/** + * Region Repository interface that gets, saves, updates and deletes Region objects. + * + * @author Pavan Kumar Jadda + * @since 1.0.0 + */ public interface RegionRepository extends JpaRepository { - Optional findByName(String name); + Optional findByName(String name); } diff --git a/src/main/java/com/pj/liquibasedemo/web/CountryController.java b/src/main/java/com/pj/liquibasedemo/web/CountryController.java index a53b9d2..a76ee94 100644 --- a/src/main/java/com/pj/liquibasedemo/web/CountryController.java +++ b/src/main/java/com/pj/liquibasedemo/web/CountryController.java @@ -8,32 +8,54 @@ import java.util.List; +/** + * Provides API endpoints for Country and related operations + * + * @author Pavan Kumar Jadda + * @since 1.0.0 + */ @RestController @RequestMapping("/api/v1/country") public class CountryController { - private final CountryRepository countryRepository; - - public CountryController(CountryRepository countryRepository) - { - this.countryRepository = countryRepository; - } - - @GetMapping(path = "/list") - public List findAllCountries() - { - return countryRepository.findAll(); - } - - @GetMapping(path = "/create") - public Country createCountry() - { - Country country=new Country(); - country.setCode("USD"); - country.setIsoCode("USD"); - country.setName("United States Dollar"); - - - return countryRepository.saveAndFlush(country); - } + private final CountryRepository countryRepository; + + public CountryController(CountryRepository countryRepository) + { + this.countryRepository = countryRepository; + } + + /** + * Finds all countries in the database + * + * @return List of countries + * + * @author Pavan Kumar Jadda + * @since 1.0.0 + */ + @GetMapping(path = "/list") + public List findAllCountries() + { + return countryRepository.findAll(); + } + + /** + * Create a new country in the database and returns the newly created country + * + * @return Newly created country + * + * @author Pavan Kumar Jadda + * @since 1.0.0 + */ + @GetMapping(path = "/create") + public Country createCountry() + { + Country country = new Country(); + country.setCode("USD"); + country.setIsoCode("USD"); + country.setName("United States Dollar"); + + + return countryRepository.saveAndFlush(country); + } } diff --git a/src/main/java/com/pj/liquibasedemo/web/EmployeeController.java b/src/main/java/com/pj/liquibasedemo/web/EmployeeController.java index 73c3e38..8b01ac0 100644 --- a/src/main/java/com/pj/liquibasedemo/web/EmployeeController.java +++ b/src/main/java/com/pj/liquibasedemo/web/EmployeeController.java @@ -9,33 +9,55 @@ import java.util.List; +/** + * Provides API endpoints for Employee and related operations + * + * @author Pavan Kumar Jadda + * @since 1.0.0 + */ @RestController @RequestMapping("/api/v1/employee") public class EmployeeController { - private final EmployeeRepository employeeRepository; + private final EmployeeRepository employeeRepository; - public EmployeeController(EmployeeRepository employeeRepository) - { - this.employeeRepository = employeeRepository; - } + public EmployeeController(EmployeeRepository employeeRepository) + { + this.employeeRepository = employeeRepository; + } - @GetMapping(path = "/list") - public List findAll() - { - return employeeRepository.findAll(); - } + /** + * Finds all employees in the database + * + * @return List of employees + * + * @author Pavan Kumar Jadda + * @since 1.0.0 + */ + @GetMapping(path = "/list") + public List findAll() + { + return employeeRepository.findAll(); + } - @GetMapping(path = "/create") - public Employee createEmployee() - { - Employee employee = new Employee(); - employee.setFirstName("John"); - employee.setLastName("Reese"); - employee.setEmail("john.reese@example.com"); - employee.setPhone("903-888-9999"); - employee.setEmploymentType(EmploymentType.CONTRACTOR); - return employeeRepository.saveAndFlush(employee); - } + /** + * Creates a new employee in the database + * + * @return Newly created employee + * + * @author Pavan Kumar Jadda + * @since 1.0.0 + */ + @GetMapping(path = "/create") + public Employee createEmployee() + { + Employee employee = new Employee(); + employee.setFirstName("John"); + employee.setLastName("Reese"); + employee.setEmail("john.reese@example.com"); + employee.setPhone("903-888-9999"); + employee.setEmploymentType(EmploymentType.CONTRACTOR); + return employeeRepository.saveAndFlush(employee); + } }