com.itextpdf.commons.utils

Class FileUtil

java.lang.Object

com.itextpdf.commons.utils.FileUtil

public final class FileUtil
extends Object

This file is a helper class for internal usage only. Be aware that its API and functionality may be changed in future.

Method Summary

Modifier and Type	Method and Description
static File	constructFileByDirectoryAndName(String directory, String fileName) Create File instance.
static void	copy(String inputFile, String outputFile) Creates a copy of a file.
static void	createDirectories(String outPath) Creates a directory at the provided path.
static PrintWriter	createPrintWriter(OutputStream output, String encoding) Creates PrintWriter instance.
static String	createTempCopy(String file, String tempFilePrefix, String tempFilePostfix) Creates a temporary copy of a file.
static String	createTempDirectory(String tempFilePrefix) Creates a temporary directory.
static File	createTempFile(String path) Creates a temporary file at the provided path.
static File	createTempFile(String tempFilePrefix, String tempFilePostfix) Creates a temporary file.
static boolean	deleteFile(File file) Deletes a file and returns whether the operation succeeded.
static boolean	directoryExists(String path) Checks whether there is a directory at the provided path.
static boolean	fileExists(String path) Checks whether there is a file at the provided path.
static OutputStream	getBufferedOutputStream(String filename) Creates OutputStream instance for filename.
static OutputStream	getFileOutputStream(File tempFile) Creates FileOutputStream instance.
static OutputStream	getFileOutputStream(String path) Creates OutputStream instance.
static String	getFontsDir() Gets the default windows font directory.
static InputStream	getInputStreamForFile(File file) Creates InputStream instance.
static InputStream	getInputStreamForFile(String path) Creates InputStream instance.
static String	getParentDirectoryUri(File file) Returns an URI of the parent directory for the resource.
static RandomAccessFile	getRandomAccessFile(File tempFile) Creates RandomAccessFile instance.
static boolean	isFileNotEmpty(String path) Checks whether is provided file not empty.
static String[]	listFilesInDirectory(String path, boolean recursive) Lists all the files located at the provided directory.
static File[]	listFilesInDirectoryByFilter(String outPath, FileFilter fileFilter) Lists all the files located at the provided directory, which are accepted by the provided filter.
static String	parentDirectory(URL url) Returns an URL of the parent directory for the resource.
static boolean	removeFiles(String[] paths) Removes all of the passed files.
static OutputStream	wrapWithBufferedOutputStream(OutputStream outputStream) Wraps provided output stream with buffered one.

Methods inherited from class java.lang.Object

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

Method Detail

getFontsDir

public static String getFontsDir()

Gets the default windows font directory.

Returns:

the default windows font directory

fileExists

public static boolean fileExists(String path)

Checks whether there is a file at the provided path.

Parameters:

path - the path to the file to be checked on existence

Returns:

true if such a file exists, otherwise false

isFileNotEmpty

public static boolean isFileNotEmpty(String path)

Checks whether is provided file not empty.

Parameters:

path - the path to the file to be checked on emptiness

Returns:

true if such file is not empty, false otherwise

directoryExists

public static boolean directoryExists(String path)

Checks whether there is a directory at the provided path.

Parameters:

path - the path to the directory to be checked on existence

Returns:

true if such a directory exists, otherwise false

listFilesInDirectory

public static String[] listFilesInDirectory(String path,
                                            boolean recursive)

Lists all the files located at the provided directory.

Parameters:

path - path to the directory

recursive - if true, files from all the subdirectories will be returned

Returns:

all the files located at the provided directory

listFilesInDirectoryByFilter

public static File[] listFilesInDirectoryByFilter(String outPath,
                                                  FileFilter fileFilter)

Lists all the files located at the provided directory, which are accepted by the provided filter.

Parameters:

outPath - path to the directory

fileFilter - filter to accept files to be listed

Returns:

all the files located at the provided directory, which are accepted by the provided filter

createPrintWriter

public static PrintWriter createPrintWriter(OutputStream output,
                                            String encoding)
                                     throws UnsupportedEncodingException

Creates PrintWriter instance.

Parameters:

output - output stream where data will be written.

encoding - encoding in which data will be written.

Returns:

PrintWriter instance.

Throws:

UnsupportedEncodingException - in case of unknown encoding.

getBufferedOutputStream

public static OutputStream getBufferedOutputStream(String filename)
                                            throws IOException

Creates OutputStream instance for filename.

Parameters:

filename - name of the file for which output stream will be created.

Returns:

OutputStream instance.

Throws:

FileNotFoundException - if file not found.

IOException

wrapWithBufferedOutputStream

public static OutputStream wrapWithBufferedOutputStream(OutputStream outputStream)

Wraps provided output stream with buffered one.

Parameters:

outputStream - output stream to wrap.

Returns:

BufferedOutputStream instance if provided stream was not buffered before.

