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

Method Detail

appendParentheticalSuffix

String appendParentheticalSuffix(String fileName,
                                 String suffix)

appendSuffix

String appendSuffix(String fileName,
                    String suffix)

copyDirectory

void copyDirectory(File source,
                   File destination)
            throws IOException

Throws:

IOException

copyDirectory

void copyDirectory(String sourceDirName,
                   String destinationDirName)
            throws IOException

Throws:

IOException

copyFile

void copyFile(File source,
              File destination)
       throws IOException

Throws:

IOException

copyFile

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

Throws:

IOException

copyFile

void copyFile(String source,
              String destination)
       throws IOException

Throws:

IOException

copyFile

void copyFile(String source,
              String destination,
              boolean lazy)
       throws IOException

Throws:

IOException

createTempFile

File createTempFile()

createTempFile

File createTempFile(byte[] bytes)
             throws IOException

Throws:

IOException

createTempFile

File createTempFile(InputStream is)
             throws IOException

Throws:

IOException

createTempFile

File createTempFile(String extension)

createTempFile

File createTempFile(String prefix,
                    String extension)

createTempFileName

String createTempFileName()

createTempFileName

String createTempFileName(String extension)

createTempFileName

String createTempFileName(String prefix,
                          String extension)

createTempFolder

File createTempFolder()
               throws IOException

Throws:

IOException

decodeSafeFileName

String decodeSafeFileName(String fileName)

delete

boolean delete(File file)

delete

boolean delete(String file)

deltree

void deltree(File directory)

deltree

void deltree(String directory)

encodeSafeFileName

String encodeSafeFileName(String fileName)

exists

boolean exists(File file)

exists

boolean exists(String fileName)

extractText

String extractText(InputStream is,
                   String fileName)

extractText

String extractText(InputStream is,
                   String fileName,
                   int maxStringLength)

find

String[] find(String directory,
              String includes,
              String excludes)

getAbsolutePath

String getAbsolutePath(File file)

getBytes

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

Throws:

IOException

getBytes

byte[] getBytes(InputStream is)
         throws IOException

Throws:

IOException

getBytes

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

Throws:

IOException

getBytes

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

Throws:

IOException

getBytes

byte[] getBytes(File file)
         throws IOException

Throws:

IOException

getExtension

String getExtension(String fileName)

getMD5Checksum

String getMD5Checksum(File file)
               throws IOException

Throws:

IOException

getPath

String getPath(String fullFileName)

getShortFileName

String getShortFileName(String fullFileName)

isAscii

boolean isAscii(File file)
         throws IOException

Throws:

IOException

isSameContent

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

isSameContent

boolean isSameContent(File file,
                      String s)

listDirs

String[] listDirs(File file)

listDirs

String[] listDirs(String fileName)

listFiles

String[] listFiles(File file)

listFiles

String[] listFiles(String fileName)

mkdirs

void mkdirs(File file)
     throws IOException

Throws:

IOException

mkdirs

void mkdirs(String pathName)

move

boolean move(File source,
             File destination)

move

boolean move(String sourceFileName,
             String destinationFileName)

read

String read(File file)
     throws IOException

Throws:

IOException

read

String read(File file,
            boolean raw)
     throws IOException

Throws:

IOException

read

String read(String fileName)
     throws IOException

Throws:

IOException

replaceSeparator

String replaceSeparator(String fileName)

sortFiles

File[] sortFiles(File[] files)

stripExtension

String stripExtension(String fileName)

stripParentheticalSuffix

String stripParentheticalSuffix(String fileName)

toList

List<String> toList(Reader reader)

toList

List<String> toList(String fileName)

toProperties

Properties toProperties(FileInputStream fis)

toProperties

Properties toProperties(String fileName)

touch

void touch(File file)
    throws IOException

Throws:

IOException

touch

void touch(String fileName)
    throws IOException

Throws:

IOException

unzip

void unzip(File source,
           File destination)

write

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

Throws:

IOException

write

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

Throws:

IOException

write

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

Throws:

IOException

write

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

Throws:

IOException

write

void write(File file,
           InputStream is)
    throws IOException

Throws:

IOException

write

void write(File file,
           String s)
    throws IOException

Throws:

IOException

write

void write(File file,
           String s,
           boolean lazy)
    throws IOException

Throws:

IOException

write

void write(File file,
           String s,
           boolean lazy,
           boolean append)
    throws IOException

Throws:

IOException

write

void write(String fileName,
           byte[] bytes)
    throws IOException

Throws:

IOException

write

void write(String fileName,
           InputStream is)
    throws IOException

Throws:

IOException

write

void write(String fileName,
           String s)
    throws IOException

Throws:

IOException

write

void write(String fileName,
           String s,
           boolean lazy)
    throws IOException

Throws:

IOException

write

void write(String fileName,
           String s,
           boolean lazy,
           boolean append)
    throws IOException

Throws:

IOException

write

void write(String pathName,
           String fileName,
           String s)
    throws IOException

Throws:

IOException

write

void write(String pathName,
           String fileName,
           String s,
           boolean lazy)
    throws IOException

Throws:

IOException

write

void write(String pathName,
           String fileName,
           String s,
           boolean lazy,
           boolean append)
    throws IOException

Throws:

IOException