JavaDoc対応

This commit is contained in:
ろむねこ 2023-12-14 12:45:45 +09:00
parent fe17397b38
commit 1d33ded518
No known key found for this signature in database
GPG Key ID: FA1F39A1BA37D168

View File

@ -5,36 +5,76 @@ import one.nem.lacerta.model.document.tag.DocumentTag;
import java.util.Date; import java.util.Date;
import java.util.List; import java.util.List;
/**
* ドキュメントのメタデータ
*/
public class DocumentMeta { public class DocumentMeta {
/**
* ドキュメントのID(String)
*/
String id; String id;
/**
* ドキュメントのタイトル(String)
*/
String title; String title;
/**
* ドキュメントの更新日時(Date)
*/
Date updatedAt; Date updatedAt;
/**
* ドキュメントの作成日時(Date)
*/
Date createdAt; Date createdAt;
/**
* ドキュメントのタグ(DocumentTagインスタンスのリスト)
*/
List<DocumentTag> tags; List<DocumentTag> tags;
// Getter // Getter
/**
* ドキュメントのID(String)を取得する
*/
public String getId() { public String getId() {
return id; return id;
} }
/**
* ドキュメントのタイトル(String)を取得する
*/
public String getTitle() { public String getTitle() {
return title; return title;
} }
/**
* ドキュメントの更新日時(Date)を取得する
*/
public Date getUpdatedAt() { public Date getUpdatedAt() {
return updatedAt; return updatedAt;
} }
/**
* ドキュメントの作成日時(Date)を取得する
*/
public Date getCreatedAt() { public Date getCreatedAt() {
return createdAt; return createdAt;
} }
/**
* ドキュメントのタグ(DocumentTagインスタンスのリスト)を取得する
*/
public List<DocumentTag> getTags() { public List<DocumentTag> getTags() {
return tags; return tags;
} }
/**
* ドキュメントのタグ(DocumentTagインスタンスのリスト)のID(String)を取得する
*/
public List<String> getTagIds() { public List<String> getTagIds() {
List<String> tagIds = new ArrayList<>(); List<String> tagIds = new ArrayList<>();
for (DocumentTag tag : tags) { for (DocumentTag tag : tags) {
@ -45,22 +85,37 @@ public class DocumentMeta {
// Setter // Setter
/**
* ドキュメントのID(String)を設定する
*/
public void setId(String id) { public void setId(String id) {
this.id = id; this.id = id;
} }
/**
* ドキュメントのタイトル(String)を設定する
*/
public void setTitle(String title) { public void setTitle(String title) {
this.title = title; this.title = title;
} }
/**
* ドキュメントの更新日時(Date)を設定する
*/
public void setUpdatedAt(Date updatedAt) { public void setUpdatedAt(Date updatedAt) {
this.updatedAt = updatedAt; this.updatedAt = updatedAt;
} }
/**
* ドキュメントの作成日時(Date)を設定する
*/
public void setCreatedAt(Date createdAt) { public void setCreatedAt(Date createdAt) {
this.createdAt = createdAt; this.createdAt = createdAt;
} }
/**
* ドキュメントのタグ(DocumentTagインスタンスのリスト)を設定する
*/
public void setTags(List<DocumentTag> tags) { public void setTags(List<DocumentTag> tags) {
this.tags = tags; this.tags = tags;
} }