release: bump version to 2.3.0

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

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

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"),

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<EmploymentType, String>
 {

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

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<Country, Long>
 {
 }

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<Employee, Long>
 {
 }

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<Region, Long>
 {
-    Optional<Region> findByName(String name);
+  Optional<Region> findByName(String name);
 }

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<Country> 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<Country> 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);
+  }
 }

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<Employee> 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<Employee> findAll()
+  {
+    return employeeRepository.findAll();
+  }
 
-    @GetMapping(path = "/create")
-    public Employee createEmployee()
-    {
-        Employee employee = new Employee();
-        employee.setFirstName("John");
-        employee.setLastName("Reese");
-        employee.setEmail("[email protected]");
-        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("[email protected]");
+    employee.setPhone("903-888-9999");
+    employee.setEmploymentType(EmploymentType.CONTRACTOR);
+    return employeeRepository.saveAndFlush(employee);
+  }
 }