cn.trinea.android.common.util

Class FileUtils

java.lang.Object

cn.trinea.android.common.util.FileUtils

public class FileUtils
extends java.lang.Object

File Utils

Read or write file
• #readFile(String) read file
• #readFileToList(String) read file to string list
• writeFile(String, String, boolean) write file
• writeFile(String, InputStream) write file
• writeFile(String, InputStream, boolean) write file
• writeFile(File, InputStream) write file
• writeFile(File, InputStream, boolean) write file

Operate file
• copyFile(String, String)
• getFileExtension(String)
• getFileName(String)
• getFileNameWithoutExtension(String)
• getFileSize(String)
• deleteFile(String)
• isFileExist(String)
• isFolderExist(String)
• makeFolders(String)
• makeDirs(String)

Author:

Trinea 2012-5-12

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	FILE_EXTENSION_SEPARATOR

Constructor Summary

Constructors

Constructor and Description
FileUtils()

Method Summary

Methods

Modifier and Type	Method and Description
static boolean	copyFile(java.lang.String sourceFilePath, java.lang.String destFilePath) copy file
static boolean	deleteFile(java.lang.String path) delete file or directory if path is null or empty, return true if path not exist, return true if path exist, delete recursion. return true
static java.lang.String	getFileExtension(java.lang.String filePath) get suffix of file from path getFileExtension(null) = "" getFileExtension("") = "" getFileExtension(" ") = " " getFileExtension("a.mp3") = "mp3" getFileExtension("a.b.rmvb") = "rmvb" getFileExtension("abc") = "" getFileExtension("c:\\") = "" getFileExtension("c:\\a") = "" getFileExtension("c:\\a.b") = "b" getFileExtension("c:a.txt\\a") = "" getFileExtension("/home/admin") = "" getFileExtension("/home/admin/a.txt/b") = "" getFileExtension("/home/admin/a.txt/b.mp3") = "mp3"
static java.lang.String	getFileName(java.lang.String filePath) get file name from path, include suffix getFileName(null) = null getFileName("") = "" getFileName(" ") = " " getFileName("a.mp3") = "a.mp3" getFileName("a.b.rmvb") = "a.b.rmvb" getFileName("abc") = "abc" getFileName("c:\\") = "" getFileName("c:\\a") = "a" getFileName("c:\\a.b") = "a.b" getFileName("c:a.txt\\a") = "a" getFileName("/home/admin") = "admin" getFileName("/home/admin/a.txt/b.mp3") = "b.mp3"
static java.lang.String	getFileNameWithoutExtension(java.lang.String filePath) get file name from path, not include suffix getFileNameWithoutExtension(null) = null getFileNameWithoutExtension("") = "" getFileNameWithoutExtension(" ") = " " getFileNameWithoutExtension("abc") = "abc" getFileNameWithoutExtension("a.mp3") = "a" getFileNameWithoutExtension("a.b.rmvb") = "a.b" getFileNameWithoutExtension("c:\\") = "" getFileNameWithoutExtension("c:\\a") = "a" getFileNameWithoutExtension("c:\\a.b") = "a" getFileNameWithoutExtension("c:a.txt\\a") = "a" getFileNameWithoutExtension("/home/admin") = "admin" getFileNameWithoutExtension("/home/admin/a.txt/b.mp3") = "b"
static long	getFileSize(java.lang.String path) get file size if path is null or empty, return -1 if path exist and it is a file, return file size, else return -1
static java.lang.String	getFolderName(java.lang.String filePath) get folder name from path getFolderName(null) = null getFolderName("") = "" getFolderName(" ") = "" getFolderName("a.mp3") = "" getFolderName("a.b.rmvb") = "" getFolderName("abc") = "" getFolderName("c:\\") = "c:" getFolderName("c:\\a") = "c:" getFolderName("c:\\a.b") = "c:" getFolderName("c:a.txt\\a") = "c:a.txt" getFolderName("c:a\\b\\c\\d.txt") = "c:a\\b\\c" getFolderName("/home/admin") = "/home" getFolderName("/home/admin/a.txt/b.mp3") = "/home/admin/a.txt"
static boolean	isFileExist(java.lang.String filePath) Indicates if this file represents a file on the underlying file system.
static boolean	isFolderExist(java.lang.String directoryPath) Indicates if this file represents a directory on the underlying file system.
static boolean	makeDirs(java.lang.String filePath) Creates the directory named by the trailing filename of this file, including the complete directory path required to create this directory.
static boolean	makeFolders(java.lang.String filePath)
static java.lang.StringBuilder	readFile(java.lang.String filePath, java.lang.String charsetName) read file
static java.util.List<java.lang.String>	readFileToList(java.lang.String filePath, java.lang.String charsetName) read file to string list, a element of list is a line
static boolean	writeFile(java.io.File file, java.io.InputStream stream) write file
static boolean	writeFile(java.io.File file, java.io.InputStream stream, boolean append) write file
static boolean	writeFile(java.lang.String filePath, java.io.InputStream stream) write file
static boolean	writeFile(java.lang.String filePath, java.io.InputStream stream, boolean append) write file
static boolean	writeFile(java.lang.String filePath, java.lang.String content, boolean append) write file

