JavaDoc対応

This commit is contained in:
ろむねこ 2023-12-14 12:51:15 +09:00
parent 2f29f5bf85
commit b731e566e7
No known key found for this signature in database
GPG Key ID: FA1F39A1BA37D168

View File

@ -3,9 +3,19 @@ package one.nem.lacerta.model.document.path;
import java.nio.file.Path; import java.nio.file.Path;
import java.nio.file.Paths; import java.nio.file.Paths;
/**
* ドキュメントのパス
*/
public class DocumentPath { public class DocumentPath {
/**
* ドキュメントのルートパス(String)
*/
String rootPath; String rootPath;
/**
* ドキュメントのパス(String)
*/
String path; String path;
// Constructor // Constructor
@ -20,19 +30,31 @@ public class DocumentPath {
// Getter // Getter
/**
* ドキュメントのルートパス(String)を取得する
*/
public String getRootPath() { public String getRootPath() {
return rootPath; return rootPath;
} }
/**
* ドキュメントのパス(String)を取得する
*/
public String getPath() { public String getPath() {
return path; return path;
} }
/**
* ドキュメントのフルパス(Path)を取得する
*/
public Path getFullPath() { public Path getFullPath() {
// rootPathとpathを結合して返す // rootPathとpathを結合して返す
return Paths.get(rootPath, path); return Paths.get(rootPath, path);
} }
/**
* ドキュメントのフルパス(String)を取得する
*/
public String getFullPathString() { public String getFullPathString() {
// rootPathとpathを結合して返す // rootPathとpathを結合して返す
return Paths.get(rootPath, path).toString(); return Paths.get(rootPath, path).toString();
@ -40,10 +62,18 @@ public class DocumentPath {
// Setter // Setter
/**
* ドキュメントのルートパス(String)を設定する
* @param rootPath ドキュメントのルートパス
*/
public void setRootPath(String rootPath) { public void setRootPath(String rootPath) {
this.rootPath = rootPath; this.rootPath = rootPath;
} }
/**
* ドキュメントのパス(String)を設定する
* @param path ドキュメントのパス
*/
public void setPath(String path) { public void setPath(String path) {
this.path = path; this.path = path;
} }