Module io.github.tonywasher.joceanus.metis

Package io.github.tonywasher.joceanus.metis.toolkit

Class MetisSafeFileManager

java.lang.Object

io.github.tonywasher.joceanus.metis.toolkit.MetisSafeFileManager

public class MetisSafeFileManager
extends Object

Safe File Create.

Field Summary

Fields

Modifier and Type	Field	Description
(package private) static final char	CHAR_DOT	The dot character.
(package private) static final String	COMMIT_EXT	The commit extension.
(package private) static final String	COMMITX_EXT	The commit extension.
(package private) static final String	TEMP_EXT	The temp extension.

Constructor Summary

Constructors

Constructor	Description
MetisSafeFileManager(File pFileName)	Constructor.

Method Summary

Modifier and Type	Method	Description
void	cleanUpFile()	Cleanup file.
static void	clearDirectory(File pDirectory)	ClearUp directory.
void	commitFile()	Commit file.
File	getFileToWriteTo()	Obtain name of temporary file to write to.
File	getRealFile()	Obtain standard name.
void	setNumBackups(int pNumBackups)	Set the number of backups.

Methods inherited from class java.lang.Object

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

Field Details

TEMP_EXT

static final String TEMP_EXT

The temp extension.

See Also:

• Constant Field Values

COMMIT_EXT

static final String COMMIT_EXT

The commit extension.

See Also:

• Constant Field Values

COMMITX_EXT

static final String COMMITX_EXT

The commit extension.

See Also:

• Constant Field Values

CHAR_DOT

static final char CHAR_DOT

The dot character.

See Also:

• Constant Field Values

Constructor Details

MetisSafeFileManager

public MetisSafeFileManager(File pFileName)

Constructor.

Parameters:

pFileName - the file name

Method Details

setNumBackups

public void setNumBackups(int pNumBackups)

Set the number of backups.

Parameters:

pNumBackups - the number of backups

commitFile

public void commitFile()
                throws OceanusException

Commit file.

Throws:

OceanusException - on error

cleanUpFile

public void cleanUpFile()

Cleanup file.

getFileToWriteTo

public File getFileToWriteTo()

Obtain name of temporary file to write to.

Returns:

the temporary name

getRealFile

public File getRealFile()

Obtain standard name.

Returns:

the standard name

clearDirectory

public static void clearDirectory(File pDirectory)

ClearUp directory.

Parameters:

pDirectory - the directory to clean