Methods inherited from class java.lang.Object

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

Field Detail

FILE_EXTENSION_SEPARATOR

public static final java.lang.String FILE_EXTENSION_SEPARATOR

See Also:

Constant Field Values

Constructor Detail

FileUtils

public FileUtils()

Method Detail

readFile

public static java.lang.StringBuilder readFile(java.lang.String filePath,
                               java.lang.String charsetName)

read file

Parameters:

filePath -

charsetName - The name of a supported charset

Returns:

if file not exist, return null, else return content of file

Throws:

java.lang.RuntimeException - if an error occurs while operator BufferedReader

writeFile

public static boolean writeFile(java.lang.String filePath,
                java.lang.String content,
                boolean append)

write file

Parameters:

filePath -

content -

append - is append, if true, write to the end of file, else clear content of file and write into it

Returns:

return true

Throws:

java.lang.RuntimeException - if an error occurs while operator FileWriter

writeFile

public static boolean writeFile(java.lang.String filePath,
                java.io.InputStream stream)

write file

Parameters:

filePath -

stream -

Returns:

See Also:

#writeFile(String, InputStream, boolean)}

writeFile

public static boolean writeFile(java.lang.String filePath,
                java.io.InputStream stream,
                boolean append)

write file

Parameters:

file - the file to be opened for writing.

stream - the input stream

append - if true, then bytes will be written to the end of the file rather than the beginning

Returns:

return true

Throws:

java.lang.RuntimeException - if an error occurs while operator FileOutputStream

writeFile

public static boolean writeFile(java.io.File file,
                java.io.InputStream stream)

write file

Parameters:

file -

stream -

Returns:

See Also:

#writeFile(File, InputStream, boolean)}

writeFile

public static boolean writeFile(java.io.File file,
                java.io.InputStream stream,
                boolean append)

write file

Parameters:

file - the file to be opened for writing.

stream - the input stream

append - if true, then bytes will be written to the end of the file rather than the beginning

Returns:

return true

Throws:

java.lang.RuntimeException - if an error occurs while operator FileOutputStream

copyFile

public static boolean copyFile(java.lang.String sourceFilePath,
               java.lang.String destFilePath)

copy file

Parameters:

sourceFilePath -

destFilePath -

Returns:

Throws:

java.lang.RuntimeException - if an error occurs while operator FileOutputStream

readFileToList

public static java.util.List<java.lang.String> readFileToList(java.lang.String filePath,
                                              java.lang.String charsetName)

read file to string list, a element of list is a line

Parameters:

filePath -

charsetName - The name of a supported charset

Returns:

if file not exist, return null, else return content of file

Throws:

java.lang.RuntimeException - if an error occurs while operator BufferedReader

getFileNameWithoutExtension

public static java.lang.String getFileNameWithoutExtension(java.lang.String filePath)

get file name from path, not include suffix

      getFileNameWithoutExtension(null)               =   null
      getFileNameWithoutExtension("")                 =   ""
      getFileNameWithoutExtension("   ")              =   "   "
      getFileNameWithoutExtension("abc")              =   "abc"
      getFileNameWithoutExtension("a.mp3")            =   "a"
      getFileNameWithoutExtension("a.b.rmvb")         =   "a.b"
      getFileNameWithoutExtension("c:\\")              =   ""
      getFileNameWithoutExtension("c:\\a")             =   "a"
      getFileNameWithoutExtension("c:\\a.b")           =   "a"
      getFileNameWithoutExtension("c:a.txt\\a")        =   "a"
      getFileNameWithoutExtension("/home/admin")      =   "admin"
      getFileNameWithoutExtension("/home/admin/a.txt/b.mp3")  =   "b"
 