constructFileByDirectoryAndName

public static File constructFileByDirectoryAndName(String directory,
                                                   String fileName)

Create File instance.

Parameters:

directory - the parent pathname string.

fileName - The child pathname string.

Returns:

File instance.

createTempFile

public static File createTempFile(String path)
                           throws IOException

Creates a temporary file at the provided path.

Parameters:

path - path to the temporary file to be created. If it is a directory, then the temporary file will be created at this directory

Returns:

the created temporary file

Throws:

IOException - signals that an I/O exception has occurred

getFileOutputStream

public static OutputStream getFileOutputStream(File tempFile)
                                        throws IOException

Creates FileOutputStream instance.

Parameters:

tempFile - filename for which output stream will be created.

Returns:

FileOutputStream instance.

Throws:

IOException - in file reading errors.

getInputStreamForFile

public static InputStream getInputStreamForFile(String path)
                                         throws IOException

Creates InputStream instance.

Parameters:

path - filename for which output stream will be created.

Returns:

InputStream instance.

Throws:

IOException - in file reading errors.

getInputStreamForFile

public static InputStream getInputStreamForFile(File file)
                                         throws IOException

Creates InputStream instance.

Parameters:

file - filename for which output stream will be created.

Returns:

InputStream instance.

Throws:

IOException - in file reading errors.

getFileOutputStream

public static OutputStream getFileOutputStream(String path)
                                        throws IOException

Creates OutputStream instance.

Parameters:

path - filename for which output stream will be created.

Returns:

OutputStream instance.

Throws:

IOException - in file r/w errors.

getRandomAccessFile

public static RandomAccessFile getRandomAccessFile(File tempFile)
                                            throws FileNotFoundException

Creates RandomAccessFile instance.

Parameters:

tempFile - file for which RAF will be created.

Returns:

RandomAccessFile instance.

Throws:

FileNotFoundException - in case file not found.

createDirectories

public static void createDirectories(String outPath)

Creates a directory at the provided path.

Parameters:

outPath - path to the directory to be created

getParentDirectoryUri

public static String getParentDirectoryUri(File file)
                                    throws MalformedURLException

Returns an URI of the parent directory for the resource.

Parameters:

file - for which an URI of the parent will be constructed.

Returns:

parent directory URI.

Throws:

MalformedURLException - If a protocol handler for the URL could not be found, or if some other error occurred while constructing the URL.

deleteFile

public static boolean deleteFile(File file)

Deletes a file and returns whether the operation succeeded. Note that only *files* are supported, not directories.

Parameters:

file - file to be deleted

Returns:

true if file was deleted successfully, false otherwise

parentDirectory

public static String parentDirectory(URL url)
                              throws URISyntaxException

Returns an URL of the parent directory for the resource.

Parameters:

url - of resource

Returns:

parent directory path| the same path if a catalog`s url is passed;

Throws:

URISyntaxException - if this URL is not formatted strictly according to RFC2396 and cannot be converted to a URI.

createTempFile

public static File createTempFile(String tempFilePrefix,
                                  String tempFilePostfix)
                           throws IOException

Creates a temporary file.

Note, that this method creates temporary file with provided file's prefix and postfix using File.createTempFile(String, String).

Parameters:

tempFilePrefix - the prefix of the copied file's name

tempFilePostfix - the postfix of the copied file's name

Returns:

the path to the copied file

Throws:

IOException - signals that an I/O exception has occurred.

createTempCopy

public static String createTempCopy(String file,
                                    String tempFilePrefix,
                                    String tempFilePostfix)
                             throws IOException

Creates a temporary copy of a file.

Note, that this method creates temporary file with provided file's prefix and postfix using Files.createTempFile(String, String, FileAttribute[]).

Parameters:

file - the path to the file to be copied

tempFilePrefix - the prefix of the copied file's name

tempFilePostfix - the postfix of the copied file's name

Returns:

the path to the copied file

Throws:

IOException - signals that an I/O exception has occurred.

copy

public static void copy(String inputFile,
                        String outputFile)
                 throws IOException

Creates a copy of a file.

Parameters:

inputFile - the path to the file to be copied

outputFile - the path, to which the passed file should be copied

Throws:

IOException - signals that an I/O exception has occurred.

createTempDirectory

public static String createTempDirectory(String tempFilePrefix)
                                  throws IOException

Creates a temporary directory.

Note, that this method creates temporary directory with provided directory prefix using Files.createTempDirectory(String, FileAttribute[]).

Parameters:

tempFilePrefix - the prefix of the temporary directory's name

Returns:

the path to the temporary directory

Throws:

IOException - signals that an I/O exception has occurred.

removeFiles

public static boolean removeFiles(String[] paths)

Removes all of the passed files.

Parameters:

paths - paths to files, which should be removed

Returns:

true if all the files have been successfully removed, false otherwise