com.liferay.portal.kernel.util

Class FileUtil

java.lang.Object

com.liferay.portal.kernel.util.FileUtil

public class FileUtil
extends java.lang.Object

Author:

Brian Wing Shun Chan, Alexander Chow

Constructor Summary

Constructors

Constructor and Description
FileUtil()

Method Summary

Modifier and Type	Method and Description
static java.lang.String	appendParentheticalSuffix(java.lang.String fileName, java.lang.String suffix)
static java.lang.String	appendSuffix(java.lang.String fileName, java.lang.String suffix)
static void	copyDirectory(java.io.File source, java.io.File destination)
static void	copyDirectory(java.lang.String sourceDirName, java.lang.String destinationDirName)
static void	copyFile(java.io.File source, java.io.File destination)
static void	copyFile(java.io.File source, java.io.File destination, boolean lazy)
static void	copyFile(java.lang.String source, java.lang.String destination)
static void	copyFile(java.lang.String source, java.lang.String destination, boolean lazy)
static java.io.File	createTempFile()
static java.io.File	createTempFile(byte[] bytes)
static java.io.File	createTempFile(java.io.InputStream is)
static java.io.File	createTempFile(java.lang.String extension)
static java.io.File	createTempFile(java.lang.String prefix, java.lang.String extension)
static java.lang.String	createTempFileName()
static java.lang.String	createTempFileName(java.lang.String extension)
static java.lang.String	createTempFileName(java.lang.String prefix, java.lang.String extension)
static java.io.File	createTempFolder()
static java.lang.String	decodeSafeFileName(java.lang.String fileName)
static boolean	delete(java.io.File file)
static boolean	delete(java.lang.String file)
static void	deltree(java.io.File directory)
static void	deltree(java.lang.String directory)
static java.lang.String	encodeSafeFileName(java.lang.String fileName)
static boolean	exists(java.io.File file)
static boolean	exists(java.lang.String fileName)
static java.lang.String	extractText(java.io.InputStream is, java.lang.String fileName) Extracts the text from the input stream and file name.
static java.lang.String	extractText(java.io.InputStream is, java.lang.String fileName, int maxStringLength)
static java.lang.String[]	find(java.lang.String directory, java.lang.String includes, java.lang.String excludes)
static java.lang.String	getAbsolutePath(java.io.File file)
static byte[]	getBytes(java.lang.Class<?> clazz, java.lang.String fileName)
static byte[]	getBytes(java.io.File file)
static byte[]	getBytes(java.io.InputStream is)
static byte[]	getBytes(java.io.InputStream is, int bufferSize)
static byte[]	getBytes(java.io.InputStream is, int bufferSize, boolean cleanUpStream)
static java.lang.String	getExtension(java.lang.String fileName)
static File	getFile()
static java.lang.String	getMD5Checksum(java.io.File file)
static java.lang.String	getPath(java.lang.String fullFileName)
static java.lang.String	getShortFileName(java.lang.String fullFileName)
static boolean	isAscii(java.io.File file)
static boolean	isSameContent(java.io.File file, byte[] bytes, int length)
static boolean	isSameContent(java.io.File file, java.lang.String s)
static java.lang.String[]	listDirs(java.io.File file)
static java.lang.String[]	listDirs(java.lang.String fileName)
static java.lang.String[]	listFiles(java.io.File file)
static java.lang.String[]	listFiles(java.lang.String fileName)
static void	mkdirs(java.io.File file)
static void	mkdirs(java.lang.String pathName)
static boolean	move(java.io.File source, java.io.File destination)
static boolean	move(java.lang.String sourceFileName, java.lang.String destinationFileName)
static java.lang.String	read(java.io.File file)
static java.lang.String	read(java.io.File file, boolean raw)
static java.lang.String	read(java.lang.String fileName)
static java.lang.String	replaceSeparator(java.lang.String fileName)
void	setFile(File file)
static java.io.File[]	sortFiles(java.io.File[] files)
static java.lang.String	stripExtension(java.lang.String fileName)
static java.lang.String	stripParentheticalSuffix(java.lang.String fileName)
static java.util.List<java.lang.String>	toList(java.io.Reader reader)
static java.util.List<java.lang.String>	toList(java.lang.String fileName)
static java.util.Properties	toProperties(java.io.FileInputStream fis)
static java.util.Properties	toProperties(java.lang.String fileName)
static void	touch(java.io.File file)
static void	touch(java.lang.String fileName)
static void	unzip(java.io.File source, java.io.File destination)
static void	write(java.io.File file, byte[] bytes)
static void	write(java.io.File file, byte[] bytes, boolean append)
static void	write(java.io.File file, byte[] bytes, int offset, int length)
static void	write(java.io.File file, byte[] bytes, int offset, int length, boolean append)
static void	write(java.io.File file, java.io.InputStream is)
static void	write(java.io.File file, java.lang.String s)
static void	write(java.io.File file, java.lang.String s, boolean lazy)
static void	write(java.io.File file, java.lang.String s, boolean lazy, boolean append)
static void	write(java.lang.String fileName, byte[] bytes)
static void	write(java.lang.String fileName, java.io.InputStream is)
static void	write(java.lang.String fileName, java.lang.String s)
static void	write(java.lang.String fileName, java.lang.String s, boolean lazy)
static void	write(java.lang.String fileName, java.lang.String s, boolean lazy, boolean append)
static void	write(java.lang.String pathName, java.lang.String fileName, java.lang.String s)
static void	write(java.lang.String pathName, java.lang.String fileName, java.lang.String s, boolean lazy)
static void	write(java.lang.String pathName, java.lang.String fileName, java.lang.String s, boolean lazy, boolean append)