Parameters:

filePath -

Returns:

file name from path, not include suffix

See Also:

getFileName

public static java.lang.String getFileName(java.lang.String filePath)

get file name from path, include suffix

      getFileName(null)               =   null
      getFileName("")                 =   ""
      getFileName("   ")              =   "   "
      getFileName("a.mp3")            =   "a.mp3"
      getFileName("a.b.rmvb")         =   "a.b.rmvb"
      getFileName("abc")              =   "abc"
      getFileName("c:\\")              =   ""
      getFileName("c:\\a")             =   "a"
      getFileName("c:\\a.b")           =   "a.b"
      getFileName("c:a.txt\\a")        =   "a"
      getFileName("/home/admin")      =   "admin"
      getFileName("/home/admin/a.txt/b.mp3")  =   "b.mp3"
 

Parameters:

filePath -

Returns:

file name from path, include suffix

getFolderName

public static java.lang.String getFolderName(java.lang.String filePath)

get folder name from path

      getFolderName(null)               =   null
      getFolderName("")                 =   ""
      getFolderName("   ")              =   ""
      getFolderName("a.mp3")            =   ""
      getFolderName("a.b.rmvb")         =   ""
      getFolderName("abc")              =   ""
      getFolderName("c:\\")              =   "c:"
      getFolderName("c:\\a")             =   "c:"
      getFolderName("c:\\a.b")           =   "c:"
      getFolderName("c:a.txt\\a")        =   "c:a.txt"
      getFolderName("c:a\\b\\c\\d.txt")    =   "c:a\\b\\c"
      getFolderName("/home/admin")      =   "/home"
      getFolderName("/home/admin/a.txt/b.mp3")  =   "/home/admin/a.txt"
 

Parameters:

filePath -

Returns:

getFileExtension

public static java.lang.String getFileExtension(java.lang.String filePath)

get suffix of file from path

      getFileExtension(null)               =   ""
      getFileExtension("")                 =   ""
      getFileExtension("   ")              =   "   "
      getFileExtension("a.mp3")            =   "mp3"
      getFileExtension("a.b.rmvb")         =   "rmvb"
      getFileExtension("abc")              =   ""
      getFileExtension("c:\\")              =   ""
      getFileExtension("c:\\a")             =   ""
      getFileExtension("c:\\a.b")           =   "b"
      getFileExtension("c:a.txt\\a")        =   ""
      getFileExtension("/home/admin")      =   ""
      getFileExtension("/home/admin/a.txt/b")  =   ""
      getFileExtension("/home/admin/a.txt/b.mp3")  =   "mp3"
 

Parameters:

filePath -

Returns:

makeDirs

public static boolean makeDirs(java.lang.String filePath)

Creates the directory named by the trailing filename of this file, including the complete directory path required to create this directory.

Attentions:
• makeDirs("C:\\Users\\Trinea") can only create users folder
• makeFolder("C:\\Users\\Trinea\\") can create Trinea folder

Parameters:

filePath -

Returns:

true if the necessary directories have been created or the target directory already exists, false one of the directories can not be created.

• if getFolderName(String) return null, return false
• if target directory already exists, return true
• return java.io.File#makeFolder

makeFolders

public static boolean makeFolders(java.lang.String filePath)

Parameters:

filePath -

Returns:

See Also:

makeDirs(String)

isFileExist

public static boolean isFileExist(java.lang.String filePath)

Indicates if this file represents a file on the underlying file system.

Parameters:

filePath -

Returns:

isFolderExist

public static boolean isFolderExist(java.lang.String directoryPath)

Indicates if this file represents a directory on the underlying file system.

Parameters:

directoryPath -

Returns:

deleteFile

public static boolean deleteFile(java.lang.String path)

delete file or directory

• if path is null or empty, return true
• if path not exist, return true
• if path exist, delete recursion. return true

Parameters:

path -

Returns:

getFileSize

public static long getFileSize(java.lang.String path)

get file size

• if path is null or empty, return -1
• if path exist and it is a file, return file size, else return -1

Parameters:

path -

Returns:

returns the length of this file in bytes. returns -1 if the file does not exist.