Merge pull request #72 from whitem4rk/docs/#71

[Docs/#71] Add Javadoc for Blueprint

build.gradle

@@ -66,3 +66,9 @@ dependencies {
 tasks.named('test') {
     useJUnitPlatform()
 }
+
+tasks.withType(Javadoc) {
+    options.encoding = 'UTF-8'
+    options.docEncoding = 'UTF-8'
+    options.charSet = 'UTF-8'
+}

src/main/java/api/goraebab/domain/blueprint/dockerObject/CustomConfig.java

@@ -4,6 +4,13 @@
 import lombok.Getter;
 import lombok.NoArgsConstructor;
 
+/**
+ * The type Custom config.
+ *
+ * @author whitem4rk
+ * @version 1.0
+ * @see ProcessedData
+ */
 @Getter
 @NoArgsConstructor
 public class CustomConfig {

src/main/java/api/goraebab/domain/blueprint/dockerObject/CustomContainer.java

@@ -6,6 +6,13 @@
 import lombok.Getter;
 import lombok.NoArgsConstructor;
 
+/**
+ * The type Custom container.
+ *
+ * @author whitem4rk
+ * @version 1.0
+ * @see ProcessedData
+ */
 @Getter
 @NoArgsConstructor
 public class CustomContainer {

src/main/java/api/goraebab/domain/blueprint/dockerObject/CustomHost.java

@@ -6,6 +6,13 @@
 import lombok.Getter;
 import lombok.NoArgsConstructor;
 
+/**
+ * The type Custom host.
+ *
+ * @author whitem4rk
+ * @version 1.0
+ * @see ProcessedData
+ */
 @Getter
 @NoArgsConstructor
 public class CustomHost {

src/main/java/api/goraebab/domain/blueprint/dockerObject/CustomImage.java

@@ -4,6 +4,13 @@
 import lombok.Getter;
 import lombok.NoArgsConstructor;
 
+/**
+ * The type Custom image.
+ *
+ * @author whitem4rk
+ * @version 1.0
+ * @see ProcessedData
+ */
 @Getter
 @NoArgsConstructor
 public class CustomImage {

src/main/java/api/goraebab/domain/blueprint/dockerObject/CustomIpam.java

@@ -6,6 +6,13 @@
 import lombok.Getter;
 import lombok.NoArgsConstructor;
 
+/**
+ * The type Custom ipam.
+ *
+ * @author whitem4rk
+ * @version 1.0
+ * @see ProcessedData
+ */
 @Getter
 @NoArgsConstructor
 public class CustomIpam {

src/main/java/api/goraebab/domain/blueprint/dockerObject/CustomMount.java

@@ -4,6 +4,13 @@
 import lombok.Getter;
 import lombok.NoArgsConstructor;
 
+/**
+ * The type Custom mount.
+ *
+ * @author whitem4rk
+ * @version 1.0
+ * @see ProcessedData
+ */
 @Getter
 @NoArgsConstructor
 public class CustomMount {

src/main/java/api/goraebab/domain/blueprint/dockerObject/CustomNetwork.java

@@ -6,6 +6,13 @@
 import lombok.Getter;
 import lombok.NoArgsConstructor;
 
+/**
+ * The type Custom network.
+ *
+ * @author whitem4rk
+ * @version 1.0
+ * @see ProcessedData
+ */
 @Getter
 @NoArgsConstructor
 public class CustomNetwork {

src/main/java/api/goraebab/domain/blueprint/dockerObject/CustomNetworkSettings.java

@@ -4,6 +4,13 @@
 import lombok.Getter;
 import lombok.NoArgsConstructor;
 
+/**
+ * The type Custom network settings.
+ *
+ * @author whitem4rk
+ * @version 1.0
+ * @see ProcessedData
+ */
 @Getter
 @NoArgsConstructor
 public class CustomNetworkSettings {

src/main/java/api/goraebab/domain/blueprint/dockerObject/CustomPort.java

@@ -4,6 +4,13 @@
 import lombok.Getter;
 import lombok.NoArgsConstructor;
 
+/**
+ * The type Custom port.
+ *
+ * @author whitem4rk
+ * @version 1.0
+ * @see ProcessedData
+ */
 @Getter
 @NoArgsConstructor
 public class CustomPort {

src/main/java/api/goraebab/domain/blueprint/dockerObject/CustomVolume.java

@@ -4,6 +4,13 @@
 import lombok.Getter;
 import lombok.NoArgsConstructor;
 
+/**
+ * The type Custom volume.
+ *
+ * @author whitem4rk
+ * @version 1.0
+ * @see ProcessedData
+ */
 @Getter
 @NoArgsConstructor
 public class CustomVolume {

src/main/java/api/goraebab/domain/blueprint/dockerObject/ProcessedData.java

@@ -6,6 +6,15 @@
 import lombok.Getter;
 import lombok.NoArgsConstructor;
 
+/**
+ * The data which is used to synchronize Docker with.
+ * From CustomHost class to leaf, all the fields are following docker daemon API request arguments.
+ * If you add new features, check API documents and follow JSON key and value format.
+ * Also, add "custom" prefix and change key format using @JsonProperty
+ *
+ * @author whitem4rk
+ * @version 1.0
+ */
 @Getter
 @NoArgsConstructor
 public class ProcessedData {

src/main/java/api/goraebab/domain/blueprint/dto/BlueprintReqDto.java

@@ -9,6 +9,12 @@
 import lombok.Getter;
 import lombok.NoArgsConstructor;
 
+/**
+ * Request DTO which Client sends when synchronize Docker with host.
+ *
+ * @author whitem4rk
+ * @version 1.0
+ */
 @Getter
 @NoArgsConstructor
 public class BlueprintReqDto {

src/main/java/api/goraebab/domain/blueprint/dto/BlueprintResDto.java

@@ -8,6 +8,14 @@
 
 import java.time.LocalDateTime;
 
+/**
+ * Response DTO which client request details of blueprint.
+ * This DTO contains DBMS settings which should not be revealed.
+ *
+ * @author whitem4rk
+ * @version 1.0
+ * @see StorageResDto
+ */
 @Getter
 @Setter
 @NoArgsConstructor

src/main/java/api/goraebab/domain/blueprint/dto/BlueprintsResDto.java

@@ -1,6 +1,5 @@
 package api.goraebab.domain.blueprint.dto;
 
-import api.goraebab.domain.blueprint.dockerObject.CustomHost;
 import api.goraebab.domain.blueprint.dockerObject.ProcessedData;
 import io.swagger.v3.oas.annotations.media.Schema;
 import lombok.AllArgsConstructor;
@@ -10,6 +9,13 @@
 
 import java.time.LocalDateTime;
 
+/**
+ * Response DTO which client request list of blueprints.
+ * This DTO only contains necessary information.
+ *
+ * @author whitem4rk
+ * @version 1.0
+ */
 @Getter
 @Setter
 @AllArgsConstructor

src/main/java/api/goraebab/domain/blueprint/dto/SyncResultDto.java

@@ -6,6 +6,13 @@
 import lombok.Getter;
 import lombok.NoArgsConstructor;
 
+/**
+ * DTO that includes the success status of the container synchronization request contained in the original request.
+ * Note that Whether the synchronization request succeed or not, this DTO is returned.
+ *
+ * @author whitem4rk
+ * @version 1.0
+ */
 @Getter
 @NoArgsConstructor
 public class SyncResultDto {

src/main/java/api/goraebab/domain/blueprint/entity/Blueprint.java

@@ -5,6 +5,12 @@
 import jakarta.persistence.*;
 import lombok.*;
 
+/**
+ * Represents a blueprint entity with information.
+ *
+ * @author whitem4rk
+ * @version 1.0
+ */
 @Getter
 @Entity
 @Table(name = "blueprint")
@@ -36,6 +42,12 @@ public void setAsRemote() {
     this.isRemote = true;
   }
 
+  /**
+   * Modify.
+   *
+   * @param name the blueprint name
+   * @param data the blueprint JSON format with escape handling applied.
+   */
   public void modify(String name, String data) {
     if (name != null) {
       this.name = name;
@@ -45,6 +57,14 @@ public void modify(String name, String data) {
     }
   }
 
+  /**
+   * Constructs a new instance
+   *
+   * @param name     the blueprint name
+   * @param data     the blueprint JSON format with escape handling applied.
+   * @param isRemote whether the blueprint is copied from remote database
+   * @param storage  the storage to be stored
+   */
   @Builder
   public Blueprint(String name, String data, Boolean isRemote, Storage storage) {
     this.name = name;

src/main/java/api/goraebab/domain/blueprint/mapper/BlueprintMapper.java

@@ -16,6 +16,12 @@
 import org.mapstruct.Named;
 import org.mapstruct.factory.Mappers;
 
+/**
+ * Mapper interface for converting {@link Blueprint} entities to various DTOs and vice versa.
+ *
+ * @author whitem4rk
+ * @version 1.0
+ */
 @Mapper(uses = {StorageMapper.class})
 public interface BlueprintMapper {
 
@@ -33,6 +39,13 @@ public interface BlueprintMapper {
   @IterableMapping(elementTargetType = BlueprintsResDto.class)
   List<BlueprintsResDto> toBlueprintsResDtoList(List<Blueprint> blueprints);
 
+  /**
+   * Custom mapping method to convert a JSON string into a {@link ProcessedData} object.
+   *
+   * @param data the JSON string to convert
+   * @return the resulting {@link ProcessedData} object
+   * @throws CustomException if the JSON string cannot be parsed
+   */
   @Named("stringToHost")
   default ProcessedData stringToHost(String data) {
     try {

src/main/java/api/goraebab/domain/blueprint/mapper/BlueprintRowMapper.java

@@ -5,6 +5,16 @@
 import java.sql.SQLException;
 import org.springframework.jdbc.core.RowMapper;
 
+/**
+ * A RowMapper implementation that maps a row from the result set to a {@link Blueprint} object.
+ *
+ * <p>This implementation extracts the "data" column from the
+ * result set and maps it to the {@code data} field in the {@link Blueprint} object.</p>
+ *
+ * @author whitem4rk
+ * @version 1.0
+ * @see org.springframework.jdbc.core.RowMapper
+ */
 public class BlueprintRowMapper implements RowMapper<Blueprint> {
 
   private static final String BLUEPRINT_DATA_COLUMN_NAME = "data";

src/main/java/api/goraebab/domain/blueprint/repository/BlueprintRepository.java

@@ -5,8 +5,24 @@
 import org.springframework.stereotype.Repository;
 
 import java.util.List;
-import java.util.Optional;
 
+/**
+ * Repository interface for managing {@link Blueprint} entities.
+ *
+ * <p>Extends the {@link JpaRepository} interface to provide CRUD operations and
+ * additional query methods for {@link Blueprint} objects.</p>
+ *
+ * <p>This interface is a Spring Data JPA repository and will be implemented automatically
+ * by Spring at runtime.</p>
+ *
+ * <p>Note: This repository currently does not include QueryDSL integration.
+ * If you need to perform complex dynamic queries with type safety, you may consider
+ * adding a custom repository interface and implementing QueryDSL functionality.</p>
+ *
+ * @author whitem4rk
+ * @version 1.0
+ * @see org.springframework.data.jpa.repository.JpaRepository
+ */
 @Repository
 public interface BlueprintRepository extends JpaRepository<Blueprint, Long> {
 

src/main/java/api/goraebab/domain/blueprint/service/BlueprintService.java

@@ -7,6 +7,13 @@
 import api.goraebab.domain.blueprint.dto.SyncResultDto;
 import java.util.List;
 
+/**
+ * Service interface for managing blueprints.
+ * Provides methods for creating, modifying, retrieving, applying blueprints to Docker.
+ *
+ * @author whitem4rk
+ * @version 1.0
+ */
 public interface BlueprintService {
 
     List<BlueprintsResDto> getBlueprints(Long storageId);

src/main/java/api/goraebab/domain/blueprint/service/BlueprintServiceImpl.java

@@ -22,6 +22,14 @@
 import org.springframework.stereotype.Service;
 import org.springframework.transaction.annotation.Transactional;
 
+/**
+ * Implementation of the {@link BlueprintService} interface.
+ * This service interacts with the database using repositories and synchronizes data with Docker
+ * through {@link DockerSyncServiceImpl}.
+ *
+ * @author whitem4rk
+ * @version 1.0
+ */
 @Service
 @RequiredArgsConstructor
 public class BlueprintServiceImpl implements BlueprintService {
@@ -72,6 +80,14 @@ public BlueprintResDto getBlueprintById(Long storageId, Long blueprintId) {
         return BlueprintMapper.INSTANCE.toBlueprintResDto(blueprint);
     }
 
+    /**
+     * Saves a new blueprint and synchronizes it with Docker.
+     *
+     * @param storageId the ID of  the storage
+     * @param blueprintReqDto the data of the blueprint to be saved, represented by {@link BlueprintReqDto}
+     * @return the result of the synchronization, represented by {@link SyncResultDto}
+     * @throws CustomException if saving or synchronization fails.
+     */
     @Override
     @Transactional
     public SyncResultDto saveBlueprint(Long storageId, BlueprintReqDto blueprintReqDto) {

src/main/java/api/goraebab/domain/blueprint/service/DockerSyncService.java

@@ -5,6 +5,13 @@
 import java.util.List;
 import java.util.Map;
 
+/**
+ * Service interface for synchronizing Docker containers with blueprint data.
+ * Provides methods to manage Docker container operations based on the given processed data.
+ *
+ * @author whitem4rk
+ * @version 1.0
+ */
 public interface DockerSyncService {
 
     List<Map<String, Object>> syncDockerWithBlueprintData(ProcessedData processedData);