Package com.itextpdf.commons.utils
Class FileUtil
java.lang.Object
com.itextpdf.commons.utils.FileUtil
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 TypeMethodDescriptionstatic File
constructFileByDirectoryAndName
(String directory, String fileName) static void
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) 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) static FileOutputStream
getFileOutputStream
(File tempFile) static OutputStream
getFileOutputStream
(String path) static String
Gets the default windows font directory.static InputStream
getInputStreamForFile
(String path) static String
getParentDirectoryUri
(File file) static RandomAccessFile
getRandomAccessFile
(File tempFile) 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)
-
Method Details
-
getFontsDir
Gets the default windows font directory.- Returns:
- the default windows font directory
-
fileExists
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, otherwisefalse
-
isFileNotEmpty
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
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, otherwisefalse
-
listFilesInDirectory
Lists all the files located at the provided directory.- Parameters:
-
path
- path to the directory -
recursive
- iftrue
, files from all the subdirectories will be returned - Returns:
- all the files located at the provided directory
-
listFilesInDirectoryByFilter
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 - Throws:
-
UnsupportedEncodingException
-
getBufferedOutputStream
- Throws:
-
FileNotFoundException
-
wrapWithBufferedOutputStream
-
constructFileByDirectoryAndName
-
createTempFile
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
- Throws:
-
FileNotFoundException
-
getInputStreamForFile
- Throws:
-
IOException
-
getFileOutputStream
- Throws:
-
IOException
-
getRandomAccessFile
- Throws:
-
FileNotFoundException
-
createDirectories
Creates a directory at the provided path.- Parameters:
-
outPath
- path to the directory to be created
-
getParentDirectoryUri
- Throws:
-
MalformedURLException
-
deleteFile
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
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
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
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
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
-