org.dbflute.infra.doc.hacomment

クラス DfHacoMapFile

java.lang.Object

org.dbflute.infra.doc.hacomment.DfHacoMapFile

public class DfHacoMapFile
extends Object

作成者:

hakiba

コンストラクタのサマリー

コンストラクタ

コンストラクタと説明
DfHacoMapFile(Supplier<LocalDateTime> currentDatetimeSupplier)

メソッドのサマリー

修飾子とタイプ	メソッドと説明
protected void	assertClientDirPath(String clientDirPath)
protected String	buildPickupFilePath(String clientDirPath)
protected String	buildPieceDirPath(String clientDirPath)
String	buildPieceFileName(DfHacoMapPiece piece) Build piece file name for piece map file e.g.
protected void	createPickupMapFile(File pickupMapFile)
protected void	createPieceMapFile(File pieceMapFile)
void	deletePiece(String clientPath)
protected void	doWritePickup(String pickupFilePath, DfHacoMapPickup pickup)
String	generateDiffCode(String diffDate)
protected String	getCurrentDateStr()
protected LocalDateTime	getCurrentLocalDateTime()
DfHacoMapPickup	merge(OptionalThing<DfHacoMapPickup> optPickup, List<DfHacoMapPiece> pieces) merge piece map and pickup map with previous piece code.
OptionalThing<DfHacoMapPickup>	readPickup(String clientDirPath) Read hacomment pickup map file at "clientDirPath/schema/hacomment/pickup/hacomment-pickup.dfmap".
List<DfHacoMapPiece>	readPieceList(String clientDirPath) Read all hacomment piece map file in "clientDirPath/schema/hacomment/piece/".
protected void	throwHacoMapResourceReleaseFailureException(String path, Map<String,Object> hacoMap, Exception cause)
protected void	throwHacoMapWriteFailureException(String path, Exception cause)
protected void	throwHacomMapReadFailureException(String path, Exception cause)
void	writePickup(String clientDirPath, DfHacoMapPickup pickup)
void	writePiece(String clientDirPath, DfHacoMapPiece piece)

クラスから継承されたメソッド java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

コンストラクタの詳細

DfHacoMapFile

public DfHacoMapFile(Supplier<LocalDateTime> currentDatetimeSupplier)

メソッドの詳細

readPieceList

public List<DfHacoMapPiece> readPieceList(String clientDirPath)

Read all hacomment piece map file in "clientDirPath/schema/hacomment/piece/".

パラメータ:

clientDirPath - The path of DBFlute client directory (NotNull)

戻り値:

List of all hacomment piece map (NotNull: If piece map file not exists, returns empty list)

関連項目:

DfHacoMapPiece.convertToMap()

readPickup

public OptionalThing<DfHacoMapPickup> readPickup(String clientDirPath)

Read hacomment pickup map file at "clientDirPath/schema/hacomment/pickup/hacomment-pickup.dfmap".

パラメータ:

clientDirPath - The path of DBFlute client directory (NotNull)

戻り値:

pickup hacomment map (NotNull: If pickup map file not exists, returns empty)

関連項目:

DfHacoMapPickup.convertToMap()

throwHacomMapReadFailureException

protected void throwHacomMapReadFailureException(String path,
                                                 Exception cause)

writePiece

public void writePiece(String clientDirPath,
                       DfHacoMapPiece piece)

createPieceMapFile

protected void createPieceMapFile(File pieceMapFile)

writePickup

public void writePickup(String clientDirPath,
                        DfHacoMapPickup pickup)

doWritePickup

protected void doWritePickup(String pickupFilePath,
                             DfHacoMapPickup pickup)

createPickupMapFile

protected void createPickupMapFile(File pickupMapFile)

buildPieceFileName

public String buildPieceFileName(DfHacoMapPiece piece)

Build piece file name for piece map file
e.g. hacomment-piece-diffdate20180220161718-20171015-161718-199-jflute-HF7ELSE.dfmap

パラメータ:

piece - Decoment piece map (NotNull)

戻り値:

piece file name

getCurrentDateStr

protected String getCurrentDateStr()

throwHacoMapWriteFailureException

protected void throwHacoMapWriteFailureException(String path,
                                                 Exception cause)

throwHacoMapResourceReleaseFailureException

protected void throwHacoMapResourceReleaseFailureException(String path,
                                                           Map<String,Object> hacoMap,
                                                           Exception cause)

merge

public DfHacoMapPickup merge(OptionalThing<DfHacoMapPickup> optPickup,
                             List<DfHacoMapPiece> pieces)

merge piece map and pickup map with previous piece code.

パラメータ:

optPickup - Hacoment pickup map (NotNull: If pickup map file not exists, Empty allowed)

pieces - hacoment piece maps in piece directory (NotNull: If piece map file not exists, Empty allowed)

戻り値:

pickup hacomment map (NotNull)

deletePiece

public void deletePiece(String clientPath)

generateDiffCode

public String generateDiffCode(String diffDate)

buildPieceDirPath

protected String buildPieceDirPath(String clientDirPath)

buildPickupFilePath

protected String buildPickupFilePath(String clientDirPath)

assertClientDirPath

protected void assertClientDirPath(String clientDirPath)

getCurrentLocalDateTime

protected LocalDateTime getCurrentLocalDateTime()