Methods inherited from class java.lang.Object

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

Constructor Detail

FileUtil

public FileUtil()

Method Detail

appendParentheticalSuffix

public static java.lang.String appendParentheticalSuffix(java.lang.String fileName,
                                                         java.lang.String suffix)

appendSuffix

public static java.lang.String appendSuffix(java.lang.String fileName,
                                            java.lang.String suffix)

copyDirectory

public static void copyDirectory(java.io.File source,
                                 java.io.File destination)
                          throws java.io.IOException

Throws:

java.io.IOException

copyDirectory

public static void copyDirectory(java.lang.String sourceDirName,
                                 java.lang.String destinationDirName)
                          throws java.io.IOException

Throws:

java.io.IOException

copyFile

public static void copyFile(java.io.File source,
                            java.io.File destination)
                     throws java.io.IOException

Throws:

java.io.IOException

copyFile

public static void copyFile(java.io.File source,
                            java.io.File destination,
                            boolean lazy)
                     throws java.io.IOException

Throws:

java.io.IOException

copyFile

public static void copyFile(java.lang.String source,
                            java.lang.String destination)
                     throws java.io.IOException

Throws:

java.io.IOException

copyFile

public static void copyFile(java.lang.String source,
                            java.lang.String destination,
                            boolean lazy)
                     throws java.io.IOException

Throws:

java.io.IOException

createTempFile

public static java.io.File createTempFile()

createTempFile

public static java.io.File createTempFile(byte[] bytes)
                                   throws java.io.IOException

Throws:

java.io.IOException

createTempFile

public static java.io.File createTempFile(java.io.InputStream is)
                                   throws java.io.IOException

Throws:

java.io.IOException

createTempFile

public static java.io.File createTempFile(java.lang.String extension)

createTempFile

public static java.io.File createTempFile(java.lang.String prefix,
                                          java.lang.String extension)

createTempFileName

public static java.lang.String createTempFileName()

createTempFileName

public static java.lang.String createTempFileName(java.lang.String extension)

createTempFileName

public static java.lang.String createTempFileName(java.lang.String prefix,
                                                  java.lang.String extension)

createTempFolder

public static java.io.File createTempFolder()
                                     throws java.io.IOException

Throws:

java.io.IOException

decodeSafeFileName

public static java.lang.String decodeSafeFileName(java.lang.String fileName)

delete

public static boolean delete(java.io.File file)

delete

public static boolean delete(java.lang.String file)

deltree

public static void deltree(java.io.File directory)

deltree

public static void deltree(java.lang.String directory)

encodeSafeFileName

public static java.lang.String encodeSafeFileName(java.lang.String fileName)

exists

public static boolean exists(java.io.File file)

exists

public static boolean exists(java.lang.String fileName)

extractText

public static java.lang.String extractText(java.io.InputStream is,
                                           java.lang.String fileName)

Extracts the text from the input stream and file name.

Parameters:

is - the file's input stream

fileName - the file's full name or extension (e.g., "Test.doc" or ".doc")

Returns:

the extracted text if it is a supported format or an empty string if it is an unsupported format

extractText

public static java.lang.String extractText(java.io.InputStream is,
                                           java.lang.String fileName,
                                           int maxStringLength)

find

public static java.lang.String[] find(java.lang.String directory,
                                      java.lang.String includes,
                                      java.lang.String excludes)

getAbsolutePath

public static java.lang.String getAbsolutePath(java.io.File file)

getBytes

public static byte[] getBytes(java.lang.Class<?> clazz,
                              java.lang.String fileName)
                       throws java.lang.Exception

Throws:

java.lang.Exception

getBytes

public static byte[] getBytes(java.io.File file)
                       throws java.io.IOException

Throws:

java.io.IOException

getBytes

public static byte[] getBytes(java.io.InputStream is)
                       throws java.io.IOException

Throws:

java.io.IOException

getBytes

public static byte[] getBytes(java.io.InputStream is,
                              int bufferSize)
                       throws java.io.IOException

Throws:

java.io.IOException

getBytes

public static byte[] getBytes(java.io.InputStream is,
                              int bufferSize,
                              boolean cleanUpStream)
                       throws java.io.IOException

Throws:

java.io.IOException

getExtension

public static java.lang.String getExtension(java.lang.String fileName)

getFile

public static File getFile()

getMD5Checksum

public static java.lang.String getMD5Checksum(java.io.File file)
                                       throws java.io.IOException

Throws:

