com.revolsys.io

Class FileUtil

java.lang.Object

com.revolsys.io.FileUtil

public final class FileUtil
extends Object

The FileUtil class is a utility class for performing common tasks with classes from the java.io package.

Author:

Paul Austin

Field Summary

Fields

Modifier and Type	Field and Description
static FilenameFilter	IMAGE_FILENAME_FILTER
static char	UNIX_FILE_SEPARATOR The file path separator for UNIX based systems.
static Charset	UTF8
static FilenameFilter	VIDEO_FILENAME_FILTER
static char	WINDOWS_FILE_SEPARATOR The file path separator for Windows based systems.

Method Summary

Methods

Modifier and Type	Method and Description
static void	closeSilent(AutoCloseable... closeables) Close the writer without throwing an I/O exception if the close failed.
static void	closeSilent(Collection<? extends AutoCloseable> closeables) Close the writer without throwing an I/O exception if the close failed.
static String	convertPath(String path) Convert the path containing UNIX or Windows file separators to the local File.separator character.
static void	copy(File src, File dest)
static long	copy(File file, OutputStream out) Copy the contents of the file to the output stream.
static long	copy(File file, Writer out) Copy the contents of the file to the writer.
static long	copy(InputStream in, File file) Copy the contents of the input stream to the file.
static void	copy(InputStream zin, File file, long sz) Writes the content of a zip entry to a file using NIO.
static long	copy(InputStream in, OutputStream out) Copy the contents of the input stream to the output stream.
static void	copy(Reader in, File file) Copy the contents of the reader to the file.
static long	copy(Reader in, Writer out) Copy the contents of the reader to the writer.
static void	copy(String text, File file)
static File	createTempDirectory(String prefix, String suffix) Create a new temporary directory.
static File	createTempFile(String prefix, String suffix)
static InputStreamReader	createUtf8Reader(InputStream in)
static OutputStreamWriter	createUtf8Writer(OutputStream out)
static boolean	deleteDirectory(File directory) Delete a directory and all the files and sub directories below the directory.
static boolean	deleteDirectory(File directory, boolean deleteRoot) Delete all the files and sub directories below the directory.
static void	deleteDirectory(File directory, FilenameFilter filter)
static void	deleteFileOnExit(File file) Add the file to be deleted on exit.
static void	deleteFiles(File directory, String pattern) Delete the files that match the java regular expression.
static void	deleteFilesOlderThan(File directory, Date date)
static void	deleteFilesOlderThan(File directory, long age)
static String	fromSafeName(String fileName)
static String	getBaseName(File file)
static String	getBaseName(String name)
static String	getCanonicalPath(File file)
static String	getCanonicalPath(String fileName)
static File	getCurrentDirectory()
static List<File>	getDirectories(File directory)
static File	getDirectory(File parent, String path)
static File	getDirectory(String path)
static List<String>	getDirectoryNames(File directory)
static File	getFile(File file)
static File	getFile(File file, String path)
static File	getFile(org.springframework.core.io.Resource resource)
static File	getFile(String path)
static File	getFile(URI uri)
static File	getFile(URL url)
static String	getFileAsString(String fileName)
static List<String>	getFileBaseNamesByExtension(File directory, String extension)
static String	getFileName(File file)
static String	getFileName(String fileName)
static String	getFileNameExtension(File file)
static String	getFileNameExtension(String fileName)
static List<String>	getFileNameExtensions(File file)
static List<String>	getFileNameExtensions(String fileName)
static String	getFileNamePrefix(File file)
static List<String>	getFileNames(File directory, FilenameFilter filter)
static List<String>	getFileNamesByExtension(File directory, String extension)
static List<File>	getFiles(File directory, FilenameFilter filter)
static List<File>	getFilesByExtension(File directory, String... extensions)
static File	getFileWithExtension(File file, String extension) Get a new file object with the current extension replaced with the new extension.
static FileInputStream	getInputStream(File file)
static FileReader	getReader(File file)
static String	getRelativePath(File parentDirectory, File file) Return the relative path of the file from the parentDirectory.
static File	getSafeFileName(File directory, String name)
static String	getSafeFileName(String name)
static String	getString(File file)
static String	getString(InputStream in)
static String	getString(Reader reader)
static File	getUrlFile(String url)
static File	getUserHomeDirectory()
static Writer	getWriter(File file)
static boolean	isRoot(File file)
static List<File>	listVisibleFiles(File file)
static List<File>	listVisibleFiles(File file, FileFilter filter)
static String	toSafeName(String host)
static URL	toUrl(File file)
static String	toUrlString(File file)

