com.github.jlangch.venice.impl.util.io

Class FileUtil

java.lang.Object

com.github.jlangch.venice.impl.util.io.FileUtil

public class FileUtil
extends java.lang.Object

File utilities

Method Summary

Modifier and Type	Method and Description
static void	append(byte[] data, java.io.File destination) Append to file.
static boolean	awaitFile(java.nio.file.Path target, long timeoutMillis, java.util.Set<java.nio.file.WatchEvent.Kind<?>> events)
static void	copy(java.io.File source, java.io.File destination, boolean overwrite) Copies a file.
static void	copydir(java.io.File srcdir, java.io.File dstdir) Copies a directory recursively
static void	delete(java.io.File file) Deletes a file or an empty directory.
static int	deleteFiles(java.io.File path, java.io.FilenameFilter filter) Deletes files from a given directory.
static java.lang.String	getCurrentWorkDir()
static java.lang.String	getFileBaseName(java.lang.String fileName)
static java.util.Date	getFileCreationDate(java.io.File file) Get the file creation date
static java.lang.String	getFileExt(java.lang.String fileName) Returns the file's extension
static java.lang.String	getFileExtensionLowerCase(java.lang.String fileName)
static java.io.File	getTempDir()
static java.io.File	getUserDir()
static boolean	isAbsoultePath(java.lang.String path)
static byte[]	load(java.io.File source) Loads binary data from a file.
static void	mkdir(java.io.File dir) Creates a directory.
static void	mkdirs(java.io.File dir) Creates a directory including any necessary but nonexistent parent directories.
static java.lang.String	replaceFileExt(java.lang.String fileName, java.lang.String fileExt) Replace a file extension.
static void	rmdir(java.io.File dir) Removes a directory recursively
static void	save(byte[] data, java.io.File destination, boolean overwrite) Save to file.
static void	save(java.io.InputStream inStream, java.io.File destination, boolean overwrite) Save to file.
static void	save(java.lang.String text, java.io.File destination, boolean overwrite) Save to file.
static void	touch(java.io.File file) Touches a file.
static void	touch(java.io.File file, long modificationTime) Touches a file.
static java.nio.file.WatchService	watchDir(java.nio.file.Path dir, java.util.function.BiConsumer<java.nio.file.Path,java.nio.file.WatchEvent.Kind<?>> eventListener, java.util.function.BiConsumer<java.nio.file.Path,java.lang.Exception> errorListener, java.util.function.Consumer<java.nio.file.Path> terminationListener)

Methods inherited from class java.lang.Object

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

Method Detail

load

public static byte[] load(java.io.File source)

Loads binary data from a file.

Parameters:

source - The source file

Returns:

the loaded file data

copy

public static void copy(java.io.File source,
                        java.io.File destination,
                        boolean overwrite)

Copies a file.

Parameters:

source - The source file

destination - The destination file

overwrite - if true overwrite the destination file

save

public static void save(byte[] data,
                        java.io.File destination,
                        boolean overwrite)

Save to file.

Parameters:

data - the data to save to the file

destination - The destination file

overwrite - if true overwrite the destination file

append

public static void append(byte[] data,
                          java.io.File destination)

Append to file.

Parameters:

data - the data to append to the file

destination - The destination file

save

public static void save(java.io.InputStream inStream,
                        java.io.File destination,
                        boolean overwrite)

Save to file.

Parameters:

inStream - the input stream the data is read from to save to the file. Note: The caller is responsible to close the in stream

destination - The destination file

overwrite - if true overwrite the destination file

save

public static void save(java.lang.String text,
                        java.io.File destination,
                        boolean overwrite)

Save to file.

Parameters:

text - the text to save to the file

destination - The destination file

overwrite - if true overwrite the destination file

deleteFiles

public static int deleteFiles(java.io.File path,
                              java.io.FilenameFilter filter)

Deletes files from a given directory.

Parameters:

path - A directory from which files are processed

filter - A filter that denotes the files to be deleted

Returns:

the number of deleted files

getTempDir

public static java.io.File getTempDir()

Returns:

The default temp directory

getUserDir

public static java.io.File getUserDir()

Returns:

The user's directory

getCurrentWorkDir

public static java.lang.String getCurrentWorkDir()

Returns:

The current working directory (absolute path)

isAbsoultePath

public static boolean isAbsoultePath(java.lang.String path)

Parameters:

path - a path

Returns:

true if the path is an absolute file path

touch

public static void touch(java.io.File file)

Touches a file. Creates the file if does not exist.

Parameters:

file - A file (The parent directory must exist)

touch

public static void touch(java.io.File file,
                         long modificationTime)

Touches a file. Creates the file if does not exist.

Parameters:

file - A file (The parent directory must exist)

modificationTime - A modification time

delete

public static void delete(java.io.File file)

Deletes a file or an empty directory.

Parameters:

file - A file

Throws:

FileException - if the file could not be deleted

mkdir

public static void mkdir(java.io.File dir)

Creates a directory.

Parameters:

dir - A directory

Throws:

FileException - if the directory could not be created

mkdirs

public static void mkdirs(java.io.File dir)

Creates a directory including any necessary but nonexistent parent directories.

Parameters:

dir - A directory

Throws:

FileException - if the directory could not be created

rmdir

public static void rmdir(java.io.File dir)

Removes a directory recursively

Parameters:

dir - A directory

Throws:

FileException - if the directory could not be removed

copydir

public static void copydir(java.io.File srcdir,
                           java.io.File dstdir)

Copies a directory recursively

Parameters:

srcdir - A source directory

dstdir - A destination directory

Throws:

FileException - if the directory could not be copied

getFileCreationDate

public static java.util.Date getFileCreationDate(java.io.File file)

Get the file creation date

Parameters:

file - A file

Returns:

The creation date

replaceFileExt

public static java.lang.String replaceFileExt(java.lang.String fileName,
                                              java.lang.String fileExt)

Replace a file extension. If the file name has no file extension it will be added.

Parameters:

fileName - A file name

fileExt - the new file extension

Returns:

The file name enhanced by an index

getFileExt

public static java.lang.String getFileExt(java.lang.String fileName)

Returns the file's extension

Parameters:

fileName - a file name

Returns:

The file's extension or null if there is none

getFileBaseName

public static java.lang.String getFileBaseName(java.lang.String fileName)

getFileExtensionLowerCase

public static java.lang.String getFileExtensionLowerCase(java.lang.String fileName)

awaitFile

public static boolean awaitFile(java.nio.file.Path target,
                                long timeoutMillis,
                                java.util.Set<java.nio.file.WatchEvent.Kind<?>> events)
                         throws java.io.IOException,
                                java.lang.InterruptedException

Throws:

java.io.IOException

java.lang.InterruptedException

watchDir

public static java.nio.file.WatchService watchDir(java.nio.file.Path dir,
                                                  java.util.function.BiConsumer<java.nio.file.Path,java.nio.file.WatchEvent.Kind<?>> eventListener,
                                                  java.util.function.BiConsumer<java.nio.file.Path,java.lang.Exception> errorListener,
                                                  java.util.function.Consumer<java.nio.file.Path> terminationListener)
                                           throws java.io.IOException

Throws:

java.io.IOException