org.jodconverter.core.util

Class FileUtils

java.lang.Object

org.jodconverter.core.util.FileUtils

public final class FileUtils
extends java.lang.Object

Contains files helper functions.

Method Summary

Modifier and Type	Method and Description
static void	copyDirectory(@NonNull java.io.File srcDir, @NonNull java.io.File destDir, java.nio.file.CopyOption... options) Copies a directory recursively, preserving the files last modified date.
static void	copyFile(@NonNull java.io.File srcFile, @NonNull java.io.File destFile, java.nio.file.CopyOption... options) Copies a file to another path, preserving the last modified date.
static void	copyFileToDirectory(@NonNull java.io.File srcFile, @NonNull java.io.File destDir, java.nio.file.CopyOption... options) Copies a file to a directory, preserving the last modified date.
static boolean	delete(@Nullable java.io.File file) Deletes a file.
static boolean	deleteQuietly(@Nullable java.io.File file) Deletes a file, never throwing an exception.
static @Nullable java.lang.String	getBaseName(@Nullable java.lang.String filename) Gets the name minus the path and extension from a full filename.
static @Nullable java.lang.String	getExtension(@Nullable java.lang.String filename) Gets the file extension from a full filename.
static @Nullable java.lang.String	getName(@Nullable java.lang.String filename) Gets the name minus the path from a full filename.
static @NonNull java.lang.String	readFileToString(@NonNull java.io.File file, @NonNull java.nio.charset.Charset encoding) Reads the contents of a file into a String.

Methods inherited from class java.lang.Object

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

Method Detail

copyFile

public static void copyFile(@NonNull java.io.File srcFile,
                            @NonNull java.io.File destFile,
                            java.nio.file.CopyOption... options)
                     throws java.io.IOException

Copies a file to another path, preserving the last modified date.

Parameters:

srcFile - An existing file to copy, must not be null.

destFile - The target file, must not be null.

options - Options specifying how the copy should be done.

Throws:

java.io.IOException - If an IO error occurs.

copyFileToDirectory

public static void copyFileToDirectory(@NonNull java.io.File srcFile,
                                       @NonNull java.io.File destDir,
                                       java.nio.file.CopyOption... options)
                                throws java.io.IOException

Copies a file to a directory, preserving the last modified date.

Parameters:

srcFile - An existing file to copy, must not be null.

destDir - The directory to place the copy in, must not be null.

options - Options specifying how the copy should be done.

Throws:

java.io.IOException - If an IO error occurs.

copyDirectory

public static void copyDirectory(@NonNull java.io.File srcDir,
                                 @NonNull java.io.File destDir,
                                 java.nio.file.CopyOption... options)
                          throws java.io.IOException

Copies a directory recursively, preserving the files last modified date.

Parameters:

srcDir - An existing directory to copy, must not be null.

destDir - The target directory, must not be null.

options - Options specifying how the copy should be done.

Throws:

java.io.IOException - If an IO error occurs.

delete

public static boolean delete(@Nullable java.io.File file)
                      throws java.io.IOException

Deletes a file. If file is a directory, delete it and all subdirectories.

Parameters:

file - File or directory to delete, can be null.

Returns:

true If the file or directory was deleted, false otherwise. The file or directory is considered deleted if it exists entering the function and if it does not exist when the function ends, meaning that a null input file or a file that does not exist will return false.

Throws:

java.io.IOException - If an IO error occurs.

deleteQuietly

public static boolean deleteQuietly(@Nullable java.io.File file)

Deletes a file, never throwing an exception. If file is a directory, delete it and all subdirectories.

Parameters:

file - File or directory to delete, can be null.

Returns:

true If the file or directory is deleted, false otherwise.

getBaseName

public static @Nullable java.lang.String getBaseName(@Nullable java.lang.String filename)

Gets the name minus the path and extension from a full filename. The text after the last forward or backslash and before the last dot is returned.

Parameters:

filename - The filename to query, may be null.

Returns:

The name of the file without the path and extension, or an empty string if none exists.

getExtension

public static @Nullable java.lang.String getExtension(@Nullable java.lang.String filename)

Gets the file extension from a full filename. The text after the last dot is returned.

Parameters:

filename - The filename to query, may be null.

Returns:

The extension of the file, or an empty string if none exists.

getName

public static @Nullable java.lang.String getName(@Nullable java.lang.String filename)

Gets the name minus the path from a full filename. The text after the last forward or backslash is returned.

Parameters:

filename - The filename to query, may be null.

Returns:

The name of the file without the path, or an empty string if none exists.

readFileToString

public static @NonNull java.lang.String readFileToString(@NonNull java.io.File file,
                                                         @NonNull java.nio.charset.Charset encoding)
                                                  throws java.io.IOException

Reads the contents of a file into a String.

Parameters:

file - The file to read, must not be null.

encoding - The encoding to use, must not be null.

Returns:

the file contents, never null.

Throws:

java.io.IOException - If an IO error occurs.