Package com.orientechnologies.common.io

Class OFileUtils

java.lang.Object

com.orientechnologies.common.io.OFileUtils

public class OFileUtils
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
static final int	GIGABYTE
static final int	KILOBYTE
static final int	MEGABYTE
static final long	TERABYTE

Constructor Summary

Constructors

Constructor	Description
OFileUtils()

Method Summary

Modifier and Type	Method	Description
static void	atomicMoveWithFallback(Path source, Path target, Object requester)	Tries to move a file from the source to the target atomically.
static void	checkValidName(String iFileName)
static final void	copyDirectory(File source, File destination)
static final void	copyFile(File source, File destination)
static void	createDirectoryTree(String iFileName)
static boolean	delete(File file)
static void	deleteFolderIfEmpty(File dir)
static void	deleteRecursively(File rootFile)
static void	deleteRecursively(File rootFile, boolean onlyDirs)
static String	getDirectory(String iPath)
static String	getPath(String iPath)
static long	getSizeAsNumber(Object iSize)
static String	getSizeAsString(long iSize)
static void	prepareForFileCreationOrReplacement(Path path, Object requester, String operation)	Prepares the path for a file creation or replacement.
static boolean	renameFile(File from, File to)
static Number	string2number(String iText)

Methods inherited from class java.lang.Object

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

Field Details

KILOBYTE

public static final int KILOBYTE

See Also:

• Constant Field Values

MEGABYTE

public static final int MEGABYTE

See Also:

• Constant Field Values

GIGABYTE

public static final int GIGABYTE

See Also:

• Constant Field Values

TERABYTE

public static final long TERABYTE

See Also:

• Constant Field Values

Constructor Details

OFileUtils

public OFileUtils()

Method Details

getSizeAsNumber

public static long getSizeAsNumber(Object iSize)

string2number

public static Number string2number(String iText)

getSizeAsString

public static String getSizeAsString(long iSize)

getDirectory

public static String getDirectory(String iPath)

createDirectoryTree

public static void createDirectoryTree(String iFileName)

getPath

public static String getPath(String iPath)

checkValidName

public static void checkValidName(String iFileName)
                           throws IOException

Throws:

IOException

deleteRecursively

public static void deleteRecursively(File rootFile)

deleteRecursively

public static void deleteRecursively(File rootFile,
 boolean onlyDirs)

deleteFolderIfEmpty

public static void deleteFolderIfEmpty(File dir)

copyFile

public static final void copyFile(File source,
 File destination)
                           throws IOException

Throws:

IOException

copyDirectory

public static final void copyDirectory(File source,
 File destination)
                                throws IOException

Throws:

IOException

renameFile

public static boolean renameFile(File from,
 File to)
                          throws IOException

Throws:

IOException

delete

public static boolean delete(File file)
                      throws IOException

Throws:

IOException

prepareForFileCreationOrReplacement

public static void prepareForFileCreationOrReplacement(Path path,
 Object requester,
 String operation)
                                                throws IOException

Prepares the path for a file creation or replacement. If the file pointed by the path already exists, it will be deleted, a warning will be emitted to the log in this case. All absent directories along the path will be created.

Parameters:

path - the file path.

requester - the requester of an operation being performed to produce user-friendly log messages.

operation - the description of an operation being performed to produce user-friendly log messages. Use descriptions like "exporting", "backing up", etc.

Throws:

IOException

atomicMoveWithFallback

public static void atomicMoveWithFallback(Path source,
 Path target,
 Object requester)
                                   throws IOException

Tries to move a file from the source to the target atomically. If atomic move is not possible, falls back to regular move.

Parameters:

source - the source to move the file from.

target - the target to move the file to.

requester - the requester of the move being performed to produce user-friendly log messages.

Throws:

IOException

See Also:

• Files.move(Path, Path, CopyOption...)
• StandardCopyOption.ATOMIC_MOVE