com.liferay.portal.kernel.util

Interface File

public interface File

Author:

Brian Wing Shun Chan, Alexander Chow

Method Summary

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

Method Detail

appendParentheticalSuffix

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

appendSuffix

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

copyDirectory

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

Throws:

java.io.IOException

copyDirectory

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

Throws:

java.io.IOException

copyFile

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

Throws:

java.io.IOException

copyFile

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

Throws:

java.io.IOException

copyFile

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

Throws:

java.io.IOException

copyFile

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

Throws:

java.io.IOException

createTempFile

java.io.File createTempFile()

createTempFile

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

Throws:

java.io.IOException

createTempFile

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

Throws:

java.io.IOException

createTempFile

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

createTempFile

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

createTempFileName

java.lang.String createTempFileName()

createTempFileName

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

createTempFileName

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

createTempFolder

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

Throws:

java.io.IOException

decodeSafeFileName

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

delete

boolean delete(java.io.File file)

delete

boolean delete(java.lang.String file)

deltree

void deltree(java.io.File directory)

deltree

void deltree(java.lang.String directory)

encodeSafeFileName

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

exists

boolean exists(java.io.File file)

exists

boolean exists(java.lang.String fileName)

extractText

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

extractText

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

find

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

getAbsolutePath

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

getBytes

byte[] getBytes(java.lang.Class<?> clazz,
                java.lang.String fileName)
         throws java.io.IOException

Throws:

java.io.IOException

getBytes

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

Throws:

java.io.IOException

getBytes

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

Throws:

java.io.IOException

getBytes

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

Throws:

java.io.IOException

getBytes

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

Throws:

java.io.IOException

getExtension

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

getMD5Checksum

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

Throws:

java.io.IOException

getPath

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

getShortFileName

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

isAscii

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

Throws:

java.io.IOException

isSameContent

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

isSameContent

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

listDirs

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

listDirs

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

listFiles

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

listFiles

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

mkdirs

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

Throws:

java.io.IOException

mkdirs

void mkdirs(java.lang.String pathName)

move

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

move

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

read

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

Throws:

java.io.IOException

read

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

Throws:

java.io.IOException

read

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

Throws:

java.io.IOException

replaceSeparator

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

sortFiles

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

stripExtension

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

stripParentheticalSuffix

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

toList

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

toList

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

toProperties

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

toProperties

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

touch

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

Throws:

java.io.IOException

touch

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

Throws:

java.io.IOException

unzip

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

write

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

Throws:

java.io.IOException

write

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

Throws:

java.io.IOException

write

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

Throws:

java.io.IOException

write

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

Throws:

java.io.IOException

write

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

Throws:

java.io.IOException

write

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

Throws:

java.io.IOException

write

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

Throws:

java.io.IOException

write

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

Throws:

java.io.IOException

write

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

Throws:

java.io.IOException

write

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

Throws:

java.io.IOException

write

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

Throws:

java.io.IOException

write

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

Throws:

java.io.IOException

write

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

Throws:

java.io.IOException

write

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

Throws:

java.io.IOException

write

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

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