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 void	copy(String inputFile, String outputFile) Creates a copy of a file.
static void	createDirectories(String outPath)
static PrintWriter	createPrintWriter(OutputStream output, String encoding)
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)
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)
static boolean	fileExists(String path)
static OutputStream	getBufferedOutputStream(String filename)
static FileOutputStream	getFileOutputStream(File tempFile)
static String	getFontsDir()
static InputStream	getInputStreamForFile(String path)
static String	getParentDirectoryUri(File file)
static RandomAccessFile	getRandomAccessFile(File tempFile)
static String[]	listFilesInDirectory(String path, boolean recursive)
static File[]	listFilesInDirectoryByFilter(String outPath, FileFilter fileFilter)
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)

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()

fileExists

public static boolean fileExists(String path)

directoryExists

public static boolean directoryExists(String path)

listFilesInDirectory

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

listFilesInDirectoryByFilter

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

createPrintWriter

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

Throws:

UnsupportedEncodingException

getBufferedOutputStream

public static OutputStream getBufferedOutputStream(String filename)
                                            throws FileNotFoundException

Throws:

FileNotFoundException

wrapWithBufferedOutputStream

public static OutputStream wrapWithBufferedOutputStream(OutputStream outputStream)

createTempFile

public static File createTempFile(String path)
                           throws IOException

Throws:

IOException

getFileOutputStream

public static FileOutputStream getFileOutputStream(File tempFile)
                                            throws FileNotFoundException

Throws:

FileNotFoundException

getInputStreamForFile

public static InputStream getInputStreamForFile(String path)
                                         throws IOException

Throws:

IOException

getRandomAccessFile

public static RandomAccessFile getRandomAccessFile(File tempFile)
                                            throws FileNotFoundException

Throws:

FileNotFoundException

createDirectories

public static void createDirectories(String outPath)

getParentDirectoryUri

public static String getParentDirectoryUri(File file)
                                    throws MalformedURLException

Throws:

MalformedURLException

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.

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.

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.

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