Methods inherited from class java.lang.Object

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

Field Detail

UNIX_FILE_SEPARATOR

public static final char UNIX_FILE_SEPARATOR

The file path separator for UNIX based systems.

See Also:

Constant Field Values

UTF8

public static final Charset UTF8

WINDOWS_FILE_SEPARATOR

public static final char WINDOWS_FILE_SEPARATOR

The file path separator for Windows based systems.

See Also:

Constant Field Values

IMAGE_FILENAME_FILTER

public static final FilenameFilter IMAGE_FILENAME_FILTER

VIDEO_FILENAME_FILTER

public static final FilenameFilter VIDEO_FILENAME_FILTER

Method Detail

closeSilent

public static void closeSilent(AutoCloseable... closeables)

Close the writer without throwing an I/O exception if the close failed. The error will be logged instead.

Parameters:

closeables - The closables to close.

closeSilent

public static void closeSilent(Collection<? extends AutoCloseable> closeables)

Close the writer without throwing an I/O exception if the close failed. The error will be logged instead.

Parameters:

closeables - The closables to close.

convertPath

public static String convertPath(String path)

Convert the path containing UNIX or Windows file separators to the local File.separator character.

Parameters:

path - The path to convert.

Returns:

The converted path.

copy

public static void copy(File src,
        File dest)

copy

public static long copy(File file,
        OutputStream out)
                 throws IOException

Copy the contents of the file to the output stream. The output stream will need to be closed manually after invoking this method.

Parameters:

file - The file to read the contents from.

out - The output stream to write the contents to.

Throws:

IOException - If an I/O error occurs.

copy

public static long copy(File file,
        Writer out)
                 throws IOException

Copy the contents of the file to the writer. The writer will need to be closed manually after invoking this method.

Parameters:

file - The file to read the contents from.

out - The writer to write the contents to.

Throws:

IOException - If an I/O error occurs.

copy

public static long copy(InputStream in,
        File file)

Copy the contents of the input stream to the file. The input stream will need to be closed manually after invoking this method.

Parameters:

in - The input stream to read the contents from.

file - The file to write the contents to.

Throws:

IOException - If an I/O error occurs.

copy

public static void copy(InputStream zin,
        File file,
        long sz)
                 throws IOException

Writes the content of a zip entry to a file using NIO.

Parameters:

zin - input stream from zip file

file - file path where this entry will be saved

sz - file size

Throws:

IOException - if an i/o error

copy

public static long copy(InputStream in,
        OutputStream out)

Copy the contents of the input stream to the output stream. The input stream and output stream will need to be closed manually after invoking this method.

Parameters:

in - The input stream to read the contents from.

out - The output stream to write the contents to.

copy

public static void copy(Reader in,
        File file)

Copy the contents of the reader to the file. The reader will need to be closed manually after invoking this method.

Parameters:

in - The reader to read the contents from.

file - The file to write the contents to.

Throws:

IOException - If an I/O error occurs.

copy

public static long copy(Reader in,
        Writer out)

Copy the contents of the reader to the writer. The reader and writer will need to be closed manually after invoking this method.

Parameters:

in - The reader to read the contents from.

out - The writer to write the contents to.

Throws:

IOException - If an I/O error occurs.

copy

public static void copy(String text,
        File file)

createTempDirectory

public static File createTempDirectory(String prefix,
                       String suffix)

Create a new temporary directory.

Parameters:

prefix - The file name prefix.

suffix - The file name suffix.

Returns:

The temportary directory.

Throws:

IOException - If there was an exception creating the directory.

createTempFile

public static File createTempFile(String prefix,
                  String suffix)

createUtf8Reader

public static InputStreamReader createUtf8Reader(InputStream in)

createUtf8Writer

public static OutputStreamWriter createUtf8Writer(OutputStream out)

deleteDirectory

public static boolean deleteDirectory(File directory)

Delete a directory and all the files and sub directories below the directory.

Parameters:

directory - The directory to delete.

deleteDirectory

public static boolean deleteDirectory(File directory,
                      boolean deleteRoot)

