org.apache.camel.util

Class FileUtil

java.lang.Object

org.apache.camel.util.FileUtil

public final class FileUtil
extends Object

File utilities.

Field Summary

Fields

Modifier and Type	Field and Description
static int	BUFFER_SIZE

Method Summary

Modifier and Type	Method and Description
static String	compactPath(String path) Compacts a path by stacking it and reducing .., and uses OS specific file separators (eg File.separator).
static String	compactPath(String path, char separator) Compacts a path by stacking it and reducing .., and uses the given separator.
static String	compactPath(String path, String separator) Compacts a file path by stacking it and reducing .., and uses the given separator.
static void	copyFile(File from, File to) Copies the file
static boolean	createNewFile(File file) Creates a new file.
static File	createTempFile(String prefix, String suffix) Deprecated.
static File	createTempFile(String prefix, String suffix, File parentDir)
static boolean	deleteFile(File file) Deletes the file.
static File	getUserDir()
static boolean	hasLeadingSeparator(String name) Does the name start with a leading separator
static boolean	isAbsolute(File file) Is the given file an absolute file.
static boolean	isWindows() Returns true, if the OS is windows
static String	normalizePath(String path) Normalizes the path to cater for Windows and other platforms
static String	onlyExt(String name)
static String	onlyExt(String name, boolean singleMode)
static String	onlyPath(String name) Returns only the leading path (returns null if no path)
static void	removeDir(File d)
static boolean	renameFile(File from, File to, boolean copyAndDeleteOnRenameFail) Renames a file.
static boolean	renameFileUsingCopy(File from, File to) Rename file using copy and delete strategy.
static void	shutdown() Deprecated.
static String	stripExt(String name)
static String	stripExt(String name, boolean singleMode)
static String	stripFirstLeadingSeparator(String name) Strip first leading separator
static String	stripLeadingSeparator(String name) Strip any leading separators
static String	stripPath(String name) Strips any leading paths
static String	stripTrailingSeparator(String name) Strip any trailing separators

Methods inherited from class java.lang.Object

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

Field Detail

BUFFER_SIZE

public static final int BUFFER_SIZE

See Also:

Constant Field Values

Method Detail

getUserDir

public static File getUserDir()

normalizePath

public static String normalizePath(String path)

Normalizes the path to cater for Windows and other platforms

isWindows

public static boolean isWindows()

Returns true, if the OS is windows

createTempFile

@Deprecated
public static File createTempFile(String prefix,
                                              String suffix)
                                       throws IOException

Deprecated.

Throws:

IOException

createTempFile

public static File createTempFile(String prefix,
                                  String suffix,
                                  File parentDir)
                           throws IOException

Throws:

IOException

stripLeadingSeparator

public static String stripLeadingSeparator(String name)

Strip any leading separators

hasLeadingSeparator

public static boolean hasLeadingSeparator(String name)

Does the name start with a leading separator

stripFirstLeadingSeparator

public static String stripFirstLeadingSeparator(String name)

Strip first leading separator

stripTrailingSeparator

public static String stripTrailingSeparator(String name)

Strip any trailing separators

stripPath

public static String stripPath(String name)

Strips any leading paths

stripExt

public static String stripExt(String name)

stripExt

public static String stripExt(String name,
                              boolean singleMode)

onlyExt

public static String onlyExt(String name)

onlyExt

public static String onlyExt(String name,
                             boolean singleMode)

onlyPath

public static String onlyPath(String name)

Returns only the leading path (returns null if no path)

compactPath

public static String compactPath(String path)

Compacts a path by stacking it and reducing .., and uses OS specific file separators (eg File.separator).

compactPath

public static String compactPath(String path,
                                 char separator)

Compacts a path by stacking it and reducing .., and uses the given separator.

compactPath

public static String compactPath(String path,
                                 String separator)

Compacts a file path by stacking it and reducing .., and uses the given separator.

shutdown

@Deprecated
public static void shutdown()

Deprecated.

Shutdown and cleanup the temporary directory and removes any shutdown hooks in use.

removeDir

public static void removeDir(File d)

renameFile

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

Renames a file.

Parameters:

from - the from file

to - the to file

copyAndDeleteOnRenameFail - whether to fallback and do copy and delete, if renameTo fails

Returns:

true if the file was renamed, otherwise false

Throws:

IOException - is thrown if error renaming file

renameFileUsingCopy

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

Rename file using copy and delete strategy. This is primarily used in environments where the regular rename operation is unreliable.

Parameters:

from - the file to be renamed

to - the new target file

Returns:

true if the file was renamed successfully, otherwise false

Throws:

IOException - If an I/O error occurs during copy or delete operations.

copyFile

public static void copyFile(File from,
                            File to)
                     throws IOException

Copies the file

Parameters:

from - the source file

to - the destination file

Throws:

IOException - If an I/O error occurs during copy operation

deleteFile

public static boolean deleteFile(File file)

Deletes the file.

This implementation will attempt to delete the file up till three times with one second delay, which can mitigate problems on deleting files on some platforms such as Windows.

Parameters:

file - the file to delete

isAbsolute

public static boolean isAbsolute(File file)

Is the given file an absolute file.

Will also work around issue on Windows to consider files on Windows starting with a \ as absolute files. This makes the logic consistent across all OS platforms.

Parameters:

file - the file

Returns:

true if its an absolute path, false otherwise.

createNewFile

public static boolean createNewFile(File file)
                             throws IOException

Creates a new file.

Parameters:

file - the file

Returns:

true if created a new file, false otherwise

Throws:

IOException - is thrown if error creating the new file