java.io.IOException

getPath

public static java.lang.String getPath(java.lang.String fullFileName)

getShortFileName

public static java.lang.String getShortFileName(java.lang.String fullFileName)

isAscii

public static boolean isAscii(java.io.File file)
                       throws java.io.IOException

Throws:

java.io.IOException

isSameContent

public static boolean isSameContent(java.io.File file,
                                    byte[] bytes,
                                    int length)

isSameContent

public static boolean isSameContent(java.io.File file,
                                    java.lang.String s)

listDirs

public static java.lang.String[] listDirs(java.io.File file)

listDirs

public static java.lang.String[] listDirs(java.lang.String fileName)

listFiles

public static java.lang.String[] listFiles(java.io.File file)

listFiles

public static java.lang.String[] listFiles(java.lang.String fileName)

mkdirs

public static void mkdirs(java.io.File file)
                   throws java.io.IOException

Throws:

java.io.IOException

mkdirs

public static void mkdirs(java.lang.String pathName)

move

public static boolean move(java.io.File source,
                           java.io.File destination)

move

public static boolean move(java.lang.String sourceFileName,
                           java.lang.String destinationFileName)

read

public static java.lang.String read(java.io.File file)
                             throws java.io.IOException

Throws:

java.io.IOException

read

public static java.lang.String read(java.io.File file,
                                    boolean raw)
                             throws java.io.IOException

Throws:

java.io.IOException

read

public static java.lang.String read(java.lang.String fileName)
                             throws java.io.IOException

Throws:

java.io.IOException

replaceSeparator

public static java.lang.String replaceSeparator(java.lang.String fileName)

sortFiles

public static java.io.File[] sortFiles(java.io.File[] files)

stripExtension

public static java.lang.String stripExtension(java.lang.String fileName)

stripParentheticalSuffix

public static java.lang.String stripParentheticalSuffix(java.lang.String fileName)

toList

public static java.util.List<java.lang.String> toList(java.io.Reader reader)

toList

public static java.util.List<java.lang.String> toList(java.lang.String fileName)

toProperties

public static java.util.Properties toProperties(java.io.FileInputStream fis)

toProperties

public static java.util.Properties toProperties(java.lang.String fileName)

touch

public static void touch(java.io.File file)
                  throws java.io.IOException

Throws:

java.io.IOException

touch

public static void touch(java.lang.String fileName)
                  throws java.io.IOException

Throws:

java.io.IOException

unzip

public static void unzip(java.io.File source,
                         java.io.File destination)

write

public static void write(java.io.File file,
                         byte[] bytes)
                  throws java.io.IOException

Throws:

java.io.IOException

write

public static void write(java.io.File file,
                         byte[] bytes,
                         boolean append)
                  throws java.io.IOException

Throws:

java.io.IOException

write

public static void write(java.io.File file,
                         byte[] bytes,
                         int offset,
                         int length)
                  throws java.io.IOException

Throws:

java.io.IOException

write

public static void write(java.io.File file,
                         byte[] bytes,
                         int offset,
                         int length,
                         boolean append)
                  throws java.io.IOException

Throws:

java.io.IOException

write

public static void write(java.io.File file,
                         java.io.InputStream is)
                  throws java.io.IOException

Throws:

java.io.IOException

write

public static void write(java.io.File file,
                         java.lang.String s)
                  throws java.io.IOException

Throws:

java.io.IOException

write

public static void write(java.io.File file,
                         java.lang.String s,
                         boolean lazy)
                  throws java.io.IOException

Throws:

java.io.IOException

write

public static void write(java.io.File file,
                         java.lang.String s,
                         boolean lazy,
                         boolean append)
                  throws java.io.IOException

Throws:

java.io.IOException

write

public static void write(java.lang.String fileName,
                         byte[] bytes)
                  throws java.io.IOException

Throws:

java.io.IOException

write

public static void write(java.lang.String fileName,
                         java.io.InputStream is)
                  throws java.io.IOException

Throws:

java.io.IOException

write

public static void write(java.lang.String fileName,
                         java.lang.String s)
                  throws java.io.IOException

Throws:

java.io.IOException

write

public static void write(java.lang.String fileName,
                         java.lang.String s,
                         boolean lazy)
                  throws java.io.IOException

Throws:

java.io.IOException

write

public static void write(java.lang.String fileName,
                         java.lang.String s,
                         boolean lazy,
                         boolean append)
                  throws java.io.IOException

Throws:

java.io.IOException

write

public static void write(java.lang.String pathName,
                         java.lang.String fileName,
                         java.lang.String s)
                  throws java.io.IOException

Throws:

java.io.IOException

write

public static void write(java.lang.String pathName,
                         java.lang.String fileName,
                         java.lang.String s,
                         boolean lazy)
                  throws java.io.IOException

Throws:

java.io.IOException

write

public static void write(java.lang.String pathName,
                         java.lang.String fileName,
                         java.lang.String s,
                         boolean lazy,
                         boolean append)
                  throws java.io.IOException

Throws:

java.io.IOException

setFile

public void setFile(File file)