Delete all the files and sub directories below the directory. If the deleteRoot flag is true the directory will also be deleted.

Parameters:

directory - The directory to delete.

deleteRoot - Flag indicating if the directory should also be deleted.

Throws:

IOException - If a file or directory could not be deleted.

deleteDirectory

public static void deleteDirectory(File directory,
                   FilenameFilter filter)

deleteFileOnExit

public static void deleteFileOnExit(File file)

Add the file to be deleted on exit. If the file is a directory the directory and it's contents will be deleted. DON'T use in web applications

Parameters:

file - The file or directory to delete.

deleteFiles

public static void deleteFiles(File directory,
               String pattern)

Delete the files that match the java regular expression.

Parameters:

directory - The directory.

pattern - The regular expression to match

deleteFilesOlderThan

public static void deleteFilesOlderThan(File directory,
                        Date date)

deleteFilesOlderThan

public static void deleteFilesOlderThan(File directory,
                        long age)

fromSafeName

public static String fromSafeName(String fileName)

getBaseName

public static String getBaseName(File file)

getBaseName

public static String getBaseName(String name)

getCanonicalPath

public static String getCanonicalPath(File file)

getCanonicalPath

public static String getCanonicalPath(String fileName)

getCurrentDirectory

public static File getCurrentDirectory()

getDirectories

public static List<File> getDirectories(File directory)

getDirectory

public static File getDirectory(File parent,
                String path)

getDirectory

public static File getDirectory(String path)

getDirectoryNames

public static List<String> getDirectoryNames(File directory)

getFile

public static File getFile(File file)

getFile

public static File getFile(File file,
           String path)

getFile

public static File getFile(org.springframework.core.io.Resource resource)
                    throws IOException

Throws:

IOException

getFile

public static File getFile(String path)

getFile

public static File getFile(URI uri)

getFile

public static File getFile(URL url)

getFileAsString

public static String getFileAsString(String fileName)

getFileBaseNamesByExtension

public static List<String> getFileBaseNamesByExtension(File directory,
                                       String extension)

getFileName

public static String getFileName(File file)

getFileName

public static String getFileName(String fileName)

getFileNameExtension

public static String getFileNameExtension(File file)

getFileNameExtension

public static String getFileNameExtension(String fileName)

getFileNameExtensions

public static List<String> getFileNameExtensions(File file)

getFileNameExtensions

public static List<String> getFileNameExtensions(String fileName)

getFileNamePrefix

public static String getFileNamePrefix(File file)

getFileNames

public static List<String> getFileNames(File directory,
                        FilenameFilter filter)

getFileNamesByExtension

public static List<String> getFileNamesByExtension(File directory,
                                   String extension)

getFiles

public static List<File> getFiles(File directory,
                  FilenameFilter filter)

getFilesByExtension

public static List<File> getFilesByExtension(File directory,
                             String... extensions)

getFileWithExtension

public static File getFileWithExtension(File file,
                        String extension)

Get a new file object with the current extension replaced with the new extension.

Parameters:

file -

extension -

Returns:

getInputStream

public static FileInputStream getInputStream(File file)

getReader

public static FileReader getReader(File file)

getRelativePath

public static String getRelativePath(File parentDirectory,
                     File file)

Return the relative path of the file from the parentDirectory. For example the relative path of c:\Data\Files\file1.txt and c:\Data would be Files\file1.txt.

Parameters:

parentDirectory - The parent directory.

file - The file to return the relative path for.

Returns:

The relative path.

Throws:

IOException - If an I/O error occurs.

getSafeFileName

public static File getSafeFileName(File directory,
                   String name)

getSafeFileName

public static String getSafeFileName(String name)

getString

public static String getString(File file)

getString

public static String getString(InputStream in)

getString

public static String getString(Reader reader)

getUrlFile

public static File getUrlFile(String url)

getUserHomeDirectory

public static File getUserHomeDirectory()

getWriter

public static Writer getWriter(File file)

isRoot

public static boolean isRoot(File file)

listVisibleFiles

public static List<File> listVisibleFiles(File file)

listVisibleFiles

public static List<File> listVisibleFiles(File file,
                          FileFilter filter)

toSafeName

public static String toSafeName(String host)

toUrl

public static URL toUrl(File file)

toUrlString

public static String toUrlString(File file)