📝 :: (#10) add Java documents in Value Object classes

CNS-DGSW · Jan 17, 2023 · 441a697 · 441a697
1 parent f3d6309
commit 441a697
Show file tree

Hide file tree

Showing 11 changed files with 63 additions and 0 deletions.
diff --git a/User-Domain/src/main/java/com/dgsw/cns/user/vo/MemberDocumentVO.java b/User-Domain/src/main/java/com/dgsw/cns/user/vo/MemberDocumentVO.java
@@ -3,11 +3,21 @@
 import lombok.Getter;
 import lombok.RequiredArgsConstructor;
 
+/**
+ * 회원(지원자)의 자소서와 학업 게획서를 담는 Value Object class
+ */
 @Getter
 @RequiredArgsConstructor
 public class MemberDocumentVO {
 
+    /**
+     * 자소서
+     */
     private final String introduce;
+
+    /**
+     * 학업 계획서
+     */
     private final String plan;
 
 }
diff --git a/User-Domain/src/main/java/com/dgsw/cns/user/vo/MemberImageVO.java b/User-Domain/src/main/java/com/dgsw/cns/user/vo/MemberImageVO.java
@@ -3,6 +3,9 @@
 import lombok.AllArgsConstructor;
 import lombok.Getter;
 
+/**
+ * 내부 스토리지 혹은 S3 를 참조하여, 보관된 지원자의 이미지를 담는 Value Object class
+ */
 @Getter
 @AllArgsConstructor
 public class MemberImageVO {

diff --git a/User-Domain/src/main/java/com/dgsw/cns/user/vo/MemberSchoolInfoRO.java b/User-Domain/src/main/java/com/dgsw/cns/user/vo/MemberSchoolInfoRO.java
@@ -15,6 +15,11 @@
 @AllArgsConstructor
 public abstract class MemberSchoolInfoRO {
 
+    /**
+     * 지원자의 상태(졸업예정/졸업/검정고시)를 반환합니다.
+     * @return 구현체의 타입을 반환합니다.
+     * @see Type
+     */
     public abstract Type getType();
 
     protected enum Type {

diff --git a/User-Domain/src/main/java/com/dgsw/cns/user/vo/certification/MemberLoginVO.java b/User-Domain/src/main/java/com/dgsw/cns/user/vo/certification/MemberLoginVO.java
@@ -1,4 +1,17 @@
 package com.dgsw.cns.user.vo.certification;
 
+import lombok.Getter;
+import lombok.RequiredArgsConstructor;
+
+/**
+ * 회원이 로그인 할 정보(이메일, 비밀번호)들을 담고 있는 Value Object class
+ */
+@Getter
+@RequiredArgsConstructor
 public class MemberLoginVO {
+
+    private final String email;
+
+    private final String password;
+
 }
diff --git a/User-Domain/src/main/java/com/dgsw/cns/user/vo/school/GraduatedInfoVO.java b/User-Domain/src/main/java/com/dgsw/cns/user/vo/school/GraduatedInfoVO.java
@@ -6,6 +6,9 @@
 @Getter
 public class GraduatedInfoVO extends SchoolInfo {
 
+    /**
+     * 졸업한 년도
+     */
     private final YearVO graduated;
 
     public GraduatedInfoVO(String code, String region, String city, String telephone,

diff --git a/User-Domain/src/main/java/com/dgsw/cns/user/vo/school/QualifiedInfoRO.java b/User-Domain/src/main/java/com/dgsw/cns/user/vo/school/QualifiedInfoRO.java
@@ -4,9 +4,16 @@
 import com.dgsw.cns.user.vo.school.advanced.YearVO;
 import lombok.Getter;
 
+/**
+ * 지원자의 상태가 검정 고시인 경우를 구현한 자식 클래스
+ * @see MemberSchoolInfoRO
+ */
 @Getter
 public class QualifiedInfoRO extends MemberSchoolInfoRO {
 
+    /**
+     * 합격한 년도
+     */
     private final YearVO qualification;
 
     public QualifiedInfoRO(int year) {

diff --git a/User-Domain/src/main/java/com/dgsw/cns/user/vo/school/SchoolCommonVO.java b/User-Domain/src/main/java/com/dgsw/cns/user/vo/school/SchoolCommonVO.java
@@ -3,6 +3,9 @@
 import lombok.Getter;
 import lombok.RequiredArgsConstructor;
 
+/**
+ * 지원자의 상태가 졸업 예정 혹은 졸업인 경우, 반드시 가져야하는 클래스
+ */
 @Getter
 @RequiredArgsConstructor
 public class SchoolCommonVO {

diff --git a/User-Domain/src/main/java/com/dgsw/cns/user/vo/school/SchoolInfo.java b/User-Domain/src/main/java/com/dgsw/cns/user/vo/school/SchoolInfo.java
@@ -3,6 +3,13 @@
 import com.dgsw.cns.user.vo.MemberSchoolInfoRO;
 import lombok.Getter;
 
+/**
+ * 지원자의 상태가 졸업 예정자 혹은 졸업자인 경우, 공통적으로 가져야하는 추상 클래스
+ * @see UngraduatedInfoVO
+ * @see GraduatedInfoVO
+ * @see MemberSchoolInfoRO
+ * @see SchoolCommonVO
+ */
 @Getter
 public abstract class SchoolInfo extends MemberSchoolInfoRO {
 

diff --git a/User-Domain/src/main/java/com/dgsw/cns/user/vo/school/UngraduatedInfoVO.java b/User-Domain/src/main/java/com/dgsw/cns/user/vo/school/UngraduatedInfoVO.java
@@ -3,6 +3,12 @@
 import com.dgsw.cns.user.vo.school.advanced.TeacherVO;
 import lombok.Getter;
 
+/**
+ * 지원자의 상태가 졸업 예정인 것을 구현한 자식 클래스
+ *
+ * @see SchoolInfo
+ * @see com.dgsw.cns.user.vo.MemberSchoolInfoRO
+ */
 @Getter
 public class UngraduatedInfoVO extends SchoolInfo {
 

diff --git a/User-Domain/src/main/java/com/dgsw/cns/user/vo/school/advanced/TeacherVO.java b/User-Domain/src/main/java/com/dgsw/cns/user/vo/school/advanced/TeacherVO.java
@@ -3,6 +3,9 @@
 import lombok.Getter;
 import lombok.RequiredArgsConstructor;
 
+/**
+ * 지원자가 졸업예정자인 경우에 반드시 필요한 담임선생님의 간단 정보들을 담은 클래스
+ */
 @Getter
 @RequiredArgsConstructor
 public class TeacherVO {

diff --git a/User-Domain/src/main/java/com/dgsw/cns/user/vo/school/advanced/YearVO.java b/User-Domain/src/main/java/com/dgsw/cns/user/vo/school/advanced/YearVO.java
@@ -3,6 +3,9 @@
 import lombok.Getter;
 import lombok.RequiredArgsConstructor;
 
+/**
+ * 년도 관련 필드를 가진 객체가 따로 필요한 경우를 위한 클래스
+ */
 @Getter
 @RequiredArgsConstructor
 public class YearVO {